Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,7 @@ _dependentPackages/
.vscode/
*.DS_Store
build-errors.txt
build-log.txt
build-log.txt
tools/dts-utilities*
tools/version-remover*
tools/whats-new*
3 changes: 3 additions & 0 deletions docs/docs-ref-autogen/common/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,9 @@ items:
- name: ExcelApi online-only requirement set
href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
displayName: Excel
- name: ExcelApi 1.20 requirement set
href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md
displayName: Excel
- name: ExcelApi 1.19 requirement set
href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md
displayName: Excel
Expand Down
3 changes: 3 additions & 0 deletions docs/docs-ref-autogen/common_preview/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,9 @@ items:
- name: ExcelApi online-only requirement set
href: ../../requirement-sets/excel/excel-api-online-requirement-set.md
displayName: Excel
- name: ExcelApi 1.20 requirement set
href: ../../requirement-sets/excel/excel-api-1-20-requirement-set.md
displayName: Excel
- name: ExcelApi 1.19 requirement set
href: ../../requirement-sets/excel/excel-api-1-19-requirement-set.md
displayName: Excel
Expand Down
11 changes: 10 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type
package: excel!
fullName: Excel.CardLayout
summary: Represents the layout of a card in card view.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout),
[Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)

isPreview: false
isDeprecated: false
Expand Down
12 changes: 11 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type
package: excel!
fullName: Excel.CardLayoutSection
summary: Represents the layout of a section of a card in card view.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection),
[Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection),
[Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)

isPreview: false
isDeprecated: false
Expand Down
42 changes: 41 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type
package: excel!
fullName: Excel.CellControl
summary: Represents an interactable control inside of a cell.
remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```"
remarks: >-
\[ [API set: ExcelApi
1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]




Learn more about the types in this type alias through the following links.


[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol),
[Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol),
[Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol),
[Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)


#### Examples


```TypeScript

// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml


// Add checkboxes to the table.

await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();

// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});

```

isPreview: false
isDeprecated: false
Expand Down
25 changes: 24 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type
package: excel!
fullName: Excel.CellValue
summary: Represents the value in a cell.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue),
[Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue),
[Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue),
[Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue),
[Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue),
[Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue),
[Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue),
[Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue),
[Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue),
[Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue),
[Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue),
[Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue),
[Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue),
[Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue),
[Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue),
[Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)

isPreview: false
isDeprecated: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata
summary: >-
Represents the value and metadata of a property. The metadata applies to the
property (and not the value), but it is combined with the value in this type.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.CellValue](/javascript/api/excel/excel.cellvalue),
[Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)

isPreview: false
isDeprecated: false
Expand Down
10 changes: 9 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout
summary: >-
Represents the layout used when there is limited space to represent the
entity.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)

isPreview: false
isDeprecated: false
Expand Down
30 changes: 15 additions & 15 deletions docs/docs-ref-autogen/excel/excel/excel.customfunctionmanager.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ package: excel!
fullName: Excel.CustomFunctionManager
summary: Manages settings on custom functions.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]

isPreview: true
isPreview: false
isDeprecated: false
type: class
properties:
Expand All @@ -21,7 +21,7 @@ properties:
process to the Office host application's process.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
Expand All @@ -37,7 +37,7 @@ methods:
must call `context.sync()` before reading the properties.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.CustomFunctionManager;'
Expand All @@ -58,11 +58,11 @@ methods:
Queues up a command to load the specified properties of the object. You
must call `context.sync()` before reading the properties.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\]

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: |-
Expand Down Expand Up @@ -91,11 +91,11 @@ methods:
fullName: newObject(context)
summary: Create a new instance of the `Excel.CustomFunctionManager` object.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\]

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: >-
Expand All @@ -114,11 +114,11 @@ methods:
fullName: setVisibility(customFunctionVisibilityOptions)
summary: Show or hide custom functions in Excel AutoComplete.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\]

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: >-
Expand Down Expand Up @@ -146,7 +146,7 @@ methods:
shallow copies of any loaded child properties from the original object.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.CustomFunctionManagerData;'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ package: excel!
fullName: Excel.CustomFunctionVisibilityOptions
summary: Represents which custom functions to show or hide in Excel AutoComplete.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]

isPreview: true
isPreview: false
isDeprecated: false
type: interface
properties:
Expand All @@ -18,11 +18,11 @@ properties:
fullName: hide
summary: A list of custom functions to hide from Excel AutoComplete.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\]

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'hide?: string[];'
Expand All @@ -34,11 +34,11 @@ properties:
fullName: show
summary: A list of custom functions to show in Excel AutoComplete.
remarks: >-
\[ [API set: ExcelApi BETA (PREVIEW
ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\[ [API set: ExcelApi
1.20](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
\]

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'show?: string[];'
Expand Down
11 changes: 10 additions & 1 deletion docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type
package: excel!
fullName: Excel.EntityPropertyType
summary: Represents the value of a property.
remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)"
remarks: >-
\[ [API set: ExcelApi
1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


Learn more about the types in this type alias through the following links.


[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata),
[Excel.CellValue](/javascript/api/excel/excel.cellvalue)

isPreview: false
isDeprecated: false
Expand Down
Loading