Skip to content
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

[Admin] Publish #2172

Merged
merged 2 commits into from
Jan 4, 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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ properties:
summary: |-
Specifies whether to load on the `textRuns` property.

\[ [API set: RangeTextRun](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
Expand Down
10 changes: 6 additions & 4 deletions docs/docs-ref-autogen/excel/excel/excel.notecollection.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,20 @@ methods:
uid: 'excel!Excel.NoteCollection#add:member(1)'
package: excel!
fullName: 'add(cellAddress, content)'
summary: Adds a new note to the collection.
summary: Adds a new note with the given content on the given cell.
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: true
isDeprecated: false
syntax:
content: 'add(cellAddress: Range | string, content: any): Excel.Note;'
parameters:
- id: cellAddress
description: ''
description: >-
The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is
invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown.
type: '<xref uid="excel!Excel.Range:class" /> | string'
- id: content
description: ''
description: The text of the note.
type: any
return:
type: '<xref uid="excel!Excel.Note:class" />'
Expand Down Expand Up @@ -81,7 +83,7 @@ methods:
content: 'getItemAt(index: number): Excel.Note;'
parameters:
- id: index
description: ''
description: The index value of the note to be retrieved. Zero-indexed.
type: number
return:
type: '<xref uid="excel!Excel.Note:class" />'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ properties:
summary: |-
Represents the `textRuns` property.

\[ [API set: RangeTextRun](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
remarks: ''
isPreview: false
isDeprecated: false
Expand Down
2 changes: 1 addition & 1 deletion docs/includes/excel-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
||[height](/javascript/api/excel/excel.note#excel-excel-note-height-member)|Specifies the height of the note.|
||[visible](/javascript/api/excel/excel.note#excel-excel-note-visible-member)|Specifies the visibility of the note.|
||[width](/javascript/api/excel/excel.note#excel-excel-note-width-member)|Specifies the width of the note.|
|[NoteCollection](/javascript/api/excel/excel.notecollection)|[add(cellAddress: Range \| string, content: any)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-add-member(1))|Adds a new note to the collection.|
|[NoteCollection](/javascript/api/excel/excel.notecollection)|[add(cellAddress: Range \| string, content: any)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-add-member(1))|Adds a new note with the given content on the given cell.|
||[getCount()](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getcount-member(1))|Gets the number of notes in the collection.|
||[getItemAt(index: number)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitemat-member(1))|Gets a note object by its index in the collection.|
||[items](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-items-member)|Gets the loaded child items in this collection.|
Expand Down
3 changes: 2 additions & 1 deletion docs/requirement-sets/excel/excel-preview-apis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Excel JavaScript preview APIs
description: Details about upcoming Excel JavaScript APIs.
ms.date: 10/10/2022
ms.date: 01/03/2025
ms.topic: whats-new
ms.localizationpriority: medium
---
Expand All @@ -18,6 +18,7 @@ The following table provides a concise summary of the APIs, while the subsequent
|:--- |:--- |:--- |
| Document tasks | Turn comments into tasks assigned to users. | [DocumentTask](/javascript/api/excel/excel.documenttask), [DocumentTaskChange](/javascript/api/excel/excel.documenttaskchange), [DocumentTaskChangeCollection](/javascript/api/excel/excel.documenttaskchangecollection), [DocumentTaskCollection](/javascript/api/excel/excel.documenttaskcollection) |
| Linked data types | Adds support for data types connected to Excel from external sources. | [LinkedDataType](/javascript/api/excel/excel.linkeddatatype), [LinkedDataTypeAddedEventArgs](/javascript/api/excel/excel.linkeddatatypeaddedeventargs), [LinkedDataTypeCollection](/javascript/api/excel/excel.linkeddatatypecollection) |
| Notes | Create, delete, and manage notes in a worksheet. Also supports setting the height, width, and visibility of notes. | [Note](/javascript/api/excel/excel.note), [NoteCollecction](/javascript/api/excel/excel.notecollection) |
| Table styles | Provides control for font, border, fill color, and other aspects of table styles. | [Table](/javascript/api/excel/excel.table), [PivotTable](/javascript/api/excel/excel.pivottable), [Slicer](/javascript/api/excel/excel.slicer) |

## API list
Expand Down
15 changes: 6 additions & 9 deletions generate-docs/api-extractor-inputs-excel/excel.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8132,7 +8132,7 @@ export declare namespace Excel {
/**
* Specifies whether to load on the `textRuns` property.
*
* [Api set: RangeTextRun]
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
textRuns?: boolean;
}
Expand Down Expand Up @@ -8335,7 +8335,7 @@ export declare namespace Excel {
/**
* Represents the `textRuns` property.
*
* [Api set: RangeTextRun]
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
textRuns?: RangeTextRun[];
}
Expand Down Expand Up @@ -41892,15 +41892,14 @@ export declare namespace Excel {
/** Gets the loaded child items in this collection. */
readonly items: Excel.Note[];
/**
* Adds a new note to the collection.
* Adds a new note with the given content on the given cell.
*
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param cellAddress
- * @param content
- * @returns
* @param cellAddress - The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown.
* @param content - The text of the note.
*/
add(cellAddress: Range | string, content: any): Excel.Note;
/**
Expand All @@ -41909,7 +41908,6 @@ export declare namespace Excel {
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
* @returns
*/
getCount(): OfficeExtension.ClientResult<number>;
/**
Expand All @@ -41919,8 +41917,7 @@ export declare namespace Excel {
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param index
- * @returns
* @param index - The index value of the note to be retrieved. Zero-indexed.
*/
getItemAt(index: number): Excel.Note;
/**
Expand Down
15 changes: 6 additions & 9 deletions generate-docs/script-inputs/office_preview.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32391,7 +32391,7 @@ declare namespace Excel {
/**
* Specifies whether to load on the `textRuns` property.
*
* [Api set: RangeTextRun]
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
textRuns?: boolean;
}
Expand Down Expand Up @@ -32594,7 +32594,7 @@ declare namespace Excel {
/**
* Represents the `textRuns` property.
*
* [Api set: RangeTextRun]
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
textRuns?: RangeTextRun[];
}
Expand Down Expand Up @@ -66129,15 +66129,14 @@ declare namespace Excel {
/** Gets the loaded child items in this collection. */
readonly items: Excel.Note[];
/**
* Adds a new note to the collection.
* Adds a new note with the given content on the given cell.
*
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param cellAddress
* @param content
* @returns
* @param cellAddress The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown.
* @param content The text of the note.
*/
add(cellAddress: Range | string, content: any): Excel.Note;
/**
Expand All @@ -66146,7 +66145,6 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
* @returns
*/
getCount(): OfficeExtension.ClientResult<number>;
/**
Expand All @@ -66156,8 +66154,7 @@ declare namespace Excel {
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param index
* @returns
* @param index The index value of the note to be retrieved. Zero-indexed.
*/
getItemAt(index: number): Excel.Note;
/**
Expand Down