microsoft-graph 2.25.0 → 2.26.0
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.
- package/dist/cjs/operations/workbookWorksheet/createWorkbookWorksheet.d.ts +1 -0
- package/dist/cjs/operations/workbookWorksheet/createWorkbookWorksheet.d.ts.map +1 -1
- package/dist/cjs/operations/workbookWorksheet/createWorkbookWorksheet.js +1 -0
- package/dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts +18 -0
- package/dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts.map +1 -0
- package/dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js +37 -0
- package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.d.ts +1 -0
- package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.d.ts.map +1 -1
- package/dist/esm/operations/workbookWorksheet/createWorkbookWorksheet.js +1 -0
- package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts +18 -0
- package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts.map +1 -0
- package/dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js +34 -0
- package/docs/api/README.md +2 -1
- package/docs/api/createWorkbookWorksheet.md +5 -1
- package/docs/api/getWorkbookWorksheetByName-1.md +32 -0
- package/docs/api/getWorkbookWorksheetByName.md +10 -10
- package/package.json +26 -6
|
@@ -13,6 +13,7 @@ import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../../models/W
|
|
|
13
13
|
* @param name (Optional) The name of the new worksheet.
|
|
14
14
|
* @returns The newly created worksheet.
|
|
15
15
|
* @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
|
|
16
|
+
* @remarks While `createWorkbookWorksheet` returns a reference to the worksheet, `getWorkbookWorksheetByName` and `listWorkbookWorksheets` may be unable to see the worksheet for a number of seconds. Calling `calculateWorkbook` can hasten the availability of the new worksheet for these operations.
|
|
16
17
|
*/
|
|
17
18
|
export default function createWorkbookWorksheet(workbookRef: WorkbookRef, name?: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
|
|
18
19
|
//# sourceMappingURL=createWorkbookWorksheet.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/createWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H
|
|
1
|
+
{"version":3,"file":"createWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/createWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAsBhK"}
|
|
@@ -15,6 +15,7 @@ const workbookWorksheet_ts_1 = require("../../services/workbookWorksheet.js");
|
|
|
15
15
|
* @param name (Optional) The name of the new worksheet.
|
|
16
16
|
* @returns The newly created worksheet.
|
|
17
17
|
* @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
|
|
18
|
+
* @remarks While `createWorkbookWorksheet` returns a reference to the worksheet, `getWorkbookWorksheetByName` and `listWorkbookWorksheets` may be unable to see the worksheet for a number of seconds. Calling `calculateWorkbook` can hasten the availability of the new worksheet for these operations.
|
|
18
19
|
*/
|
|
19
20
|
function createWorkbookWorksheet(workbookRef, name) {
|
|
20
21
|
return (0, operationInvoker_ts_1.operation)({
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
3
|
+
* @module getWorkbookWorksheetByName
|
|
4
|
+
* @category Operations
|
|
5
|
+
*/
|
|
6
|
+
import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
|
|
7
|
+
import type { GraphOperation } from "../../models/GraphOperation.ts";
|
|
8
|
+
import type { WorkbookRef } from "../../models/Workbook.ts";
|
|
9
|
+
import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../../models/WorkbookWorksheet.ts";
|
|
10
|
+
/**
|
|
11
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
12
|
+
* @param workbookRef Reference to the workbook.
|
|
13
|
+
* @param worksheetName The name of the worksheet to retrieve.
|
|
14
|
+
* @returns The worksheet object.
|
|
15
|
+
* @see https://learn.microsoft.com/en-us/graph/api/worksheet-get
|
|
16
|
+
*/
|
|
17
|
+
export default function getWorkbookWorksheetByName(workbookRef: WorkbookRef, worksheetName: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
|
|
18
|
+
//# sourceMappingURL=getWorkbookWorksheetByName.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAmB3K"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
4
|
+
* @module getWorkbookWorksheetByName
|
|
5
|
+
* @category Operations
|
|
6
|
+
*/
|
|
7
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
8
|
+
exports.default = getWorkbookWorksheetByName;
|
|
9
|
+
const operationInvoker_ts_1 = require("../../services/operationInvoker.js");
|
|
10
|
+
const templatedPaths_ts_1 = require("../../services/templatedPaths.js");
|
|
11
|
+
const workbookWorksheet_ts_1 = require("../../services/workbookWorksheet.js");
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
14
|
+
* @param workbookRef Reference to the workbook.
|
|
15
|
+
* @param worksheetName The name of the worksheet to retrieve.
|
|
16
|
+
* @returns The worksheet object.
|
|
17
|
+
* @see https://learn.microsoft.com/en-us/graph/api/worksheet-get
|
|
18
|
+
*/
|
|
19
|
+
function getWorkbookWorksheetByName(workbookRef, worksheetName) {
|
|
20
|
+
return (0, operationInvoker_ts_1.operation)({
|
|
21
|
+
context: workbookRef.context,
|
|
22
|
+
method: "GET",
|
|
23
|
+
path: (0, templatedPaths_ts_1.generatePath)(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets('${encodeURIComponent(worksheetName)}')`, workbookRef),
|
|
24
|
+
headers: {
|
|
25
|
+
"workbook-session-id": workbookRef.sessionId,
|
|
26
|
+
},
|
|
27
|
+
body: null,
|
|
28
|
+
responseTransform: (response) => {
|
|
29
|
+
const worksheet = response;
|
|
30
|
+
const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbookRef, worksheet.id);
|
|
31
|
+
return {
|
|
32
|
+
...worksheet,
|
|
33
|
+
...worksheetRef,
|
|
34
|
+
};
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
}
|
|
@@ -13,6 +13,7 @@ import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../../models/W
|
|
|
13
13
|
* @param name (Optional) The name of the new worksheet.
|
|
14
14
|
* @returns The newly created worksheet.
|
|
15
15
|
* @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
|
|
16
|
+
* @remarks While `createWorkbookWorksheet` returns a reference to the worksheet, `getWorkbookWorksheetByName` and `listWorkbookWorksheets` may be unable to see the worksheet for a number of seconds. Calling `calculateWorkbook` can hasten the availability of the new worksheet for these operations.
|
|
16
17
|
*/
|
|
17
18
|
export default function createWorkbookWorksheet(workbookRef: WorkbookRef, name?: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
|
|
18
19
|
//# sourceMappingURL=createWorkbookWorksheet.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/createWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H
|
|
1
|
+
{"version":3,"file":"createWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/createWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAsBhK"}
|
|
@@ -12,6 +12,7 @@ import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js"
|
|
|
12
12
|
* @param name (Optional) The name of the new worksheet.
|
|
13
13
|
* @returns The newly created worksheet.
|
|
14
14
|
* @see https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
|
|
15
|
+
* @remarks While `createWorkbookWorksheet` returns a reference to the worksheet, `getWorkbookWorksheetByName` and `listWorkbookWorksheets` may be unable to see the worksheet for a number of seconds. Calling `calculateWorkbook` can hasten the availability of the new worksheet for these operations.
|
|
15
16
|
*/
|
|
16
17
|
export default function createWorkbookWorksheet(workbookRef, name) {
|
|
17
18
|
return operation({
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
3
|
+
* @module getWorkbookWorksheetByName
|
|
4
|
+
* @category Operations
|
|
5
|
+
*/
|
|
6
|
+
import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
|
|
7
|
+
import type { GraphOperation } from "../../models/GraphOperation.ts";
|
|
8
|
+
import type { WorkbookRef } from "../../models/Workbook.ts";
|
|
9
|
+
import type { WorkbookWorksheetName, WorkbookWorksheetRef } from "../../models/WorkbookWorksheet.ts";
|
|
10
|
+
/**
|
|
11
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
12
|
+
* @param workbookRef Reference to the workbook.
|
|
13
|
+
* @param worksheetName The name of the worksheet to retrieve.
|
|
14
|
+
* @returns The worksheet object.
|
|
15
|
+
* @see https://learn.microsoft.com/en-us/graph/api/worksheet-get
|
|
16
|
+
*/
|
|
17
|
+
export default function getWorkbookWorksheetByName(workbookRef: WorkbookRef, worksheetName: WorkbookWorksheetName): GraphOperation<WorkbookWorksheet & WorkbookWorksheetRef>;
|
|
18
|
+
//# sourceMappingURL=getWorkbookWorksheetByName.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../../src/operations/workbookWorksheet/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAuB,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK1H;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,qBAAqB,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAmB3K"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
3
|
+
* @module getWorkbookWorksheetByName
|
|
4
|
+
* @category Operations
|
|
5
|
+
*/
|
|
6
|
+
import { operation } from "../../services/operationInvoker.js";
|
|
7
|
+
import { generatePath } from "../../services/templatedPaths.js";
|
|
8
|
+
import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve a worksheet by its name from a workbook.
|
|
11
|
+
* @param workbookRef Reference to the workbook.
|
|
12
|
+
* @param worksheetName The name of the worksheet to retrieve.
|
|
13
|
+
* @returns The worksheet object.
|
|
14
|
+
* @see https://learn.microsoft.com/en-us/graph/api/worksheet-get
|
|
15
|
+
*/
|
|
16
|
+
export default function getWorkbookWorksheetByName(workbookRef, worksheetName) {
|
|
17
|
+
return operation({
|
|
18
|
+
context: workbookRef.context,
|
|
19
|
+
method: "GET",
|
|
20
|
+
path: generatePath(`/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets('${encodeURIComponent(worksheetName)}')`, workbookRef),
|
|
21
|
+
headers: {
|
|
22
|
+
"workbook-session-id": workbookRef.sessionId,
|
|
23
|
+
},
|
|
24
|
+
body: null,
|
|
25
|
+
responseTransform: (response) => {
|
|
26
|
+
const worksheet = response;
|
|
27
|
+
const worksheetRef = createWorkbookWorksheetRef(workbookRef, worksheet.id);
|
|
28
|
+
return {
|
|
29
|
+
...worksheet,
|
|
30
|
+
...worksheetRef,
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
}
|
package/docs/api/README.md
CHANGED
|
@@ -80,6 +80,7 @@
|
|
|
80
80
|
| [getWorkbookTableBodyVisibleRange](getWorkbookTableBodyVisibleRange.md) | Retrieve the visible data body range of a table. |
|
|
81
81
|
| [getWorkbookTableHeaderRange](getWorkbookTableHeaderRange.md) | Retrieve the header row range of a table. |
|
|
82
82
|
| [getWorkbookVisibleRange](getWorkbookVisibleRange.md) | Retrieve the visible view of a range. |
|
|
83
|
+
| [getWorkbookWorksheetByName](getWorkbookWorksheetByName.md) | Retrieve a worksheet by its name from a workbook. |
|
|
83
84
|
| [getWorkbookWorksheetRange](getWorkbookWorksheetRange.md) | Fetch a range. |
|
|
84
85
|
| [getWorkbookWorksheetUsedRange](getWorkbookWorksheetUsedRange.md) | Retrieve the used range in a worksheet, ignoring trailing rows and columns that are blank. |
|
|
85
86
|
| [getWorkbookWorksheetUsedRangeRef](getWorkbookWorksheetUsedRangeRef.md) | Retrieve the address of the used range in a worksheet, ignoring trailing rows and columns that are blank. |
|
|
@@ -154,7 +155,7 @@
|
|
|
154
155
|
| [createWorkbookAndStartSession](createWorkbookAndStartSession.md) | Create a new workbook and open a session for that workbook. |
|
|
155
156
|
| [deleteDriveItemWithRetry](deleteDriveItemWithRetry.md) | Delete a drive item, avoiding locking issues through automatic retries. |
|
|
156
157
|
| [downloadDriveItemContent](downloadDriveItemContent.md) | Download a drive item and save it to the local disk. |
|
|
157
|
-
| [getWorkbookWorksheetByName](getWorkbookWorksheetByName.md) | Get a worksheet by its name. |
|
|
158
|
+
| [getWorkbookWorksheetByName](getWorkbookWorksheetByName-1.md) | Get a worksheet by its name. |
|
|
158
159
|
| [listDriveItems](listDriveItems.md) | List drive items in a drive or a drive item. |
|
|
159
160
|
| [readWorkbookRows](readWorkbookRows.md) | Iterates over the rows in a given worksheet range. |
|
|
160
161
|
| [safeDeleteWorkbook](safeDeleteWorkbook.md) | Safely delete a workbook by first closing any open sessions and then deleting it. |
|
|
@@ -10,7 +10,7 @@ Create a new worksheet in a workbook, optionally with a defined name.
|
|
|
10
10
|
|
|
11
11
|
> **createWorkbookWorksheet**(`workbookRef`, `name?`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
|
|
12
12
|
|
|
13
|
-
Defined in: [src/operations/workbookWorksheet/createWorkbookWorksheet.ts:
|
|
13
|
+
Defined in: [src/operations/workbookWorksheet/createWorkbookWorksheet.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookWorksheet/createWorkbookWorksheet.ts#L23)
|
|
14
14
|
|
|
15
15
|
Create a new worksheet in a workbook, optionally with a defined name.
|
|
16
16
|
|
|
@@ -30,3 +30,7 @@ The newly created worksheet.
|
|
|
30
30
|
#### See
|
|
31
31
|
|
|
32
32
|
https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add
|
|
33
|
+
|
|
34
|
+
#### Remarks
|
|
35
|
+
|
|
36
|
+
While `createWorkbookWorksheet` returns a reference to the worksheet, `getWorkbookWorksheetByName` and `listWorkbookWorksheets` may be unable to see the worksheet for a number of seconds. Calling `calculateWorkbook` can hasten the availability of the new worksheet for these operations.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
[Microsoft Graph SDK](README.md) / getWorkbookWorksheetByName
|
|
2
|
+
|
|
3
|
+
# getWorkbookWorksheetByName
|
|
4
|
+
|
|
5
|
+
Get a worksheet by its name.
|
|
6
|
+
|
|
7
|
+
## Functions
|
|
8
|
+
|
|
9
|
+
### getWorkbookWorksheetByName()
|
|
10
|
+
|
|
11
|
+
> **getWorkbookWorksheetByName**(`workbookRef`, `name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
|
|
12
|
+
|
|
13
|
+
Defined in: [src/tasks/getWorkbookWorksheetByName.ts:21](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/getWorkbookWorksheetByName.ts#L21)
|
|
14
|
+
|
|
15
|
+
Get a worksheet by its name.
|
|
16
|
+
|
|
17
|
+
#### Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| ------ | ------ | ------ |
|
|
21
|
+
| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | A reference to the workbook containing the worksheet. |
|
|
22
|
+
| `name` | `string` | The name of the worksheet to retrieve. |
|
|
23
|
+
|
|
24
|
+
#### Returns
|
|
25
|
+
|
|
26
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
|
|
27
|
+
|
|
28
|
+
Worksheet
|
|
29
|
+
|
|
30
|
+
#### Throws
|
|
31
|
+
|
|
32
|
+
[NotFoundError](NotFoundError.md) If the worksheet with the specified name is not found.
|
|
@@ -2,31 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
# getWorkbookWorksheetByName
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Retrieve a worksheet by its name from a workbook.
|
|
6
6
|
|
|
7
7
|
## Functions
|
|
8
8
|
|
|
9
9
|
### getWorkbookWorksheetByName()
|
|
10
10
|
|
|
11
|
-
> **getWorkbookWorksheetByName**(`workbookRef`, `
|
|
11
|
+
> **getWorkbookWorksheetByName**(`workbookRef`, `worksheetName`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
|
|
12
12
|
|
|
13
|
-
Defined in:
|
|
13
|
+
Defined in: src/operations/workbookWorksheet/getWorkbookWorksheetByName.ts:22
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Retrieve a worksheet by its name from a workbook.
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
19
19
|
| Parameter | Type | Description |
|
|
20
20
|
| ------ | ------ | ------ |
|
|
21
|
-
| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) |
|
|
22
|
-
| `
|
|
21
|
+
| `workbookRef` | [`WorkbookRef`](Workbook.md#workbookref) | Reference to the workbook. |
|
|
22
|
+
| `worksheetName` | [`WorkbookWorksheetName`](WorkbookWorksheet-1.md#workbookworksheetname) | The name of the worksheet to retrieve. |
|
|
23
23
|
|
|
24
24
|
#### Returns
|
|
25
25
|
|
|
26
|
-
[`
|
|
26
|
+
[`GraphOperation`](GraphOperation.md#graphoperation)\<`WorkbookWorksheet` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object` & `object`\>
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
The worksheet object.
|
|
29
29
|
|
|
30
|
-
####
|
|
30
|
+
#### See
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
https://learn.microsoft.com/en-us/graph/api/worksheet-get
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "microsoft-graph",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.26.0",
|
|
4
4
|
"description": "Microsoft GraphAPI SDK for NodeJS",
|
|
5
5
|
"main": "./dist/cjs/index.js",
|
|
6
6
|
"module": "./dist/esm/index.js",
|
|
@@ -2232,6 +2232,31 @@
|
|
|
2232
2232
|
"require": "./dist/cjs/operations/workbookWorksheet/deleteWorkbookWorksheet.js",
|
|
2233
2233
|
"types": "./dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts"
|
|
2234
2234
|
},
|
|
2235
|
+
"./getWorkbookWorksheetByName": {
|
|
2236
|
+
"import": "./dist/esm/tasks/getWorkbookWorksheetByName.js",
|
|
2237
|
+
"require": "./dist/cjs/tasks/getWorkbookWorksheetByName.js",
|
|
2238
|
+
"types": "./dist/esm/tasks/getWorkbookWorksheetByName.d.ts"
|
|
2239
|
+
},
|
|
2240
|
+
"./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js": {
|
|
2241
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2242
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2243
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2244
|
+
},
|
|
2245
|
+
"./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName": {
|
|
2246
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2247
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2248
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2249
|
+
},
|
|
2250
|
+
"./operations/workbookWorksheet/getWorkbookWorksheetByName": {
|
|
2251
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2252
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2253
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2254
|
+
},
|
|
2255
|
+
"./operations/workbookWorksheet/getWorkbookWorksheetByName.js": {
|
|
2256
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2257
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2258
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2259
|
+
},
|
|
2235
2260
|
"./getWorkbookWorksheetUsedRange": {
|
|
2236
2261
|
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js",
|
|
2237
2262
|
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js",
|
|
@@ -3182,11 +3207,6 @@
|
|
|
3182
3207
|
"require": "./dist/cjs/tasks/getWorkbookTableVisibleBody.js",
|
|
3183
3208
|
"types": "./dist/esm/tasks/getWorkbookTableVisibleBody.d.ts"
|
|
3184
3209
|
},
|
|
3185
|
-
"./getWorkbookWorksheetByName": {
|
|
3186
|
-
"import": "./dist/esm/tasks/getWorkbookWorksheetByName.js",
|
|
3187
|
-
"require": "./dist/cjs/tasks/getWorkbookWorksheetByName.js",
|
|
3188
|
-
"types": "./dist/esm/tasks/getWorkbookWorksheetByName.d.ts"
|
|
3189
|
-
},
|
|
3190
3210
|
"./dist/cjs/tasks/getWorkbookWorksheetByName.js": {
|
|
3191
3211
|
"import": "./dist/esm/tasks/getWorkbookWorksheetByName.js",
|
|
3192
3212
|
"require": "./dist/cjs/tasks/getWorkbookWorksheetByName.js",
|