@types/office-js-preview 1.0.553 → 1.0.555
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +129 -133
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 07 Feb 2025 19:32:28 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -22995,7 +22995,7 @@ declare namespace Office {
|
|
|
22995
22995
|
/**
|
|
22996
22996
|
* Provides methods to manage an item's session data.
|
|
22997
22997
|
*
|
|
22998
|
-
*
|
|
22998
|
+
* Session data is specific to a single mail item. It isn't shared among multiple items even if the same add-in is used to set or retrieve data.
|
|
22999
22999
|
*
|
|
23000
23000
|
* @remarks
|
|
23001
23001
|
* [Api set: Mailbox 1.11]
|
|
@@ -23003,6 +23003,8 @@ declare namespace Office {
|
|
|
23003
23003
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
23004
23004
|
*
|
|
23005
23005
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23006
|
+
*
|
|
23007
|
+
* **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
|
|
23006
23008
|
*/
|
|
23007
23009
|
interface SessionData {
|
|
23008
23010
|
/**
|
|
@@ -23048,7 +23050,7 @@ declare namespace Office {
|
|
|
23048
23050
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
23049
23051
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
23050
23052
|
*/
|
|
23051
|
-
getAllAsync(callback: (asyncResult: Office.AsyncResult<
|
|
23053
|
+
getAllAsync(callback: (asyncResult: Office.AsyncResult<object>) => void): void;
|
|
23052
23054
|
/**
|
|
23053
23055
|
* Gets the session data value of the specified key.
|
|
23054
23056
|
*
|
|
@@ -23099,15 +23101,15 @@ declare namespace Office {
|
|
|
23099
23101
|
/**
|
|
23100
23102
|
* Sets a session data key-value pair.
|
|
23101
23103
|
*
|
|
23102
|
-
* **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
|
|
23103
|
-
*
|
|
23104
23104
|
* @remarks
|
|
23105
23105
|
* [Api set: Mailbox 1.11]
|
|
23106
23106
|
*
|
|
23107
23107
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
23108
23108
|
*
|
|
23109
23109
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23110
|
-
|
|
23110
|
+
*
|
|
23111
|
+
* **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
|
|
23112
|
+
*
|
|
23111
23113
|
* @param name - The session data key.
|
|
23112
23114
|
* @param value - The session data value as a string.
|
|
23113
23115
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
@@ -23119,15 +23121,15 @@ declare namespace Office {
|
|
|
23119
23121
|
/**
|
|
23120
23122
|
* Sets a session data key-value pair.
|
|
23121
23123
|
*
|
|
23122
|
-
* **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
|
|
23123
|
-
*
|
|
23124
23124
|
* @remarks
|
|
23125
23125
|
* [Api set: Mailbox 1.11]
|
|
23126
23126
|
*
|
|
23127
23127
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
23128
23128
|
*
|
|
23129
23129
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
23130
|
-
|
|
23130
|
+
*
|
|
23131
|
+
* **Important**: For each mail item, the entire SessionData object is limited to 50,000 characters per add-in.
|
|
23132
|
+
*
|
|
23131
23133
|
* @param name - The session data key.
|
|
23132
23134
|
* @param value - The session data value as a string.
|
|
23133
23135
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
@@ -24274,8 +24276,9 @@ declare namespace Excel {
|
|
|
24274
24276
|
/**
|
|
24275
24277
|
* Represents an unknown cell control.
|
|
24276
24278
|
* This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
|
|
24277
|
-
*
|
|
24278
|
-
* @
|
|
24279
|
+
*
|
|
24280
|
+
* @remarks
|
|
24281
|
+
* [Api set: ExcelApi 1.18]
|
|
24279
24282
|
*/
|
|
24280
24283
|
interface UnknownCellControl {
|
|
24281
24284
|
type: CellControlType.unknown;
|
|
@@ -24283,8 +24286,9 @@ declare namespace Excel {
|
|
|
24283
24286
|
/**
|
|
24284
24287
|
* Represents an empty cell control.
|
|
24285
24288
|
* This represents the state where a cell does not have a control.
|
|
24286
|
-
*
|
|
24287
|
-
* @
|
|
24289
|
+
*
|
|
24290
|
+
* @remarks
|
|
24291
|
+
* [Api set: ExcelApi 1.18]
|
|
24288
24292
|
*/
|
|
24289
24293
|
interface EmptyCellControl {
|
|
24290
24294
|
type: CellControlType.empty;
|
|
@@ -24292,25 +24296,28 @@ declare namespace Excel {
|
|
|
24292
24296
|
/**
|
|
24293
24297
|
* Represents the result of a query that resulted in multiple cell controls.
|
|
24294
24298
|
* If the result has multiple controls, then they can't be represented as a single result.
|
|
24295
|
-
*
|
|
24296
|
-
* @
|
|
24299
|
+
*
|
|
24300
|
+
* @remarks
|
|
24301
|
+
* [Api set: ExcelApi 1.18]
|
|
24297
24302
|
*/
|
|
24298
24303
|
interface MixedCellControl {
|
|
24299
24304
|
type: CellControlType.mixed;
|
|
24300
24305
|
}
|
|
24301
24306
|
/**
|
|
24302
|
-
|
|
24303
|
-
|
|
24304
|
-
|
|
24305
|
-
|
|
24307
|
+
* Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
|
|
24308
|
+
*
|
|
24309
|
+
* @remarks
|
|
24310
|
+
* [Api set: ExcelApi 1.18]
|
|
24311
|
+
*/
|
|
24306
24312
|
interface CheckboxCellControl {
|
|
24307
24313
|
type: CellControlType.checkbox;
|
|
24308
24314
|
}
|
|
24309
24315
|
/**
|
|
24310
|
-
|
|
24311
|
-
|
|
24312
|
-
|
|
24313
|
-
|
|
24316
|
+
* Represents an interactable control inside of a cell.
|
|
24317
|
+
*
|
|
24318
|
+
* @remarks
|
|
24319
|
+
* [Api set: ExcelApi 1.18]
|
|
24320
|
+
*/
|
|
24314
24321
|
type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
|
|
24315
24322
|
/**
|
|
24316
24323
|
* Represents a 2D array of cell values.
|
|
@@ -32397,7 +32404,7 @@ declare namespace Excel {
|
|
|
32397
32404
|
/**
|
|
32398
32405
|
* Specifies whether to load on the `textRuns` property.
|
|
32399
32406
|
*
|
|
32400
|
-
* [Api set: ExcelApi
|
|
32407
|
+
* [Api set: ExcelApi 1.18]
|
|
32401
32408
|
*/
|
|
32402
32409
|
textRuns?: boolean;
|
|
32403
32410
|
}
|
|
@@ -32600,7 +32607,7 @@ declare namespace Excel {
|
|
|
32600
32607
|
/**
|
|
32601
32608
|
* Represents the `textRuns` property.
|
|
32602
32609
|
*
|
|
32603
|
-
* [Api set: ExcelApi
|
|
32610
|
+
* [Api set: ExcelApi 1.18]
|
|
32604
32611
|
*/
|
|
32605
32612
|
textRuns?: RangeTextRun[];
|
|
32606
32613
|
}
|
|
@@ -36507,39 +36514,41 @@ declare namespace Excel {
|
|
|
36507
36514
|
* Represents the type of cell control.
|
|
36508
36515
|
*
|
|
36509
36516
|
* @remarks
|
|
36510
|
-
* [Api set: ExcelApi
|
|
36511
|
-
* @beta
|
|
36517
|
+
* [Api set: ExcelApi 1.18]
|
|
36512
36518
|
*/
|
|
36513
36519
|
enum CellControlType {
|
|
36514
36520
|
/**
|
|
36515
36521
|
* Type representing an unknown control.
|
|
36516
36522
|
This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
|
|
36517
36523
|
* @remarks
|
|
36518
|
-
* [Api set: ExcelApi
|
|
36519
|
-
* @beta
|
|
36524
|
+
* [Api set: ExcelApi 1.18]
|
|
36520
36525
|
*/
|
|
36521
36526
|
unknown = "Unknown",
|
|
36522
36527
|
/**
|
|
36523
36528
|
* Type representing an empty control.
|
|
36524
36529
|
* @remarks
|
|
36525
|
-
* [Api set: ExcelApi
|
|
36526
|
-
* @beta
|
|
36530
|
+
* [Api set: ExcelApi 1.18]
|
|
36527
36531
|
*/
|
|
36528
36532
|
empty = "Empty",
|
|
36529
36533
|
/**
|
|
36530
36534
|
* Type representing a query that results in a mix of control results.
|
|
36531
36535
|
* @remarks
|
|
36532
|
-
* [Api set: ExcelApi
|
|
36533
|
-
* @beta
|
|
36536
|
+
* [Api set: ExcelApi 1.18]
|
|
36534
36537
|
*/
|
|
36535
36538
|
mixed = "Mixed",
|
|
36536
36539
|
/**
|
|
36537
36540
|
* Type representing a checkbox control.
|
|
36538
36541
|
* @remarks
|
|
36542
|
+
* [Api set: ExcelApi 1.18]
|
|
36543
|
+
*/
|
|
36544
|
+
checkbox = "Checkbox",
|
|
36545
|
+
/**
|
|
36546
|
+
* Type representing a dropdown control.
|
|
36547
|
+
* @remarks
|
|
36539
36548
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
36540
36549
|
* @beta
|
|
36541
36550
|
*/
|
|
36542
|
-
|
|
36551
|
+
dropdown = "Dropdown"
|
|
36543
36552
|
}
|
|
36544
36553
|
/**
|
|
36545
36554
|
* Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.
|
|
@@ -38105,8 +38114,7 @@ declare namespace Excel {
|
|
|
38105
38114
|
* Returns a collection of all the notes objects in the workbook.
|
|
38106
38115
|
*
|
|
38107
38116
|
* @remarks
|
|
38108
|
-
* [Api set: ExcelApi
|
|
38109
|
-
* @beta
|
|
38117
|
+
* [Api set: ExcelApi 1.18]
|
|
38110
38118
|
*/
|
|
38111
38119
|
readonly notes: Excel.NoteCollection;
|
|
38112
38120
|
/**
|
|
@@ -38632,8 +38640,7 @@ declare namespace Excel {
|
|
|
38632
38640
|
* Returns a collection of all the notes objects in the worksheet.
|
|
38633
38641
|
*
|
|
38634
38642
|
* @remarks
|
|
38635
|
-
* [Api set: ExcelApi
|
|
38636
|
-
* @beta
|
|
38643
|
+
* [Api set: ExcelApi 1.18]
|
|
38637
38644
|
*/
|
|
38638
38645
|
readonly notes: Excel.NoteCollection;
|
|
38639
38646
|
/**
|
|
@@ -39890,8 +39897,7 @@ declare namespace Excel {
|
|
|
39890
39897
|
If the range has multiple cell controls, this returns `EmptyCellControl`.
|
|
39891
39898
|
*
|
|
39892
39899
|
* @remarks
|
|
39893
|
-
* [Api set: ExcelApi
|
|
39894
|
-
* @beta
|
|
39900
|
+
* [Api set: ExcelApi 1.18]
|
|
39895
39901
|
*/
|
|
39896
39902
|
control: CellControl;
|
|
39897
39903
|
/**
|
|
@@ -40156,8 +40162,7 @@ declare namespace Excel {
|
|
|
40156
40162
|
Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range.
|
|
40157
40163
|
*
|
|
40158
40164
|
* @remarks
|
|
40159
|
-
* [Api set: ExcelApi
|
|
40160
|
-
* @beta
|
|
40165
|
+
* [Api set: ExcelApi 1.18]
|
|
40161
40166
|
*/
|
|
40162
40167
|
clearOrResetContents(): void;
|
|
40163
40168
|
/**
|
|
@@ -41085,8 +41090,7 @@ declare namespace Excel {
|
|
|
41085
41090
|
Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges.
|
|
41086
41091
|
*
|
|
41087
41092
|
* @remarks
|
|
41088
|
-
* [Api set: ExcelApi
|
|
41089
|
-
* @beta
|
|
41093
|
+
* [Api set: ExcelApi 1.18]
|
|
41090
41094
|
*/
|
|
41091
41095
|
clearOrResetContents(): void;
|
|
41092
41096
|
/**
|
|
@@ -41251,8 +41255,7 @@ declare namespace Excel {
|
|
|
41251
41255
|
* Selects the specified range areas in the Excel UI.
|
|
41252
41256
|
*
|
|
41253
41257
|
* @remarks
|
|
41254
|
-
* [Api set: ExcelApi
|
|
41255
|
-
* @beta
|
|
41258
|
+
* [Api set: ExcelApi 1.18]
|
|
41256
41259
|
*/
|
|
41257
41260
|
select(): void;
|
|
41258
41261
|
/**
|
|
@@ -41618,12 +41621,25 @@ declare namespace Excel {
|
|
|
41618
41621
|
weight?: boolean;
|
|
41619
41622
|
}
|
|
41620
41623
|
/**
|
|
41624
|
+
* Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`.
|
|
41625
|
+
*
|
|
41621
41626
|
* @remarks
|
|
41622
|
-
* [Api set: ExcelApi
|
|
41623
|
-
* @beta
|
|
41627
|
+
* [Api set: ExcelApi 1.18]
|
|
41624
41628
|
*/
|
|
41625
41629
|
interface RangeTextRun {
|
|
41630
|
+
/**
|
|
41631
|
+
* The font attributes (such as font name, font size, and color) applied to this text run.
|
|
41632
|
+
*
|
|
41633
|
+
* @remarks
|
|
41634
|
+
* [Api set: ExcelApi 1.18]
|
|
41635
|
+
*/
|
|
41626
41636
|
font?: Excel.CellPropertiesFont;
|
|
41637
|
+
/**
|
|
41638
|
+
* The text of this text run.
|
|
41639
|
+
*
|
|
41640
|
+
* @remarks
|
|
41641
|
+
* [Api set: ExcelApi 1.18]
|
|
41642
|
+
*/
|
|
41627
41643
|
text: string;
|
|
41628
41644
|
}
|
|
41629
41645
|
/**
|
|
@@ -61266,8 +61282,7 @@ declare namespace Excel {
|
|
|
61266
61282
|
Cells with cell controls are set to the default value defined by each control.
|
|
61267
61283
|
Cells without cell controls are set to blank.
|
|
61268
61284
|
* @remarks
|
|
61269
|
-
* [Api set: ExcelApi
|
|
61270
|
-
* @beta
|
|
61285
|
+
* [Api set: ExcelApi 1.18]
|
|
61271
61286
|
*/
|
|
61272
61287
|
resetContents = "ResetContents"
|
|
61273
61288
|
}
|
|
@@ -66126,8 +66141,7 @@ declare namespace Excel {
|
|
|
66126
66141
|
* Represents a collection of note objects that are part of the workbook.
|
|
66127
66142
|
*
|
|
66128
66143
|
* @remarks
|
|
66129
|
-
* [Api set: ExcelApi
|
|
66130
|
-
* @beta
|
|
66144
|
+
* [Api set: ExcelApi 1.18]
|
|
66131
66145
|
*/
|
|
66132
66146
|
class NoteCollection extends OfficeExtension.ClientObject {
|
|
66133
66147
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -66138,8 +66152,7 @@ declare namespace Excel {
|
|
|
66138
66152
|
* Adds a new note with the given content on the given cell.
|
|
66139
66153
|
*
|
|
66140
66154
|
* @remarks
|
|
66141
|
-
* [Api set: ExcelApi
|
|
66142
|
-
* @beta
|
|
66155
|
+
* [Api set: ExcelApi 1.18]
|
|
66143
66156
|
*
|
|
66144
66157
|
* @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.
|
|
66145
66158
|
* @param content The text of the note.
|
|
@@ -66149,20 +66162,38 @@ declare namespace Excel {
|
|
|
66149
66162
|
* Gets the number of notes in the collection.
|
|
66150
66163
|
*
|
|
66151
66164
|
* @remarks
|
|
66152
|
-
* [Api set: ExcelApi
|
|
66153
|
-
* @beta
|
|
66165
|
+
* [Api set: ExcelApi 1.18]
|
|
66154
66166
|
*/
|
|
66155
66167
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
66156
66168
|
/**
|
|
66157
|
-
* Gets a note
|
|
66169
|
+
* Gets a note by its cell address.
|
|
66158
66170
|
*
|
|
66159
66171
|
* @remarks
|
|
66160
|
-
* [Api set: ExcelApi
|
|
66161
|
-
*
|
|
66172
|
+
* [Api set: ExcelApi 1.18]
|
|
66173
|
+
*
|
|
66174
|
+
* @param key The cell address of the note.
|
|
66175
|
+
* @returns The note with the given cell address. If there is no note with the given cell address, then the `ItemNotFound` error is thrown.
|
|
66176
|
+
*/
|
|
66177
|
+
getItem(key: string): Excel.Note;
|
|
66178
|
+
/**
|
|
66179
|
+
* Gets a note from the collection based on its position.
|
|
66180
|
+
*
|
|
66181
|
+
* @remarks
|
|
66182
|
+
* [Api set: ExcelApi 1.18]
|
|
66162
66183
|
*
|
|
66163
66184
|
* @param index The index value of the note to be retrieved. Zero-indexed.
|
|
66164
66185
|
*/
|
|
66165
66186
|
getItemAt(index: number): Excel.Note;
|
|
66187
|
+
/**
|
|
66188
|
+
* Gets a note by its cell address. If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
66189
|
+
*
|
|
66190
|
+
* @remarks
|
|
66191
|
+
* [Api set: ExcelApi 1.18]
|
|
66192
|
+
*
|
|
66193
|
+
* @param key The cell address of the note.
|
|
66194
|
+
* @returns The note with the given cell address or null object.
|
|
66195
|
+
*/
|
|
66196
|
+
getItemOrNullObject(key: string): Excel.Note;
|
|
66166
66197
|
/**
|
|
66167
66198
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
66168
66199
|
*
|
|
@@ -66191,8 +66222,7 @@ declare namespace Excel {
|
|
|
66191
66222
|
* Represents a note in the workbook or worksheet.
|
|
66192
66223
|
*
|
|
66193
66224
|
* @remarks
|
|
66194
|
-
* [Api set: ExcelApi
|
|
66195
|
-
* @beta
|
|
66225
|
+
* [Api set: ExcelApi 1.18]
|
|
66196
66226
|
*/
|
|
66197
66227
|
class Note extends OfficeExtension.ClientObject {
|
|
66198
66228
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
@@ -66201,40 +66231,35 @@ declare namespace Excel {
|
|
|
66201
66231
|
* Gets the author of the note.
|
|
66202
66232
|
*
|
|
66203
66233
|
* @remarks
|
|
66204
|
-
* [Api set: ExcelApi
|
|
66205
|
-
* @beta
|
|
66234
|
+
* [Api set: ExcelApi 1.18]
|
|
66206
66235
|
*/
|
|
66207
66236
|
readonly authorName: string;
|
|
66208
66237
|
/**
|
|
66209
|
-
* Gets or sets the text of the note.
|
|
66238
|
+
* Gets or sets the text of the note.
|
|
66210
66239
|
*
|
|
66211
66240
|
* @remarks
|
|
66212
|
-
* [Api set: ExcelApi
|
|
66213
|
-
* @beta
|
|
66241
|
+
* [Api set: ExcelApi 1.18]
|
|
66214
66242
|
*/
|
|
66215
66243
|
content: string;
|
|
66216
66244
|
/**
|
|
66217
66245
|
* Specifies the height of the note.
|
|
66218
66246
|
*
|
|
66219
66247
|
* @remarks
|
|
66220
|
-
* [Api set: ExcelApi
|
|
66221
|
-
* @beta
|
|
66248
|
+
* [Api set: ExcelApi 1.18]
|
|
66222
66249
|
*/
|
|
66223
66250
|
height: number;
|
|
66224
66251
|
/**
|
|
66225
66252
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
66226
66253
|
*
|
|
66227
66254
|
* @remarks
|
|
66228
|
-
* [Api set: ExcelApi
|
|
66229
|
-
* @beta
|
|
66255
|
+
* [Api set: ExcelApi 1.18]
|
|
66230
66256
|
*/
|
|
66231
66257
|
visible: boolean;
|
|
66232
66258
|
/**
|
|
66233
66259
|
* Specifies the width of the note.
|
|
66234
66260
|
*
|
|
66235
66261
|
* @remarks
|
|
66236
|
-
* [Api set: ExcelApi
|
|
66237
|
-
* @beta
|
|
66262
|
+
* [Api set: ExcelApi 1.18]
|
|
66238
66263
|
*/
|
|
66239
66264
|
width: number;
|
|
66240
66265
|
/**
|
|
@@ -66249,16 +66274,14 @@ declare namespace Excel {
|
|
|
66249
66274
|
* Deletes the note.
|
|
66250
66275
|
*
|
|
66251
66276
|
* @remarks
|
|
66252
|
-
* [Api set: ExcelApi
|
|
66253
|
-
* @beta
|
|
66277
|
+
* [Api set: ExcelApi 1.18]
|
|
66254
66278
|
*/
|
|
66255
66279
|
delete(): void;
|
|
66256
66280
|
/**
|
|
66257
66281
|
* Gets the cell where this note is located.
|
|
66258
66282
|
*
|
|
66259
66283
|
* @remarks
|
|
66260
|
-
* [Api set: ExcelApi
|
|
66261
|
-
* @beta
|
|
66284
|
+
* [Api set: ExcelApi 1.18]
|
|
66262
66285
|
*/
|
|
66263
66286
|
getLocation(): Excel.Range;
|
|
66264
66287
|
/**
|
|
@@ -70446,8 +70469,7 @@ declare namespace Excel {
|
|
|
70446
70469
|
If the range has multiple cell controls, this returns `EmptyCellControl`.
|
|
70447
70470
|
*
|
|
70448
70471
|
* @remarks
|
|
70449
|
-
* [Api set: ExcelApi
|
|
70450
|
-
* @beta
|
|
70472
|
+
* [Api set: ExcelApi 1.18]
|
|
70451
70473
|
*/
|
|
70452
70474
|
control?: CellControl;
|
|
70453
70475
|
/**
|
|
@@ -75142,35 +75164,31 @@ declare namespace Excel {
|
|
|
75142
75164
|
/** An interface for updating data on the `Note` object, for use in `note.set({ ... })`. */
|
|
75143
75165
|
interface NoteUpdateData {
|
|
75144
75166
|
/**
|
|
75145
|
-
* Gets or sets the text of the note.
|
|
75167
|
+
* Gets or sets the text of the note.
|
|
75146
75168
|
*
|
|
75147
75169
|
* @remarks
|
|
75148
|
-
* [Api set: ExcelApi
|
|
75149
|
-
* @beta
|
|
75170
|
+
* [Api set: ExcelApi 1.18]
|
|
75150
75171
|
*/
|
|
75151
75172
|
content?: string;
|
|
75152
75173
|
/**
|
|
75153
75174
|
* Specifies the height of the note.
|
|
75154
75175
|
*
|
|
75155
75176
|
* @remarks
|
|
75156
|
-
* [Api set: ExcelApi
|
|
75157
|
-
* @beta
|
|
75177
|
+
* [Api set: ExcelApi 1.18]
|
|
75158
75178
|
*/
|
|
75159
75179
|
height?: number;
|
|
75160
75180
|
/**
|
|
75161
75181
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
75162
75182
|
*
|
|
75163
75183
|
* @remarks
|
|
75164
|
-
* [Api set: ExcelApi
|
|
75165
|
-
* @beta
|
|
75184
|
+
* [Api set: ExcelApi 1.18]
|
|
75166
75185
|
*/
|
|
75167
75186
|
visible?: boolean;
|
|
75168
75187
|
/**
|
|
75169
75188
|
* Specifies the width of the note.
|
|
75170
75189
|
*
|
|
75171
75190
|
* @remarks
|
|
75172
|
-
* [Api set: ExcelApi
|
|
75173
|
-
* @beta
|
|
75191
|
+
* [Api set: ExcelApi 1.18]
|
|
75174
75192
|
*/
|
|
75175
75193
|
width?: number;
|
|
75176
75194
|
}
|
|
@@ -75605,8 +75623,7 @@ declare namespace Excel {
|
|
|
75605
75623
|
* Returns a collection of all the notes objects in the workbook.
|
|
75606
75624
|
*
|
|
75607
75625
|
* @remarks
|
|
75608
|
-
* [Api set: ExcelApi
|
|
75609
|
-
* @beta
|
|
75626
|
+
* [Api set: ExcelApi 1.18]
|
|
75610
75627
|
*/
|
|
75611
75628
|
notes?: Excel.Interfaces.NoteData[];
|
|
75612
75629
|
/**
|
|
@@ -75839,8 +75856,7 @@ declare namespace Excel {
|
|
|
75839
75856
|
* Returns a collection of all the notes objects in the worksheet.
|
|
75840
75857
|
*
|
|
75841
75858
|
* @remarks
|
|
75842
|
-
* [Api set: ExcelApi
|
|
75843
|
-
* @beta
|
|
75859
|
+
* [Api set: ExcelApi 1.18]
|
|
75844
75860
|
*/
|
|
75845
75861
|
notes?: Excel.Interfaces.NoteData[];
|
|
75846
75862
|
/**
|
|
@@ -76102,8 +76118,7 @@ declare namespace Excel {
|
|
|
76102
76118
|
If the range has multiple cell controls, this returns `EmptyCellControl`.
|
|
76103
76119
|
*
|
|
76104
76120
|
* @remarks
|
|
76105
|
-
* [Api set: ExcelApi
|
|
76106
|
-
* @beta
|
|
76121
|
+
* [Api set: ExcelApi 1.18]
|
|
76107
76122
|
*/
|
|
76108
76123
|
control?: CellControl;
|
|
76109
76124
|
/**
|
|
@@ -82162,40 +82177,35 @@ declare namespace Excel {
|
|
|
82162
82177
|
* Gets the author of the note.
|
|
82163
82178
|
*
|
|
82164
82179
|
* @remarks
|
|
82165
|
-
* [Api set: ExcelApi
|
|
82166
|
-
* @beta
|
|
82180
|
+
* [Api set: ExcelApi 1.18]
|
|
82167
82181
|
*/
|
|
82168
82182
|
authorName?: string;
|
|
82169
82183
|
/**
|
|
82170
|
-
* Gets or sets the text of the note.
|
|
82184
|
+
* Gets or sets the text of the note.
|
|
82171
82185
|
*
|
|
82172
82186
|
* @remarks
|
|
82173
|
-
* [Api set: ExcelApi
|
|
82174
|
-
* @beta
|
|
82187
|
+
* [Api set: ExcelApi 1.18]
|
|
82175
82188
|
*/
|
|
82176
82189
|
content?: string;
|
|
82177
82190
|
/**
|
|
82178
82191
|
* Specifies the height of the note.
|
|
82179
82192
|
*
|
|
82180
82193
|
* @remarks
|
|
82181
|
-
* [Api set: ExcelApi
|
|
82182
|
-
* @beta
|
|
82194
|
+
* [Api set: ExcelApi 1.18]
|
|
82183
82195
|
*/
|
|
82184
82196
|
height?: number;
|
|
82185
82197
|
/**
|
|
82186
82198
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
82187
82199
|
*
|
|
82188
82200
|
* @remarks
|
|
82189
|
-
* [Api set: ExcelApi
|
|
82190
|
-
* @beta
|
|
82201
|
+
* [Api set: ExcelApi 1.18]
|
|
82191
82202
|
*/
|
|
82192
82203
|
visible?: boolean;
|
|
82193
82204
|
/**
|
|
82194
82205
|
* Specifies the width of the note.
|
|
82195
82206
|
*
|
|
82196
82207
|
* @remarks
|
|
82197
|
-
* [Api set: ExcelApi
|
|
82198
|
-
* @beta
|
|
82208
|
+
* [Api set: ExcelApi 1.18]
|
|
82199
82209
|
*/
|
|
82200
82210
|
width?: number;
|
|
82201
82211
|
}
|
|
@@ -83556,8 +83566,7 @@ declare namespace Excel {
|
|
|
83556
83566
|
If the range has multiple cell controls, this returns `EmptyCellControl`.
|
|
83557
83567
|
*
|
|
83558
83568
|
* @remarks
|
|
83559
|
-
* [Api set: ExcelApi
|
|
83560
|
-
* @beta
|
|
83569
|
+
* [Api set: ExcelApi 1.18]
|
|
83561
83570
|
*/
|
|
83562
83571
|
control?: boolean;
|
|
83563
83572
|
/**
|
|
@@ -91888,8 +91897,7 @@ declare namespace Excel {
|
|
|
91888
91897
|
If the range has multiple cell controls, this returns `EmptyCellControl`.
|
|
91889
91898
|
*
|
|
91890
91899
|
* @remarks
|
|
91891
|
-
* [Api set: ExcelApi
|
|
91892
|
-
* @beta
|
|
91900
|
+
* [Api set: ExcelApi 1.18]
|
|
91893
91901
|
*/
|
|
91894
91902
|
control?: boolean;
|
|
91895
91903
|
/**
|
|
@@ -94033,8 +94041,7 @@ declare namespace Excel {
|
|
|
94033
94041
|
* Represents a collection of note objects that are part of the workbook.
|
|
94034
94042
|
*
|
|
94035
94043
|
* @remarks
|
|
94036
|
-
* [Api set: ExcelApi
|
|
94037
|
-
* @beta
|
|
94044
|
+
* [Api set: ExcelApi 1.18]
|
|
94038
94045
|
*/
|
|
94039
94046
|
interface NoteCollectionLoadOptions {
|
|
94040
94047
|
/**
|
|
@@ -94045,40 +94052,35 @@ declare namespace Excel {
|
|
|
94045
94052
|
* For EACH ITEM in the collection: Gets the author of the note.
|
|
94046
94053
|
*
|
|
94047
94054
|
* @remarks
|
|
94048
|
-
* [Api set: ExcelApi
|
|
94049
|
-
* @beta
|
|
94055
|
+
* [Api set: ExcelApi 1.18]
|
|
94050
94056
|
*/
|
|
94051
94057
|
authorName?: boolean;
|
|
94052
94058
|
/**
|
|
94053
|
-
* For EACH ITEM in the collection: Gets or sets the text of the note.
|
|
94059
|
+
* For EACH ITEM in the collection: Gets or sets the text of the note.
|
|
94054
94060
|
*
|
|
94055
94061
|
* @remarks
|
|
94056
|
-
* [Api set: ExcelApi
|
|
94057
|
-
* @beta
|
|
94062
|
+
* [Api set: ExcelApi 1.18]
|
|
94058
94063
|
*/
|
|
94059
94064
|
content?: boolean;
|
|
94060
94065
|
/**
|
|
94061
94066
|
* For EACH ITEM in the collection: Specifies the height of the note.
|
|
94062
94067
|
*
|
|
94063
94068
|
* @remarks
|
|
94064
|
-
* [Api set: ExcelApi
|
|
94065
|
-
* @beta
|
|
94069
|
+
* [Api set: ExcelApi 1.18]
|
|
94066
94070
|
*/
|
|
94067
94071
|
height?: boolean;
|
|
94068
94072
|
/**
|
|
94069
94073
|
* For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
94070
94074
|
*
|
|
94071
94075
|
* @remarks
|
|
94072
|
-
* [Api set: ExcelApi
|
|
94073
|
-
* @beta
|
|
94076
|
+
* [Api set: ExcelApi 1.18]
|
|
94074
94077
|
*/
|
|
94075
94078
|
visible?: boolean;
|
|
94076
94079
|
/**
|
|
94077
94080
|
* For EACH ITEM in the collection: Specifies the width of the note.
|
|
94078
94081
|
*
|
|
94079
94082
|
* @remarks
|
|
94080
|
-
* [Api set: ExcelApi
|
|
94081
|
-
* @beta
|
|
94083
|
+
* [Api set: ExcelApi 1.18]
|
|
94082
94084
|
*/
|
|
94083
94085
|
width?: boolean;
|
|
94084
94086
|
}
|
|
@@ -94086,8 +94088,7 @@ declare namespace Excel {
|
|
|
94086
94088
|
* Represents a note in the workbook or worksheet.
|
|
94087
94089
|
*
|
|
94088
94090
|
* @remarks
|
|
94089
|
-
* [Api set: ExcelApi
|
|
94090
|
-
* @beta
|
|
94091
|
+
* [Api set: ExcelApi 1.18]
|
|
94091
94092
|
*/
|
|
94092
94093
|
interface NoteLoadOptions {
|
|
94093
94094
|
/**
|
|
@@ -94098,40 +94099,35 @@ declare namespace Excel {
|
|
|
94098
94099
|
* Gets the author of the note.
|
|
94099
94100
|
*
|
|
94100
94101
|
* @remarks
|
|
94101
|
-
* [Api set: ExcelApi
|
|
94102
|
-
* @beta
|
|
94102
|
+
* [Api set: ExcelApi 1.18]
|
|
94103
94103
|
*/
|
|
94104
94104
|
authorName?: boolean;
|
|
94105
94105
|
/**
|
|
94106
|
-
* Gets or sets the text of the note.
|
|
94106
|
+
* Gets or sets the text of the note.
|
|
94107
94107
|
*
|
|
94108
94108
|
* @remarks
|
|
94109
|
-
* [Api set: ExcelApi
|
|
94110
|
-
* @beta
|
|
94109
|
+
* [Api set: ExcelApi 1.18]
|
|
94111
94110
|
*/
|
|
94112
94111
|
content?: boolean;
|
|
94113
94112
|
/**
|
|
94114
94113
|
* Specifies the height of the note.
|
|
94115
94114
|
*
|
|
94116
94115
|
* @remarks
|
|
94117
|
-
* [Api set: ExcelApi
|
|
94118
|
-
* @beta
|
|
94116
|
+
* [Api set: ExcelApi 1.18]
|
|
94119
94117
|
*/
|
|
94120
94118
|
height?: boolean;
|
|
94121
94119
|
/**
|
|
94122
94120
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
94123
94121
|
*
|
|
94124
94122
|
* @remarks
|
|
94125
|
-
* [Api set: ExcelApi
|
|
94126
|
-
* @beta
|
|
94123
|
+
* [Api set: ExcelApi 1.18]
|
|
94127
94124
|
*/
|
|
94128
94125
|
visible?: boolean;
|
|
94129
94126
|
/**
|
|
94130
94127
|
* Specifies the width of the note.
|
|
94131
94128
|
*
|
|
94132
94129
|
* @remarks
|
|
94133
|
-
* [Api set: ExcelApi
|
|
94134
|
-
* @beta
|
|
94130
|
+
* [Api set: ExcelApi 1.18]
|
|
94135
94131
|
*/
|
|
94136
94132
|
width?: boolean;
|
|
94137
94133
|
}
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.555",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "f812a3a4625066ccd93204cb30dcbd4c8a8e243f2408fb30a479e9173b8af266",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|