Skip to content

[Admin] Publish #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
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
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .openpublishing.publish.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
},
"JoinTOCPlugin": [
{
"ReferenceTOC": "docs/docs-ref-autogen/excel/toc.yml",
"ReferenceTOC": "docs/docs-ref-autogen/toc.yml",
"ConceptualTOCUrl": "/office/dev/scripts/toc.json"
}
],
Expand Down
10 changes: 1 addition & 9 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,7 @@
"**/*.yml"
],
"group": "office-scripts",
"src": "docs-ref-autogen/excel",
"dest": "api/office-scripts"
},
{
"files": [
"excel.yml"
],
"group": "office-scripts",
"src": "docs-ref-autogen/excel",
"src": "docs-ref-autogen",
"dest": "api/office-scripts"
},
{
Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSPackage
### YamlMime:TSPackage
uid: ExcelScript!
name: ExcelScript
type: package
Expand Down Expand Up @@ -150,8 +150,6 @@ enums:
- ExcelScript!ExcelScript.VerticalAlignment:enum
- ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum
- ExcelScript!ExcelScript.WorksheetPositionType:enum
- ExcelScript!Global.OfficeScript.EmailContentType:enum
- ExcelScript!Global.OfficeScript.EmailImportance:enum
interfaces:
- ExcelScript!ExcelScript.AllowEditRange:interface
- ExcelScript!ExcelScript.AllowEditRangeOptions:interface
Expand Down Expand Up @@ -321,123 +319,5 @@ interfaces:
- ExcelScript!ExcelScript.WorksheetProtection:interface
- ExcelScript!ExcelScript.WorksheetProtectionOptions:interface
- ExcelScript!ExcelScript.WorksheetSearchCriteria:interface
- ExcelScript!Global.OfficeScript.EmailAttachment:interface
- ExcelScript!Global.OfficeScript.MailProperties:interface
typeAliases:
- ExcelScript!ExcelScript.CellControl:type
functions:
- name: Global.OfficeScript.convertToPdf()
uid: ExcelScript!Global.OfficeScript.convertToPdf:function(1)
package: ExcelScript!
summary: >-
Return the text encoding of the document as a PDF. If the document is
empty, then the following error is shown: "We didn't find anything to
print". Some actions made prior to using this API may not be captured in
the PDF in Excel on the web.
remarks: ''

isPreview: true
isDeprecated: false
syntax:
content: 'export function convertToPdf(): string;'
return:
type: string
description: The content of the workbook as a string, in PDF format.
- name: |-
Global.OfficeScript.downloadFile({
name,
content,
})
uid: ExcelScript!Global.OfficeScript.downloadFile:function(1)
package: ExcelScript!
summary: >-
Downloads a specified file to the default download location specified by
the local machine.
remarks: ''

isPreview: true
isDeprecated: false
syntax:
content: |-
export function downloadFile({
name,
content,
}: {
name: string;
content: string;
}): void;
parameters:
- id: |-
{
name,
content,
}
description: ''
type: |-
{
name: string;
content: string;
}
return:
type: void
description: ''
- name: Global.OfficeScript.Metadata.getScriptName()
uid: ExcelScript!Global.OfficeScript.Metadata.getScriptName:function(1)
package: ExcelScript!
summary: Get the current executing scripts name.
remarks: ''

isPreview: true
isDeprecated: false
syntax:
content: 'export function getScriptName(): string;'
return:
type: string
description: ''
- name: Global.OfficeScript.saveCopyAs(filename)
uid: ExcelScript!Global.OfficeScript.saveCopyAs:function(1)
package: ExcelScript!
summary: >-
Saves a copy of the current workbook in OneDrive, in the same directory as
the original file, with the specified file name. The API has a timeout
limit of 30 seconds. This limit is rarely exceeded. Note: Timeout doesn't
necessarily indicate that the API failed. The workbook copy may still be
created, but after the timeout limit this API does not return a success or
failure message.
remarks: ''

isPreview: true
isDeprecated: false
syntax:
content: 'export function saveCopyAs(filename: string): void;'
parameters:
- id: filename
description: >-
The file name of the copied and saved file. The file name must end
with ".xlsx".
type: string
return:
type: void
description: ''
- name: Global.OfficeScript.sendMail(mailProperties)
uid: ExcelScript!Global.OfficeScript.sendMail:function(1)
package: ExcelScript!
summary: >-
Send an email with an Office Script. Use `MailProperties` to specify the
content and recipients of the email. If the request body includes content,
this method returns 400 Bad request.
remarks: ''

isPreview: true
isDeprecated: false
syntax:
content: 'export function sendMail(mailProperties: MailProperties): void;'
parameters:
- id: mailProperties
description: ''
type: >-
<xref uid="ExcelScript!Global.OfficeScript.MailProperties:interface"
/>
return:
type: void
description: ''
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.AggregationFunction
uid: ExcelScript!ExcelScript.AggregationFunction:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.AllowEditRange
uid: ExcelScript!ExcelScript.AllowEditRange:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.AllowEditRangeOptions
uid: ExcelScript!ExcelScript.AllowEditRangeOptions:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.Application
uid: ExcelScript!ExcelScript.Application:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.ArrowheadLength
uid: ExcelScript!ExcelScript.ArrowheadLength:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.ArrowheadStyle
uid: ExcelScript!ExcelScript.ArrowheadStyle:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.ArrowheadWidth
uid: ExcelScript!ExcelScript.ArrowheadWidth:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.AutoFillType
uid: ExcelScript!ExcelScript.AutoFillType:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.AutoFilter
uid: ExcelScript!ExcelScript.AutoFilter:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.BasicDataValidation
uid: ExcelScript!ExcelScript.BasicDataValidation:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.Binding
uid: ExcelScript!ExcelScript.Binding:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.BindingType
uid: ExcelScript!ExcelScript.BindingType:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.BorderIndex
uid: ExcelScript!ExcelScript.BorderIndex:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.BorderLineStyle
uid: ExcelScript!ExcelScript.BorderLineStyle:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.BorderWeight
uid: ExcelScript!ExcelScript.BorderWeight:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.BuiltInStyle
uid: ExcelScript!ExcelScript.BuiltInStyle:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.CalculationMode
uid: ExcelScript!ExcelScript.CalculationMode:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.CalculationState
uid: ExcelScript!ExcelScript.CalculationState:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.CalculationType
uid: ExcelScript!ExcelScript.CalculationType:enum
package: ExcelScript!
Expand Down
16 changes: 16 additions & 0 deletions docs/docs-ref-autogen/excelscript/excelscript.cellcontrol.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### YamlMime:TSTypeAlias
name: ExcelScript.CellControl
uid: ExcelScript!ExcelScript.CellControl:type
package: ExcelScript!
fullName: ExcelScript.CellControl
summary: Represents an interactable control inside of a cell.
remarks: "\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[ExcelScript.UnknownCellControl](/javascript/api/office-scripts/excelscript/excelscript.unknowncellcontrol), [ExcelScript.EmptyCellControl](/javascript/api/office-scripts/excelscript/excelscript.emptycellcontrol), [ExcelScript.MixedCellControl](/javascript/api/office-scripts/excelscript/excelscript.mixedcellcontrol), [ExcelScript.CheckboxCellControl](/javascript/api/office-scripts/excelscript/excelscript.checkboxcellcontrol)"

isPreview: false
isDeprecated: false
syntax: |-
type CellControl =
| UnknownCellControl
| EmptyCellControl
| MixedCellControl
| CheckboxCellControl;
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.CellControlType
uid: ExcelScript!ExcelScript.CellControlType:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.CellValueConditionalFormat
uid: ExcelScript!ExcelScript.CellValueConditionalFormat:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.Chart
uid: ExcelScript!ExcelScript.Chart:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.ChartAreaFormat
uid: ExcelScript!ExcelScript.ChartAreaFormat:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.ChartAxes
uid: ExcelScript!ExcelScript.ChartAxes:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.ChartAxis
uid: ExcelScript!ExcelScript.ChartAxis:interface
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.ChartAxisCategoryType
uid: ExcelScript!ExcelScript.ChartAxisCategoryType:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSEnum
### YamlMime:TSEnum
name: ExcelScript.ChartAxisDisplayUnit
uid: ExcelScript!ExcelScript.ChartAxisDisplayUnit:enum
package: ExcelScript!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### YamlMime:TSType
### YamlMime:TSType
name: ExcelScript.ChartAxisFormat
uid: ExcelScript!ExcelScript.ChartAxisFormat:interface
package: ExcelScript!
Expand Down
Loading