microsoft-graph 2.25.0 → 2.27.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/models/Cell.d.ts +1 -3
- package/dist/cjs/models/Cell.d.ts.map +1 -1
- package/dist/cjs/models/DataSource.d.ts +27 -0
- package/dist/cjs/models/DataSource.d.ts.map +1 -0
- package/dist/cjs/models/DataSource.js +2 -0
- 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/cjs/services/addressManipulation.d.ts.map +1 -1
- package/dist/cjs/services/addressManipulation.js +2 -1
- package/dist/cjs/services/cartesianAddress.js +2 -2
- package/dist/cjs/services/dataSource.d.ts +58 -0
- package/dist/cjs/services/dataSource.d.ts.map +1 -0
- package/dist/cjs/services/dataSource.js +177 -0
- package/dist/cjs/tasks/deleteDriveItemWithRetry.d.ts +1 -0
- package/dist/cjs/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
- package/dist/cjs/tasks/deleteDriveItemWithRetry.js +1 -0
- package/dist/cjs/tasks/setColumnHidden.d.ts +5 -0
- package/dist/cjs/tasks/setColumnHidden.d.ts.map +1 -1
- package/dist/cjs/tasks/setColumnHidden.js +5 -0
- package/dist/cjs/tasks/setRowHidden.d.ts +5 -0
- package/dist/cjs/tasks/setRowHidden.d.ts.map +1 -1
- package/dist/cjs/tasks/setRowHidden.js +5 -0
- package/dist/cjs/tasks/setWorkbookRangeValues.d.ts +7 -2
- package/dist/cjs/tasks/setWorkbookRangeValues.d.ts.map +1 -1
- package/dist/cjs/tasks/setWorkbookRangeValues.js +7 -2
- package/dist/esm/models/Cell.d.ts +1 -3
- package/dist/esm/models/Cell.d.ts.map +1 -1
- package/dist/esm/models/DataSource.d.ts +27 -0
- package/dist/esm/models/DataSource.d.ts.map +1 -0
- package/dist/esm/models/DataSource.js +1 -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/dist/esm/services/addressManipulation.d.ts.map +1 -1
- package/dist/esm/services/addressManipulation.js +2 -1
- package/dist/esm/services/cartesianAddress.js +2 -2
- package/dist/esm/services/dataSource.d.ts +58 -0
- package/dist/esm/services/dataSource.d.ts.map +1 -0
- package/dist/esm/services/dataSource.js +166 -0
- package/dist/esm/tasks/deleteDriveItemWithRetry.d.ts +1 -0
- package/dist/esm/tasks/deleteDriveItemWithRetry.d.ts.map +1 -1
- package/dist/esm/tasks/deleteDriveItemWithRetry.js +1 -0
- package/dist/esm/tasks/setColumnHidden.d.ts +5 -0
- package/dist/esm/tasks/setColumnHidden.d.ts.map +1 -1
- package/dist/esm/tasks/setColumnHidden.js +5 -0
- package/dist/esm/tasks/setRowHidden.d.ts +5 -0
- package/dist/esm/tasks/setRowHidden.d.ts.map +1 -1
- package/dist/esm/tasks/setRowHidden.js +5 -0
- package/dist/esm/tasks/setWorkbookRangeValues.d.ts +7 -2
- package/dist/esm/tasks/setWorkbookRangeValues.d.ts.map +1 -1
- package/dist/esm/tasks/setWorkbookRangeValues.js +7 -2
- package/docs/api/Cell.md +3 -9
- package/docs/api/README.md +6 -5
- package/docs/api/addressManipulation.md +3 -3
- package/docs/api/createWorkbookWorksheet.md +5 -1
- package/docs/api/getWorkbookWorksheetByName-1.md +32 -0
- package/docs/api/getWorkbookWorksheetByName.md +10 -10
- package/docs/api/models/DataSource.md +161 -0
- package/docs/api/services/dataSource.md +200 -0
- package/docs/api/{tasks/setColumnHidden.md → setColumnHidden.md} +6 -4
- package/docs/api/{tasks/setRowHidden.md → setRowHidden.md} +6 -4
- package/docs/topics/README.md +2 -1
- package/docs/topics/versioning.md +17 -0
- package/package.json +76 -6
- package/docs/api/deleteDriveItemWithRetry.md +0 -33
- package/docs/api/tasks/setWorkbookRangeValues.md +0 -3
|
@@ -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: [src/
|
|
13
|
+
Defined in: [src/operations/workbookWorksheet/getWorkbookWorksheetByName.ts:22](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbookWorksheet/getWorkbookWorksheetByName.ts#L22)
|
|
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
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
[Microsoft Graph SDK](../README.md) / models/DataSource
|
|
2
|
+
|
|
3
|
+
# models/DataSource
|
|
4
|
+
|
|
5
|
+
## Type Aliases
|
|
6
|
+
|
|
7
|
+
### DataSource\<T\>
|
|
8
|
+
|
|
9
|
+
> **DataSource**\<`T`\> = `object` & `AsyncIterable`\<[`Item`](#item)\<`T`\>\>
|
|
10
|
+
|
|
11
|
+
Defined in: src/models/DataSource.ts:6
|
|
12
|
+
|
|
13
|
+
#### Type declaration
|
|
14
|
+
|
|
15
|
+
##### bodyOffset
|
|
16
|
+
|
|
17
|
+
> **bodyOffset**: [`RowOffset`](../Row.md#rowoffset)
|
|
18
|
+
|
|
19
|
+
##### bodyRef
|
|
20
|
+
|
|
21
|
+
> **bodyRef**: [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref)
|
|
22
|
+
|
|
23
|
+
##### coding
|
|
24
|
+
|
|
25
|
+
> **coding**: `object`
|
|
26
|
+
|
|
27
|
+
###### coding.decode
|
|
28
|
+
|
|
29
|
+
> **decode**: [`RowDecoder`](#rowdecoder)\<`T`\>
|
|
30
|
+
|
|
31
|
+
###### coding.encode
|
|
32
|
+
|
|
33
|
+
> **encode**: [`RowEncoder`](#rowencoder)\<`T`\> \| `null`
|
|
34
|
+
|
|
35
|
+
##### head
|
|
36
|
+
|
|
37
|
+
> **head**: [`ColumnName`](../Column.md#columnname)[]
|
|
38
|
+
|
|
39
|
+
#### Type Parameters
|
|
40
|
+
|
|
41
|
+
| Type Parameter |
|
|
42
|
+
| ------ |
|
|
43
|
+
| `T` *extends* [`RecordBase`](#recordbase) |
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
47
|
+
### DataSourceRow
|
|
48
|
+
|
|
49
|
+
> **DataSourceRow** = [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<[`ColumnName`](../Column.md#columnname), [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](../Cell.md#cell)\>\>
|
|
50
|
+
|
|
51
|
+
Defined in: src/models/DataSource.ts:30
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### Item\<T\>
|
|
56
|
+
|
|
57
|
+
> **Item**\<`T`\> = `object`
|
|
58
|
+
|
|
59
|
+
Defined in: src/models/DataSource.ts:23
|
|
60
|
+
|
|
61
|
+
#### Type Parameters
|
|
62
|
+
|
|
63
|
+
| Type Parameter |
|
|
64
|
+
| ------ |
|
|
65
|
+
| `T` *extends* [`RecordBase`](#recordbase) |
|
|
66
|
+
|
|
67
|
+
#### Properties
|
|
68
|
+
|
|
69
|
+
| Property | Type | Defined in |
|
|
70
|
+
| ------ | ------ | ------ |
|
|
71
|
+
| <a id="index"></a> `index` | [`ItemIndex`](#itemindex-1) | src/models/DataSource.ts:24 |
|
|
72
|
+
| <a id="record"></a> `record` | `T` | src/models/DataSource.ts:26 |
|
|
73
|
+
| <a id="rownumber"></a> `rowNumber` | [`RowNumber`](../Row.md#rownumber) | src/models/DataSource.ts:25 |
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### ItemIndex
|
|
78
|
+
|
|
79
|
+
> **ItemIndex** = `number` & `object`
|
|
80
|
+
|
|
81
|
+
Defined in: src/models/DataSource.ts:19
|
|
82
|
+
|
|
83
|
+
#### Type declaration
|
|
84
|
+
|
|
85
|
+
##### \_\_brand
|
|
86
|
+
|
|
87
|
+
> **\_\_brand**: `"ItemIndex"`
|
|
88
|
+
|
|
89
|
+
***
|
|
90
|
+
|
|
91
|
+
### RangeOperationCallback()
|
|
92
|
+
|
|
93
|
+
> **RangeOperationCallback** = (`rangeRef`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
94
|
+
|
|
95
|
+
Defined in: src/models/DataSource.ts:31
|
|
96
|
+
|
|
97
|
+
#### Parameters
|
|
98
|
+
|
|
99
|
+
| Parameter | Type |
|
|
100
|
+
| ------ | ------ |
|
|
101
|
+
| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) |
|
|
102
|
+
|
|
103
|
+
#### Returns
|
|
104
|
+
|
|
105
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### RecordBase
|
|
110
|
+
|
|
111
|
+
> **RecordBase** = [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`CellValue`](../Cell.md#cellvalue-1)\>
|
|
112
|
+
|
|
113
|
+
Defined in: src/models/DataSource.ts:29
|
|
114
|
+
|
|
115
|
+
***
|
|
116
|
+
|
|
117
|
+
### RowDecoder()\<T\>
|
|
118
|
+
|
|
119
|
+
> **RowDecoder**\<`T`\> = (`row`) => `T`
|
|
120
|
+
|
|
121
|
+
Defined in: src/models/DataSource.ts:16
|
|
122
|
+
|
|
123
|
+
#### Type Parameters
|
|
124
|
+
|
|
125
|
+
| Type Parameter |
|
|
126
|
+
| ------ |
|
|
127
|
+
| `T` *extends* [`RecordBase`](#recordbase) |
|
|
128
|
+
|
|
129
|
+
#### Parameters
|
|
130
|
+
|
|
131
|
+
| Parameter | Type |
|
|
132
|
+
| ------ | ------ |
|
|
133
|
+
| `row` | [`DataSourceRow`](#datasourcerow) |
|
|
134
|
+
|
|
135
|
+
#### Returns
|
|
136
|
+
|
|
137
|
+
`T`
|
|
138
|
+
|
|
139
|
+
***
|
|
140
|
+
|
|
141
|
+
### RowEncoder()\<T\>
|
|
142
|
+
|
|
143
|
+
> **RowEncoder**\<`T`\> = (`record`) => [`DataSourceRow`](#datasourcerow)
|
|
144
|
+
|
|
145
|
+
Defined in: src/models/DataSource.ts:17
|
|
146
|
+
|
|
147
|
+
#### Type Parameters
|
|
148
|
+
|
|
149
|
+
| Type Parameter |
|
|
150
|
+
| ------ |
|
|
151
|
+
| `T` *extends* [`RecordBase`](#recordbase) |
|
|
152
|
+
|
|
153
|
+
#### Parameters
|
|
154
|
+
|
|
155
|
+
| Parameter | Type |
|
|
156
|
+
| ------ | ------ |
|
|
157
|
+
| `record` | `T` |
|
|
158
|
+
|
|
159
|
+
#### Returns
|
|
160
|
+
|
|
161
|
+
[`DataSourceRow`](#datasourcerow)
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
[Microsoft Graph SDK](../README.md) / services/dataSource
|
|
2
|
+
|
|
3
|
+
# services/dataSource
|
|
4
|
+
|
|
5
|
+
## Functions
|
|
6
|
+
|
|
7
|
+
### createItem()
|
|
8
|
+
|
|
9
|
+
> **createItem**\<`T`\>(`source`, `record`, `after`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
|
|
10
|
+
|
|
11
|
+
Defined in: src/services/dataSource.ts:100
|
|
12
|
+
|
|
13
|
+
Creates a new item in the data source.
|
|
14
|
+
|
|
15
|
+
#### Type Parameters
|
|
16
|
+
|
|
17
|
+
| Type Parameter | Description |
|
|
18
|
+
| ------ | ------ |
|
|
19
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
20
|
+
|
|
21
|
+
#### Parameters
|
|
22
|
+
|
|
23
|
+
| Parameter | Type | Default value | Description |
|
|
24
|
+
| ------ | ------ | ------ | ------ |
|
|
25
|
+
| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | `undefined` | Data source to insert into. Must be initialized. |
|
|
26
|
+
| `record` | `T` | `undefined` | Record to insert. |
|
|
27
|
+
| `after` | `null` \| [`ItemIndex`](../models/DataSource.md#itemindex-1) | `null` | Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top. |
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
|
|
32
|
+
|
|
33
|
+
Newly created item, including its index, row number, and record.
|
|
34
|
+
|
|
35
|
+
#### Throws
|
|
36
|
+
|
|
37
|
+
If the data source is not initialized.
|
|
38
|
+
|
|
39
|
+
#### Throws
|
|
40
|
+
|
|
41
|
+
If the 'after' index is out of range.
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### dataSourceFromRange()
|
|
46
|
+
|
|
47
|
+
> **dataSourceFromRange**\<`T`\>(`rangeRef`, `decode`, `encode`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
|
|
48
|
+
|
|
49
|
+
Defined in: src/services/dataSource.ts:38
|
|
50
|
+
|
|
51
|
+
Defines a data source from a given range.
|
|
52
|
+
|
|
53
|
+
#### Type Parameters
|
|
54
|
+
|
|
55
|
+
| Type Parameter | Description |
|
|
56
|
+
| ------ | ------ |
|
|
57
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
58
|
+
|
|
59
|
+
#### Parameters
|
|
60
|
+
|
|
61
|
+
| Parameter | Type | Default value | Description |
|
|
62
|
+
| ------ | ------ | ------ | ------ |
|
|
63
|
+
| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | `undefined` | Workbook range reference to define the data source on. |
|
|
64
|
+
| `decode` | [`RowDecoder`](../models/DataSource.md#rowdecoder)\<`T`\> | `undefined` | Function to decode a row into a record. |
|
|
65
|
+
| `encode` | `null` \| [`RowEncoder`](../models/DataSource.md#rowencoder)\<`T`\> | `null` | Function to encode a record into a row. Optional. |
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
|
|
70
|
+
|
|
71
|
+
The initialized data source.
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### dataSourceFromWorksheet()
|
|
76
|
+
|
|
77
|
+
> **dataSourceFromWorksheet**\<`T`\>(`worksheetRef`, `decode`, `encode`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
|
|
78
|
+
|
|
79
|
+
Defined in: src/services/dataSource.ts:26
|
|
80
|
+
|
|
81
|
+
Define a datasource from an entire worksheet.
|
|
82
|
+
|
|
83
|
+
#### Type Parameters
|
|
84
|
+
|
|
85
|
+
| Type Parameter | Description |
|
|
86
|
+
| ------ | ------ |
|
|
87
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
88
|
+
|
|
89
|
+
#### Parameters
|
|
90
|
+
|
|
91
|
+
| Parameter | Type | Default value | Description |
|
|
92
|
+
| ------ | ------ | ------ | ------ |
|
|
93
|
+
| `worksheetRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | `undefined` | Workbook range reference to define the data source on. |
|
|
94
|
+
| `decode` | [`RowDecoder`](../models/DataSource.md#rowdecoder)\<`T`\> | `undefined` | Function to decode a row into a record. |
|
|
95
|
+
| `encode` | `null` \| [`RowEncoder`](../models/DataSource.md#rowencoder)\<`T`\> | `null` | Function to encode a record into a row. Optional. |
|
|
96
|
+
|
|
97
|
+
#### Returns
|
|
98
|
+
|
|
99
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
|
|
100
|
+
|
|
101
|
+
The initialized data source.
|
|
102
|
+
|
|
103
|
+
***
|
|
104
|
+
|
|
105
|
+
### deleteItem()
|
|
106
|
+
|
|
107
|
+
> **deleteItem**\<`T`\>(`source`, `index`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
108
|
+
|
|
109
|
+
Defined in: src/services/dataSource.ts:145
|
|
110
|
+
|
|
111
|
+
Deletes an item from the data source at the specified index.
|
|
112
|
+
|
|
113
|
+
#### Type Parameters
|
|
114
|
+
|
|
115
|
+
| Type Parameter | Description |
|
|
116
|
+
| ------ | ------ |
|
|
117
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
118
|
+
|
|
119
|
+
#### Parameters
|
|
120
|
+
|
|
121
|
+
| Parameter | Type | Description |
|
|
122
|
+
| ------ | ------ | ------ |
|
|
123
|
+
| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to delete from. Must be initialized. |
|
|
124
|
+
| `index` | [`ItemIndex`](../models/DataSource.md#itemindex-1) | Index of the item to delete. |
|
|
125
|
+
|
|
126
|
+
#### Returns
|
|
127
|
+
|
|
128
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
129
|
+
|
|
130
|
+
#### Throws
|
|
131
|
+
|
|
132
|
+
If the data source is not initialized.
|
|
133
|
+
|
|
134
|
+
***
|
|
135
|
+
|
|
136
|
+
### ~~listItems()~~
|
|
137
|
+
|
|
138
|
+
> **listItems**\<`T`\>(`source`): `AsyncIterable`\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
|
|
139
|
+
|
|
140
|
+
Defined in: src/services/dataSource.ts:84
|
|
141
|
+
|
|
142
|
+
Reads all items from the data source.
|
|
143
|
+
|
|
144
|
+
#### Type Parameters
|
|
145
|
+
|
|
146
|
+
| Type Parameter | Description |
|
|
147
|
+
| ------ | ------ |
|
|
148
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
149
|
+
|
|
150
|
+
#### Parameters
|
|
151
|
+
|
|
152
|
+
| Parameter | Type | Description |
|
|
153
|
+
| ------ | ------ | ------ |
|
|
154
|
+
| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to read from. |
|
|
155
|
+
|
|
156
|
+
#### Returns
|
|
157
|
+
|
|
158
|
+
`AsyncIterable`\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
|
|
159
|
+
|
|
160
|
+
Array of all items in the data source.
|
|
161
|
+
|
|
162
|
+
#### Deprecated
|
|
163
|
+
|
|
164
|
+
Iterate on the source directly using `for await (const item of source)`.
|
|
165
|
+
|
|
166
|
+
***
|
|
167
|
+
|
|
168
|
+
### updateItem()
|
|
169
|
+
|
|
170
|
+
> **updateItem**\<`T`\>(`source`, `index`, `record`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
171
|
+
|
|
172
|
+
Defined in: src/services/dataSource.ts:127
|
|
173
|
+
|
|
174
|
+
Updates an item in the data source at the specified index.
|
|
175
|
+
|
|
176
|
+
#### Type Parameters
|
|
177
|
+
|
|
178
|
+
| Type Parameter | Description |
|
|
179
|
+
| ------ | ------ |
|
|
180
|
+
| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
|
|
181
|
+
|
|
182
|
+
#### Parameters
|
|
183
|
+
|
|
184
|
+
| Parameter | Type | Description |
|
|
185
|
+
| ------ | ------ | ------ |
|
|
186
|
+
| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to update. Must be initialized. |
|
|
187
|
+
| `index` | [`ItemIndex`](../models/DataSource.md#itemindex-1) | Index of the item to update. |
|
|
188
|
+
| `record` | `T` | New record to write at the specified index. |
|
|
189
|
+
|
|
190
|
+
#### Returns
|
|
191
|
+
|
|
192
|
+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
193
|
+
|
|
194
|
+
#### Throws
|
|
195
|
+
|
|
196
|
+
If the data source is not initialized.
|
|
197
|
+
|
|
198
|
+
#### Throws
|
|
199
|
+
|
|
200
|
+
If the index is out of range.
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
[Microsoft Graph SDK](
|
|
1
|
+
[Microsoft Graph SDK](README.md) / setColumnHidden
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# setColumnHidden
|
|
4
|
+
|
|
5
|
+
Set one or more columns visibility.
|
|
4
6
|
|
|
5
7
|
## Functions
|
|
6
8
|
|
|
@@ -8,7 +10,7 @@
|
|
|
8
10
|
|
|
9
11
|
> **setColumnHidden**(`rangeRef`, `hidden`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
10
12
|
|
|
11
|
-
Defined in: [src/tasks/setColumnHidden.ts:
|
|
13
|
+
Defined in: [src/tasks/setColumnHidden.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/setColumnHidden.ts#L16)
|
|
12
14
|
|
|
13
15
|
Set one or more columns visibility.
|
|
14
16
|
|
|
@@ -16,7 +18,7 @@ Set one or more columns visibility.
|
|
|
16
18
|
|
|
17
19
|
| Parameter | Type | Description |
|
|
18
20
|
| ------ | ------ | ------ |
|
|
19
|
-
| `rangeRef` | [`WorkbookRangeRef`](
|
|
21
|
+
| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the workbook range representing the columns to hide or show. |
|
|
20
22
|
| `hidden` | `boolean` | Boolean indicating whether to hide (`true`) or show (`false`) the columns. |
|
|
21
23
|
|
|
22
24
|
#### Returns
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
[Microsoft Graph SDK](
|
|
1
|
+
[Microsoft Graph SDK](README.md) / setRowHidden
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# setRowHidden
|
|
4
|
+
|
|
5
|
+
Set one or more rows visibility.
|
|
4
6
|
|
|
5
7
|
## Functions
|
|
6
8
|
|
|
@@ -8,7 +10,7 @@
|
|
|
8
10
|
|
|
9
11
|
> **setRowHidden**(`rangeRef`, `hidden`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
10
12
|
|
|
11
|
-
Defined in: [src/tasks/setRowHidden.ts:
|
|
13
|
+
Defined in: [src/tasks/setRowHidden.ts:17](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/setRowHidden.ts#L17)
|
|
12
14
|
|
|
13
15
|
Set one or more rows visibility.
|
|
14
16
|
|
|
@@ -16,7 +18,7 @@ Set one or more rows visibility.
|
|
|
16
18
|
|
|
17
19
|
| Parameter | Type | Description |
|
|
18
20
|
| ------ | ------ | ------ |
|
|
19
|
-
| `rangeRef` | [`WorkbookRangeRef`](
|
|
21
|
+
| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the workbook range representing the rows to hide or show. |
|
|
20
22
|
| `hidden` | `boolean` | Boolean indicating whether to hide (`true`) or show (`false`) the rows. |
|
|
21
23
|
|
|
22
24
|
#### Returns
|
package/docs/topics/README.md
CHANGED
|
@@ -11,4 +11,5 @@ This section provides in-depth guides and explanations for key concepts, workaro
|
|
|
11
11
|
- [Handling Locked Workbooks](./lockedWorkbook.md): Strategies for dealing with "resource is locked" errors.
|
|
12
12
|
- [Performance](./performance.md): Tips for optimizing performance, including batching and session management.
|
|
13
13
|
- [Pivot Tables](./pivotTables.md): Current limitations and workarounds for pivot table support.
|
|
14
|
-
- [Request Retrying](./retrying.md): How the SDK handles Graph API throttling and automatic retries.
|
|
14
|
+
- [Request Retrying](./retrying.md): How the SDK handles Graph API throttling and automatic retries.
|
|
15
|
+
- [Versioning](./versioning.md): What version numbers mean.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Versioning
|
|
2
|
+
|
|
3
|
+
Each release of this library has a version in the format `{major}.{minor}.{patch}`
|
|
4
|
+
|
|
5
|
+
| Part | When incremented |
|
|
6
|
+
| --------- | ----------------- |
|
|
7
|
+
| `{patch}` | bug fix |
|
|
8
|
+
| `{minor}` | new functionality |
|
|
9
|
+
| `{major}` | breaking change |
|
|
10
|
+
|
|
11
|
+
So upgrading from `2.30.0` to `2.30.1` is a bug fix, upgrading from `2.30.1` to `2.31.0` is a new feature (but not a breaking change), but upgrading from `2.31.0` to `3.0.1` involves a breaking change.
|
|
12
|
+
|
|
13
|
+
This applies since 2.26.0.
|
|
14
|
+
|
|
15
|
+
## Versioning pinning
|
|
16
|
+
It is recommended therefore either pin to `{major}` or `{major}.{minor}` to still receive critical updates without receiving breaking changes.
|
|
17
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "microsoft-graph",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.27.0",
|
|
4
4
|
"description": "Microsoft GraphAPI SDK for NodeJS",
|
|
5
5
|
"main": "./dist/cjs/index.js",
|
|
6
6
|
"module": "./dist/esm/index.js",
|
|
@@ -557,6 +557,31 @@
|
|
|
557
557
|
"require": "./dist/cjs/models/Context.js",
|
|
558
558
|
"types": "./dist/esm/models/Context.d.ts"
|
|
559
559
|
},
|
|
560
|
+
"./DataSource": {
|
|
561
|
+
"import": "./dist/esm/models/DataSource.js",
|
|
562
|
+
"require": "./dist/cjs/models/DataSource.js",
|
|
563
|
+
"types": "./dist/esm/models/DataSource.d.ts"
|
|
564
|
+
},
|
|
565
|
+
"./dist/cjs/models/DataSource.js": {
|
|
566
|
+
"import": "./dist/esm/models/DataSource.js",
|
|
567
|
+
"require": "./dist/cjs/models/DataSource.js",
|
|
568
|
+
"types": "./dist/esm/models/DataSource.d.ts"
|
|
569
|
+
},
|
|
570
|
+
"./dist/cjs/models/DataSource": {
|
|
571
|
+
"import": "./dist/esm/models/DataSource.js",
|
|
572
|
+
"require": "./dist/cjs/models/DataSource.js",
|
|
573
|
+
"types": "./dist/esm/models/DataSource.d.ts"
|
|
574
|
+
},
|
|
575
|
+
"./models/DataSource": {
|
|
576
|
+
"import": "./dist/esm/models/DataSource.js",
|
|
577
|
+
"require": "./dist/cjs/models/DataSource.js",
|
|
578
|
+
"types": "./dist/esm/models/DataSource.d.ts"
|
|
579
|
+
},
|
|
580
|
+
"./models/DataSource.js": {
|
|
581
|
+
"import": "./dist/esm/models/DataSource.js",
|
|
582
|
+
"require": "./dist/cjs/models/DataSource.js",
|
|
583
|
+
"types": "./dist/esm/models/DataSource.d.ts"
|
|
584
|
+
},
|
|
560
585
|
"./Drive": {
|
|
561
586
|
"import": "./dist/esm/models/Drive.js",
|
|
562
587
|
"require": "./dist/cjs/models/Drive.js",
|
|
@@ -2232,6 +2257,31 @@
|
|
|
2232
2257
|
"require": "./dist/cjs/operations/workbookWorksheet/deleteWorkbookWorksheet.js",
|
|
2233
2258
|
"types": "./dist/esm/operations/workbookWorksheet/deleteWorkbookWorksheet.d.ts"
|
|
2234
2259
|
},
|
|
2260
|
+
"./getWorkbookWorksheetByName": {
|
|
2261
|
+
"import": "./dist/esm/tasks/getWorkbookWorksheetByName.js",
|
|
2262
|
+
"require": "./dist/cjs/tasks/getWorkbookWorksheetByName.js",
|
|
2263
|
+
"types": "./dist/esm/tasks/getWorkbookWorksheetByName.d.ts"
|
|
2264
|
+
},
|
|
2265
|
+
"./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js": {
|
|
2266
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2267
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2268
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2269
|
+
},
|
|
2270
|
+
"./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName": {
|
|
2271
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2272
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2273
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2274
|
+
},
|
|
2275
|
+
"./operations/workbookWorksheet/getWorkbookWorksheetByName": {
|
|
2276
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2277
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2278
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2279
|
+
},
|
|
2280
|
+
"./operations/workbookWorksheet/getWorkbookWorksheetByName.js": {
|
|
2281
|
+
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2282
|
+
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetByName.js",
|
|
2283
|
+
"types": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetByName.d.ts"
|
|
2284
|
+
},
|
|
2235
2285
|
"./getWorkbookWorksheetUsedRange": {
|
|
2236
2286
|
"import": "./dist/esm/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js",
|
|
2237
2287
|
"require": "./dist/cjs/operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js",
|
|
@@ -2532,6 +2582,31 @@
|
|
|
2532
2582
|
"require": "./dist/cjs/services/context.js",
|
|
2533
2583
|
"types": "./dist/esm/services/context.d.ts"
|
|
2534
2584
|
},
|
|
2585
|
+
"./dataSource": {
|
|
2586
|
+
"import": "./dist/esm/services/dataSource.js",
|
|
2587
|
+
"require": "./dist/cjs/services/dataSource.js",
|
|
2588
|
+
"types": "./dist/esm/services/dataSource.d.ts"
|
|
2589
|
+
},
|
|
2590
|
+
"./dist/cjs/services/dataSource.js": {
|
|
2591
|
+
"import": "./dist/esm/services/dataSource.js",
|
|
2592
|
+
"require": "./dist/cjs/services/dataSource.js",
|
|
2593
|
+
"types": "./dist/esm/services/dataSource.d.ts"
|
|
2594
|
+
},
|
|
2595
|
+
"./dist/cjs/services/dataSource": {
|
|
2596
|
+
"import": "./dist/esm/services/dataSource.js",
|
|
2597
|
+
"require": "./dist/cjs/services/dataSource.js",
|
|
2598
|
+
"types": "./dist/esm/services/dataSource.d.ts"
|
|
2599
|
+
},
|
|
2600
|
+
"./services/dataSource": {
|
|
2601
|
+
"import": "./dist/esm/services/dataSource.js",
|
|
2602
|
+
"require": "./dist/cjs/services/dataSource.js",
|
|
2603
|
+
"types": "./dist/esm/services/dataSource.d.ts"
|
|
2604
|
+
},
|
|
2605
|
+
"./services/dataSource.js": {
|
|
2606
|
+
"import": "./dist/esm/services/dataSource.js",
|
|
2607
|
+
"require": "./dist/cjs/services/dataSource.js",
|
|
2608
|
+
"types": "./dist/esm/services/dataSource.d.ts"
|
|
2609
|
+
},
|
|
2535
2610
|
"./drive": {
|
|
2536
2611
|
"import": "./dist/esm/services/drive.js",
|
|
2537
2612
|
"require": "./dist/cjs/services/drive.js",
|
|
@@ -3182,11 +3257,6 @@
|
|
|
3182
3257
|
"require": "./dist/cjs/tasks/getWorkbookTableVisibleBody.js",
|
|
3183
3258
|
"types": "./dist/esm/tasks/getWorkbookTableVisibleBody.d.ts"
|
|
3184
3259
|
},
|
|
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
3260
|
"./dist/cjs/tasks/getWorkbookWorksheetByName.js": {
|
|
3191
3261
|
"import": "./dist/esm/tasks/getWorkbookWorksheetByName.js",
|
|
3192
3262
|
"require": "./dist/cjs/tasks/getWorkbookWorksheetByName.js",
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
[Microsoft Graph SDK](README.md) / deleteDriveItemWithRetry
|
|
2
|
-
|
|
3
|
-
# deleteDriveItemWithRetry
|
|
4
|
-
|
|
5
|
-
Delete a drive item, avoiding locking issues through automatic retries.
|
|
6
|
-
|
|
7
|
-
## Functions
|
|
8
|
-
|
|
9
|
-
### ~~deleteDriveItemWithRetry()~~
|
|
10
|
-
|
|
11
|
-
> **deleteDriveItemWithRetry**(`driveItemRef`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
12
|
-
|
|
13
|
-
Defined in: [src/tasks/deleteDriveItemWithRetry.ts:18](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/deleteDriveItemWithRetry.ts#L18)
|
|
14
|
-
|
|
15
|
-
Delete a drive item, avoiding locking issues through automatic retries.
|
|
16
|
-
|
|
17
|
-
#### Parameters
|
|
18
|
-
|
|
19
|
-
| Parameter | Type | Description |
|
|
20
|
-
| ------ | ------ | ------ |
|
|
21
|
-
| `driveItemRef` | [`DriveItemRef`](DriveItem-1.md#driveitemref) | Reference to the DriveItem to delete. |
|
|
22
|
-
|
|
23
|
-
#### Returns
|
|
24
|
-
|
|
25
|
-
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
|
|
26
|
-
|
|
27
|
-
#### Remarks
|
|
28
|
-
|
|
29
|
-
This function attempts to delete the drive item up to three times with increasing delays (1s, 2s, 4s) in case of failure.
|
|
30
|
-
|
|
31
|
-
#### Deprecated
|
|
32
|
-
|
|
33
|
-
Use `deleteDriveItem` directly as this is now handled by the lowest level API
|