From aa31e5cdd9dc67b000f1730537d1361cbd92579a Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 11 Sep 2025 10:58:40 +0000 Subject: [PATCH] Automatically generated docs --- .../excel/excel/excel.cardlayout.yml | 11 +--- .../excel/excel/excel.cardlayoutsection.yml | 12 +--- .../excel/excel/excel.cellcontrol.yml | 42 +------------ .../excel/excel/excel.cellvalue.yml | 25 +------- .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel/excel/excel.compactlayout.yml | 10 +--- .../excel/excel/excel.entitypropertytype.yml | 11 +--- .../excel/excel/excel.errorcellvalue.yml | 59 +------------------ .../excel/excel/excel.functioncellvalue.yml | 10 +--- .../excel/excel/excel.referencedvalue.yml | 15 +---- .../excel_1_16/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 11 +--- .../excel_1_16/excel/excel.cellvalue.yml | 21 +------ .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel_1_16/excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel_1_16/excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.referencedvalue.yml | 15 +---- .../excel_1_17/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 11 +--- .../excel_1_17/excel/excel.cellvalue.yml | 21 +------ .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel_1_17/excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel_1_17/excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.referencedvalue.yml | 15 +---- .../excel_1_18/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 11 +--- .../excel_1_18/excel/excel.cellcontrol.yml | 42 +------------ .../excel_1_18/excel/excel.cellvalue.yml | 21 +------ .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel_1_18/excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel_1_18/excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.referencedvalue.yml | 15 +---- .../excel_1_19/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 12 +--- .../excel_1_19/excel/excel.cellcontrol.yml | 42 +------------ .../excel_1_19/excel/excel.cellvalue.yml | 23 +------- .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel_1_19/excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel_1_19/excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.functioncellvalue.yml | 10 +--- .../excel/excel.referencedvalue.yml | 15 +---- .../excel_1_20/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 12 +--- .../excel_1_20/excel/excel.cellcontrol.yml | 42 +------------ .../excel_1_20/excel/excel.cellvalue.yml | 23 +------- .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel_1_20/excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel_1_20/excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.functioncellvalue.yml | 10 +--- .../excel/excel.referencedvalue.yml | 15 +---- .../excel_online/excel/excel.cardlayout.yml | 10 +--- .../excel/excel.cardlayoutsection.yml | 12 +--- .../excel_online/excel/excel.cellcontrol.yml | 42 +------------ .../excel_online/excel/excel.cellvalue.yml | 23 +------- .../excel.cellvalueandpropertymetadata.yml | 11 +--- .../excel/excel.compactlayout.yml | 10 +--- .../excel/excel.entitypropertytype.yml | 11 +--- .../excel/excel.errorcellvalue.yml | 57 +----------------- .../excel/excel.functioncellvalue.yml | 10 +--- .../excel/excel.referencedvalue.yml | 15 +---- .../powerpoint.slidegetimageoptions.yml | 28 +++++++++ .../powerpoint.slidegetimageoptions.yml | 28 +++++++++ .../powerpoint.slidegetimageoptions.yml | 28 +++++++++ generate-docs/API Coverage Report.csv | 2 +- .../script-inputs/script-lab-snippets.yaml | 21 +++++++ 70 files changed, 171 insertions(+), 1225 deletions(-) diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml index ad538d6d8e..13bd37ee71 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml @@ -4,16 +4,7 @@ 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), - [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout) +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)" 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 cca1b0c56e..5491f6727f 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml @@ -4,17 +4,7 @@ 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) +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)" 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 5e5954d3df..ecd03dccf2 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml @@ -4,47 +4,7 @@ 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(); - }); - - ``` +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```" 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 57f85ca484..62429faa0a 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml @@ -4,30 +4,7 @@ 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.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) \\]\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)" 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 5f661bb32f..566432a914 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml @@ -6,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml @@ -6,15 +6,7 @@ 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) +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)" isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml index bc54a6eff6..41a8cc7fcf 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml @@ -4,16 +4,7 @@ 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) +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)" 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 f5e56306dd..cd381f72c8 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml @@ -4,64 +4,7 @@ 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.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(); - }); - - ``` +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```" 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 b1f83d2ff4..50b7239609 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml @@ -4,15 +4,7 @@ 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) +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)" 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 168b4928ba..57044e8ebe 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml @@ -4,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 07ebbc46e3..4de2b1d604 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,15 +4,7 @@ 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) +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)" 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 97e90f572d..b54480411d 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,16 +4,7 @@ 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) +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)" 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 b679b81429..63e5befd22 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,26 +4,7 @@ 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.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) \\]\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)" 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 5f661bb32f..566432a914 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,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 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,15 +6,7 @@ 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) +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)" 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 bc54a6eff6..41a8cc7fcf 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,16 +4,7 @@ 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) +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)" 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 b88b1959c2..e5addcc22f 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,62 +4,7 @@ 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(); - }); - - ``` +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```" 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 168b4928ba..57044e8ebe 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,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 07ebbc46e3..4de2b1d604 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,15 +4,7 @@ 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) +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)" 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 97e90f572d..b54480411d 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,16 +4,7 @@ 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) +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)" 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 b679b81429..63e5befd22 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,26 +4,7 @@ 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.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) \\]\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)" 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 5f661bb32f..566432a914 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,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 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,15 +6,7 @@ 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) +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)" 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 bc54a6eff6..41a8cc7fcf 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,16 +4,7 @@ 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) +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)" 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 b88b1959c2..e5addcc22f 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,62 +4,7 @@ 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(); - }); - - ``` +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```" 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 168b4928ba..57044e8ebe 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,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 07ebbc46e3..4de2b1d604 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,15 +4,7 @@ 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) +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)" 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 97e90f572d..b54480411d 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,16 +4,7 @@ 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) +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)" 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 5e5954d3df..ecd03dccf2 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,47 +4,7 @@ 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(); - }); - - ``` +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```" 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 b679b81429..63e5befd22 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,26 +4,7 @@ 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.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) \\]\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)" 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 5f661bb32f..566432a914 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,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 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,15 +6,7 @@ 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) +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)" 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 bc54a6eff6..41a8cc7fcf 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,16 +4,7 @@ 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) +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)" 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 b88b1959c2..e5addcc22f 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,62 +4,7 @@ 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(); - }); - - ``` +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```" 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 168b4928ba..57044e8ebe 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,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 07ebbc46e3..4de2b1d604 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,15 +4,7 @@ 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) +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)" 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 cca1b0c56e..5491f6727f 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,17 +4,7 @@ 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) +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)" 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 5e5954d3df..ecd03dccf2 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,47 +4,7 @@ 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(); - }); - - ``` +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```" 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 4722937ebb..ef4aaccfd2 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,28 +4,7 @@ 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) +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)" 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 5f661bb32f..566432a914 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,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 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,15 +6,7 @@ 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) +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)" 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 bc54a6eff6..41a8cc7fcf 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,16 +4,7 @@ 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) +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)" 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 b88b1959c2..e5addcc22f 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,62 +4,7 @@ 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(); - }); - - ``` +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```" 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 b1f83d2ff4..50b7239609 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,15 +4,7 @@ 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) +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)" 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 168b4928ba..57044e8ebe 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,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index 07ebbc46e3..4de2b1d604 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml @@ -4,15 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index cca1b0c56e..5491f6727f 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml @@ -4,17 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index 5e5954d3df..ecd03dccf2 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml @@ -4,47 +4,7 @@ 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(); - }); - - ``` +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```" isPreview: false isDeprecated: false 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 index 4722937ebb..ef4aaccfd2 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml @@ -4,28 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index 5f661bb32f..566432a914 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml @@ -6,16 +6,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index 5bb689c662..3f25496779 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml @@ -6,15 +6,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index bc54a6eff6..41a8cc7fcf 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml @@ -4,16 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index b88b1959c2..e5addcc22f 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml @@ -4,62 +4,7 @@ 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(); - }); - - ``` +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```" isPreview: false isDeprecated: false 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 index b1f83d2ff4..50b7239609 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml @@ -4,15 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 index 168b4928ba..57044e8ebe 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml @@ -4,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 07ebbc46e3..4de2b1d604 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml @@ -4,15 +4,7 @@ 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) +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)" 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 cca1b0c56e..5491f6727f 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml @@ -4,17 +4,7 @@ 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) +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)" 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 5e5954d3df..ecd03dccf2 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml @@ -4,47 +4,7 @@ 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(); - }); - - ``` +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```" 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 4722937ebb..ef4aaccfd2 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml @@ -4,28 +4,7 @@ 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) +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)" 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 5f661bb32f..566432a914 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml @@ -6,16 +6,7 @@ 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) +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)" 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 5bb689c662..3f25496779 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml @@ -6,15 +6,7 @@ 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) +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)" isPreview: false isDeprecated: false 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 bc54a6eff6..41a8cc7fcf 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml @@ -4,16 +4,7 @@ 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) +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)" 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 b88b1959c2..e5addcc22f 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml @@ -4,62 +4,7 @@ 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(); - }); - - ``` +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```" 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 b1f83d2ff4..50b7239609 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml @@ -4,15 +4,7 @@ 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) +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)" 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 168b4928ba..57044e8ebe 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml @@ -4,20 +4,7 @@ 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) +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)" isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml index a473d8a899..84cea489aa 100644 --- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml +++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slidegetimageoptions.yml @@ -9,6 +9,34 @@ remarks: >- 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml + + + // Exports current slide. + + await PowerPoint.run(async (context) => { + const slide = context.presentation.getSelectedSlides().getItemAt(0); + const slideBase64DataResult = slide.exportAsBase64(); + const imageBase64DataResult = slide.getImageAsBase64({ height: 300 }); + await context.sync(); + + localStorage.setItem("exportedSlide", slideBase64DataResult.value); + localStorage.setItem("exportedSlideImage", imageBase64DataResult.value); + + updateSlideImage(imageBase64DataResult.value); + + console.log("Slide was exported."); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml index a473d8a899..84cea489aa 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slidegetimageoptions.yml @@ -9,6 +9,34 @@ remarks: >- 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml + + + // Exports current slide. + + await PowerPoint.run(async (context) => { + const slide = context.presentation.getSelectedSlides().getItemAt(0); + const slideBase64DataResult = slide.exportAsBase64(); + const imageBase64DataResult = slide.getImageAsBase64({ height: 300 }); + await context.sync(); + + localStorage.setItem("exportedSlide", slideBase64DataResult.value); + localStorage.setItem("exportedSlideImage", imageBase64DataResult.value); + + updateSlideImage(imageBase64DataResult.value); + + console.log("Slide was exported."); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slidegetimageoptions.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slidegetimageoptions.yml index a473d8a899..84cea489aa 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slidegetimageoptions.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slidegetimageoptions.yml @@ -9,6 +9,34 @@ remarks: >- 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml + + + // Exports current slide. + + await PowerPoint.run(async (context) => { + const slide = context.presentation.getSelectedSlides().getItemAt(0); + const slideBase64DataResult = slide.exportAsBase64(); + const imageBase64DataResult = slide.getImageAsBase64({ height: 300 }); + await context.sync(); + + localStorage.setItem("exportedSlide", slideBase64DataResult.value); + localStorage.setItem("exportedSlideImage", imageBase64DataResult.value); + + updateSlideImage(imageBase64DataResult.value); + + console.log("Slide was exported."); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 485f8e4bb4..1725e8fa6c 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -10761,7 +10761,7 @@ PowerPoint.SlideCollection,"load(options)",Method,Excellent,false PowerPoint.SlideCollection,"load(propertyNames)",Method,Excellent,false PowerPoint.SlideCollection,"load(propertyNamesAndPaths)",Method,Excellent,false PowerPoint.SlideCollection,"toJSON()",Method,Excellent,false -PowerPoint.SlideGetImageOptions,N/A,Interface,Unknown,false +PowerPoint.SlideGetImageOptions,N/A,Interface,Unknown,true PowerPoint.SlideGetImageOptions,"height",Property,Fine,false PowerPoint.SlideGetImageOptions,"width",Property,Fine,false PowerPoint.SlideLayout,N/A,Class,Unknown,true diff --git a/generate-docs/script-inputs/script-lab-snippets.yaml b/generate-docs/script-inputs/script-lab-snippets.yaml index d7d069fb70..a8df1a586c 100644 --- a/generate-docs/script-inputs/script-lab-snippets.yaml +++ b/generate-docs/script-inputs/script-lab-snippets.yaml @@ -17390,6 +17390,27 @@ context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]); await context.sync(); }); +'PowerPoint.SlideGetImageOptions:interface': + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml + + + // Exports current slide. + + await PowerPoint.run(async (context) => { + const slide = context.presentation.getSelectedSlides().getItemAt(0); + const slideBase64DataResult = slide.exportAsBase64(); + const imageBase64DataResult = slide.getImageAsBase64({ height: 300 }); + await context.sync(); + + localStorage.setItem("exportedSlide", slideBase64DataResult.value); + localStorage.setItem("exportedSlideImage", imageBase64DataResult.value); + + updateSlideImage(imageBase64DataResult.value); + + console.log("Slide was exported."); + }); 'PowerPoint.SlideLayout:class': - >- // Link to full sample: