@types/office-js-preview 1.0.454 → 1.0.455

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.
@@ -350,11 +350,11 @@ declare namespace Office {
350
350
  */
351
351
  enum VisibilityMode {
352
352
  /**
353
- * UI is Hidden
353
+ * UI is hidden.
354
354
  */
355
355
  hidden = 'Hidden',
356
356
  /**
357
- * Displayed as taskpane
357
+ * Displayed as a task pane.
358
358
  */
359
359
  taskpane = 'Taskpane',
360
360
  }
@@ -117927,234 +117927,228 @@ declare namespace OneNote {
117927
117927
 
117928
117928
  declare namespace Visio {
117929
117929
  /**
117930
- *
117931
117930
  * Provides information about the shape that raised the ShapeMouseEnter event.
117932
117931
  *
117932
+ * @remarks
117933
117933
  * [Api set: 1.1]
117934
117934
  */
117935
117935
  interface ShapeMouseEnterEventArgs {
117936
117936
  /**
117937
- *
117938
117937
  * Gets the name of the page which has the shape object that raised the ShapeMouseEnter event.
117939
117938
  *
117939
+ * @remarks
117940
117940
  * [Api set: 1.1]
117941
117941
  */
117942
117942
  pageName: string;
117943
117943
  /**
117944
- *
117945
117944
  * Gets the name of the shape object that raised the ShapeMouseEnter event.
117946
117945
  *
117946
+ * @remarks
117947
117947
  * [Api set: 1.1]
117948
117948
  */
117949
117949
  shapeName: string;
117950
117950
  }
117951
117951
  /**
117952
- *
117953
117952
  * Provides information about the shape that raised the ShapeMouseLeave event.
117954
117953
  *
117954
+ * @remarks
117955
117955
  * [Api set: 1.1]
117956
117956
  */
117957
117957
  interface ShapeMouseLeaveEventArgs {
117958
117958
  /**
117959
- *
117960
117959
  * Gets the name of the page which has the shape object that raised the ShapeMouseLeave event.
117961
117960
  *
117961
+ * @remarks
117962
117962
  * [Api set: 1.1]
117963
117963
  */
117964
117964
  pageName: string;
117965
117965
  /**
117966
- *
117967
117966
  * Gets the name of the shape object that raised the ShapeMouseLeave event.
117968
117967
  *
117968
+ * @remarks
117969
117969
  * [Api set: 1.1]
117970
117970
  */
117971
117971
  shapeName: string;
117972
117972
  }
117973
117973
  /**
117974
- *
117975
117974
  * Provides information about the page that raised the PageLoadComplete event.
117976
117975
  *
117976
+ * @remarks
117977
117977
  * [Api set: 1.1]
117978
117978
  */
117979
117979
  interface PageLoadCompleteEventArgs {
117980
117980
  /**
117981
- *
117982
117981
  * Gets the name of the page that raised the PageLoad event.
117983
117982
  *
117983
+ * @remarks
117984
117984
  * [Api set: 1.1]
117985
117985
  */
117986
117986
  pageName: string;
117987
117987
  /**
117988
- *
117989
117988
  * Gets the success or failure of the PageLoadComplete event.
117990
117989
  *
117990
+ * @remarks
117991
117991
  * [Api set: 1.1]
117992
117992
  */
117993
117993
  success: boolean;
117994
117994
  }
117995
117995
  /**
117996
- *
117997
117996
  * Provides information about the document that raised the DataRefreshComplete event.
117998
117997
  *
117998
+ * @remarks
117999
117999
  * [Api set: 1.1]
118000
118000
  */
118001
118001
  interface DataRefreshCompleteEventArgs {
118002
118002
  /**
118003
- *
118004
118003
  * Gets the document object that raised the DataRefreshComplete event.
118005
118004
  *
118005
+ * @remarks
118006
118006
  * [Api set: 1.1]
118007
118007
  */
118008
118008
  document: Visio.Document;
118009
118009
  /**
118010
- *
118011
118010
  * Gets the success or failure of the DataRefreshComplete event.
118012
118011
  *
118012
+ * @remarks
118013
118013
  * [Api set: 1.1]
118014
118014
  */
118015
118015
  success: boolean;
118016
118016
  }
118017
118017
  /**
118018
- *
118019
118018
  * Provides information about the shape collection that raised the SelectionChanged event.
118020
118019
  *
118020
+ * @remarks
118021
118021
  * [Api set: 1.1]
118022
118022
  */
118023
118023
  interface SelectionChangedEventArgs {
118024
118024
  /**
118025
- *
118026
118025
  * Gets the name of the page which has the ShapeCollection object that raised the SelectionChanged event.
118027
118026
  *
118027
+ * @remarks
118028
118028
  * [Api set: 1.1]
118029
118029
  */
118030
118030
  pageName: string;
118031
118031
  /**
118032
- *
118033
118032
  * Gets the array of shape names that raised the SelectionChanged event.
118034
118033
  *
118034
+ * @remarks
118035
118035
  * [Api set: 1.1]
118036
118036
  */
118037
118037
  shapeNames: string[];
118038
118038
  }
118039
118039
  /**
118040
- *
118041
118040
  * Provides information about the success or failure of the DocumentLoadComplete event.
118042
118041
  *
118042
+ * @remarks
118043
118043
  * [Api set: 1.1]
118044
118044
  */
118045
118045
  interface DocumentLoadCompleteEventArgs {
118046
118046
  /**
118047
- *
118048
118047
  * Gets the success or failure of the DocumentLoadComplete event.
118049
118048
  *
118049
+ * @remarks
118050
118050
  * [Api set: 1.1]
118051
118051
  */
118052
118052
  success: boolean;
118053
118053
  }
118054
118054
  /**
118055
- *
118056
118055
  * Provides information about the page that raised the PageRenderComplete event.
118057
118056
  *
118057
+ * @remarks
118058
118058
  * [Api set: 1.1]
118059
118059
  */
118060
118060
  interface PageRenderCompleteEventArgs {
118061
118061
  /**
118062
- *
118063
118062
  * Gets the name of the page that raised the PageLoad event.
118064
118063
  *
118064
+ * @remarks
118065
118065
  * [Api set: 1.1]
118066
118066
  */
118067
118067
  pageName: string;
118068
118068
  /**
118069
- *
118070
118069
  * Gets the success/failure of the PageRender event.
118071
118070
  *
118071
+ * @remarks
118072
118072
  * [Api set: 1.1]
118073
118073
  */
118074
118074
  success: boolean;
118075
118075
  }
118076
118076
  /**
118077
+ * Provides information about DocumentError event.
118077
118078
  *
118078
- * Provides information about DocumentError event
118079
- *
118079
+ * @remarks
118080
118080
  * [Api set: 1.1]
118081
118081
  */
118082
118082
  interface DocumentErrorEventArgs {
118083
118083
  /**
118084
+ * Visio Error code.
118084
118085
  *
118085
- * Visio Error code
118086
- *
118086
+ * @remarks
118087
118087
  * [Api set: 1.1]
118088
118088
  */
118089
118089
  errorCode: number;
118090
118090
  /**
118091
+ * Message about error that occurred.
118091
118092
  *
118092
- * Message about error that occured
118093
- *
118093
+ * @remarks
118094
118094
  * [Api set: 1.1]
118095
118095
  */
118096
118096
  errorMessage: string;
118097
118097
  /**
118098
- *
118099
118098
  * Tells if the error is critical or not. If critical the session cannot continue.
118100
118099
  *
118100
+ * @remarks
118101
118101
  * [Api set: 1.1]
118102
118102
  */
118103
118103
  isCritical: boolean;
118104
118104
  }
118105
118105
  /**
118106
- *
118107
118106
  * Provides information about the TaskPaneStateChanged event.
118108
118107
  *
118108
+ * @remarks
118109
118109
  * [Api set: 1.1]
118110
118110
  */
118111
118111
  interface TaskPaneStateChangedEventArgs {
118112
118112
  /**
118113
+ * Current state of the task pane.
118113
118114
  *
118114
- * Current state of the taskpane
118115
- *
118115
+ * @remarks
118116
118116
  * [Api set: 1.1]
118117
118117
  */
118118
118118
  isVisible: boolean;
118119
118119
  /**
118120
- *
118121
118120
  * Type of the TaskPane.
118122
118121
  *
118122
+ * @remarks
118123
118123
  * [Api set: 1.1]
118124
118124
  */
118125
118125
  paneType: Visio.TaskPaneType | "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings";
118126
118126
  }
118127
118127
  /**
118128
- *
118129
118128
  * Represents the Application.
118130
118129
  *
118130
+ * @remarks
118131
118131
  * [Api set: 1.1]
118132
118132
  */
118133
118133
  class Application extends OfficeExtension.ClientObject {
118134
118134
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118135
118135
  context: RequestContext;
118136
118136
  /**
118137
+ * Shows or hides the iframe application borders.
118137
118138
  *
118138
- * Show or hide the iFrame application borders.
118139
- *
118139
+ * @remarks
118140
118140
  * [Api set: 1.1]
118141
118141
  */
118142
118142
  showBorders: boolean;
118143
118143
  /**
118144
+ * Shows or hides the standard toolbars.
118144
118145
  *
118145
- * Show or hide the standard toolbars.
118146
- *
118146
+ * @remarks
118147
118147
  * [Api set: 1.1]
118148
118148
  */
118149
118149
  showToolbars: boolean;
118150
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118151
- *
118152
- * @remarks
118153
- *
118154
- * This method has the following additional signature:
118155
- *
118156
- * `set(properties: Visio.Application): void`
118157
- *
118150
+ /**
118151
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118158
118152
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118159
118153
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118160
118154
  */
@@ -118162,23 +118156,23 @@ declare namespace Visio {
118162
118156
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118163
118157
  set(properties: Visio.Application): void;
118164
118158
  /**
118165
- *
118166
118159
  * Sets the visibility of a specific toolbar in the application.
118167
118160
  *
118161
+ * @remarks
118168
118162
  * [Api set: 1.1]
118169
118163
  *
118170
- * @param id The type of the Toolbar
118171
- * @param show Whether the toolbar is visibile or not.
118164
+ * @param id The type of the Toolbar.
118165
+ * @param show Whether the toolbar is visible or not.
118172
118166
  */
118173
118167
  showToolbar(id: Visio.ToolBarType, show: boolean): void;
118174
118168
  /**
118175
- *
118176
118169
  * Sets the visibility of a specific toolbar in the application.
118177
118170
  *
118171
+ * @remarks
118178
118172
  * [Api set: 1.1]
118179
118173
  *
118180
- * @param id The type of the Toolbar
118181
- * @param show Whether the toolbar is visibile or not.
118174
+ * @param id The type of the Toolbar.
118175
+ * @param show Whether the toolbar is visible or not.
118182
118176
  */
118183
118177
  showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;
118184
118178
  /**
@@ -118213,43 +118207,37 @@ declare namespace Visio {
118213
118207
  setMockData(data: Visio.Interfaces.ApplicationData): void;
118214
118208
  }
118215
118209
  /**
118216
- *
118217
118210
  * Represents the Document class.
118218
118211
  *
118212
+ * @remarks
118219
118213
  * [Api set: 1.1]
118220
118214
  */
118221
118215
  class Document extends OfficeExtension.ClientObject {
118222
118216
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118223
118217
  context: RequestContext;
118224
118218
  /**
118219
+ * Represents a Visio application instance that contains this document.
118225
118220
  *
118226
- * Represents a Visio application instance that contains this document. Read-only.
118227
- *
118221
+ * @remarks
118228
118222
  * [Api set: 1.1]
118229
118223
  */
118230
118224
  readonly application: Visio.Application;
118231
118225
  /**
118226
+ * Represents a collection of pages associated with the document.
118232
118227
  *
118233
- * Represents a collection of pages associated with the document. Read-only.
118234
- *
118228
+ * @remarks
118235
118229
  * [Api set: 1.1]
118236
118230
  */
118237
118231
  readonly pages: Visio.PageCollection;
118238
118232
  /**
118233
+ * Returns the DocumentView object.
118239
118234
  *
118240
- * Returns the DocumentView object. Read-only.
118241
- *
118235
+ * @remarks
118242
118236
  * [Api set: 1.1]
118243
118237
  */
118244
118238
  readonly view: Visio.DocumentView;
118245
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118246
- *
118247
- * @remarks
118248
- *
118249
- * This method has the following additional signature:
118250
- *
118251
- * `set(properties: Visio.Document): void`
118252
- *
118239
+ /**
118240
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118253
118241
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118254
118242
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118255
118243
  */
@@ -118257,49 +118245,49 @@ declare namespace Visio {
118257
118245
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118258
118246
  set(properties: Visio.Document): void;
118259
118247
  /**
118260
- *
118261
118248
  * Returns the Active Page of the document.
118262
118249
  *
118250
+ * @remarks
118263
118251
  * [Api set: 1.1]
118264
118252
  */
118265
118253
  getActivePage(): Visio.Page;
118266
118254
  /**
118267
- *
118268
118255
  * Set the Active Page of the document.
118269
118256
  *
118257
+ * @remarks
118270
118258
  * [Api set: 1.1]
118271
118259
  *
118272
118260
  * @param PageName Name of the page
118273
118261
  */
118274
118262
  setActivePage(PageName: string): void;
118275
118263
  /**
118264
+ * Shows or hides a TaskPane.
118265
+ This will be consumed by the DV Excel Add-In/Other third-party apps who embed the Visio drawing to show/hide the task pane.
118276
118266
  *
118277
- * Show or Hide a TaskPane.
118278
- This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
118279
- *
118267
+ * @remarks
118280
118268
  * [Api set: 1.1]
118281
118269
  *
118282
118270
  * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
118283
- * @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
118284
- * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
118271
+ * @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
118272
+ * @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
118285
118273
  */
118286
118274
  showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;
118287
118275
  /**
118276
+ * Shows or hides a TaskPane.
118277
+ This will be consumed by the DV Excel Add-In/Other third-party apps who embed the Visio drawing to show/hide the task pane.
118288
118278
  *
118289
- * Show or Hide a TaskPane.
118290
- This will be consumed by the DV Excel Add-In/Other third-party apps who embed the visio drawing to show/hide the task pane.
118291
- *
118279
+ * @remarks
118292
118280
  * [Api set: 1.1]
118293
118281
  *
118294
118282
  * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
118295
- * @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the Taskpane
118296
- * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
118283
+ * @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
118284
+ * @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
118297
118285
  */
118298
118286
  showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
118299
118287
  /**
118300
- *
118301
118288
  * Triggers the refresh of the data in the Diagram, for all pages.
118302
118289
  *
118290
+ * @remarks
118303
118291
  * [Api set: 1.1]
118304
118292
  */
118305
118293
  startDataRefresh(): void;
@@ -118325,72 +118313,72 @@ declare namespace Visio {
118325
118313
  expand?: string;
118326
118314
  }): Visio.Document;
118327
118315
  /**
118328
- *
118329
118316
  * Occurs when the data is refreshed in the diagram.
118330
118317
  *
118318
+ * @remarks
118331
118319
  * [Api set: 1.1]
118332
118320
  *
118333
118321
  * @eventproperty
118334
118322
  */
118335
118323
  readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
118336
118324
  /**
118325
+ * Occurs when there is an expected or unexpected error occurred in the session.
118337
118326
  *
118338
- * Occurs when there is an expected or unexpected error occured in the session.
118339
- *
118327
+ * @remarks
118340
118328
  * [Api set: 1.1]
118341
118329
  *
118342
118330
  * @eventproperty
118343
118331
  */
118344
118332
  readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;
118345
118333
  /**
118346
- *
118347
118334
  * Occurs when the Document is loaded, refreshed, or changed.
118348
118335
  *
118336
+ * @remarks
118349
118337
  * [Api set: 1.1]
118350
118338
  *
118351
118339
  * @eventproperty
118352
118340
  */
118353
118341
  readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;
118354
118342
  /**
118355
- *
118356
118343
  * Occurs when the page is finished loading.
118357
118344
  *
118345
+ * @remarks
118358
118346
  * [Api set: 1.1]
118359
118347
  *
118360
118348
  * @eventproperty
118361
118349
  */
118362
118350
  readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;
118363
118351
  /**
118364
- *
118365
118352
  * Occurs when the current selection of shapes changes.
118366
118353
  *
118354
+ * @remarks
118367
118355
  * [Api set: 1.1]
118368
118356
  *
118369
118357
  * @eventproperty
118370
118358
  */
118371
118359
  readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;
118372
118360
  /**
118373
- *
118374
118361
  * Occurs when the user moves the mouse pointer into the bounding box of a shape.
118375
118362
  *
118363
+ * @remarks
118376
118364
  * [Api set: 1.1]
118377
118365
  *
118378
118366
  * @eventproperty
118379
118367
  */
118380
118368
  readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;
118381
118369
  /**
118382
- *
118383
118370
  * Occurs when the user moves the mouse out of the bounding box of a shape.
118384
118371
  *
118372
+ * @remarks
118385
118373
  * [Api set: 1.1]
118386
118374
  *
118387
118375
  * @eventproperty
118388
118376
  */
118389
118377
  readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;
118390
118378
  /**
118379
+ * Occurs whenever a task pane state is changed.
118391
118380
  *
118392
- * Occurs whenever a task pane state is changed
118393
- *
118381
+ * @remarks
118394
118382
  * [Api set: 1.1]
118395
118383
  *
118396
118384
  * @eventproperty
@@ -118407,57 +118395,51 @@ declare namespace Visio {
118407
118395
  setMockData(data: Visio.Interfaces.DocumentData): void;
118408
118396
  }
118409
118397
  /**
118410
- *
118411
118398
  * Represents the DocumentView class.
118412
118399
  *
118400
+ * @remarks
118413
118401
  * [Api set: 1.1]
118414
118402
  */
118415
118403
  class DocumentView extends OfficeExtension.ClientObject {
118416
118404
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118417
118405
  context: RequestContext;
118418
118406
  /**
118419
- *
118420
118407
  * Disable Hyperlinks.
118421
118408
  *
118409
+ * @remarks
118422
118410
  * [Api set: 1.1]
118423
118411
  */
118424
118412
  disableHyperlinks: boolean;
118425
118413
  /**
118426
- *
118427
118414
  * Disable Pan.
118428
118415
  *
118416
+ * @remarks
118429
118417
  * [Api set: 1.1]
118430
118418
  */
118431
118419
  disablePan: boolean;
118432
118420
  /**
118433
- *
118434
118421
  * Disable PanZoomWindow.
118435
118422
  *
118423
+ * @remarks
118436
118424
  * [Api set: 1.1]
118437
118425
  */
118438
118426
  disablePanZoomWindow: boolean;
118439
118427
  /**
118440
- *
118441
118428
  * Disable Zoom.
118442
118429
  *
118430
+ * @remarks
118443
118431
  * [Api set: 1.1]
118444
118432
  */
118445
118433
  disableZoom: boolean;
118446
118434
  /**
118447
- *
118448
118435
  * Hide Diagram Boundary.
118449
118436
  *
118437
+ * @remarks
118450
118438
  * [Api set: 1.1]
118451
118439
  */
118452
118440
  hideDiagramBoundary: boolean;
118453
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118454
- *
118455
- * @remarks
118456
- *
118457
- * This method has the following additional signature:
118458
- *
118459
- * `set(properties: Visio.DocumentView): void`
118460
- *
118441
+ /**
118442
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118461
118443
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118462
118444
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118463
118445
  */
@@ -118496,85 +118478,79 @@ declare namespace Visio {
118496
118478
  setMockData(data: Visio.Interfaces.DocumentViewData): void;
118497
118479
  }
118498
118480
  /**
118499
- *
118500
118481
  * Represents the Page class.
118501
118482
  *
118483
+ * @remarks
118502
118484
  * [Api set: 1.1]
118503
118485
  */
118504
118486
  class Page extends OfficeExtension.ClientObject {
118505
118487
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118506
118488
  context: RequestContext;
118507
118489
  /**
118490
+ * All shapes in the Page, including subshapes.
118508
118491
  *
118509
- * All shapes in the Page, including subshapes. Read-only.
118510
- *
118492
+ * @remarks
118511
118493
  * [Api set: 1.1]
118512
118494
  */
118513
118495
  readonly allShapes: Visio.ShapeCollection;
118514
118496
  /**
118497
+ * Returns the Comments Collection.
118515
118498
  *
118516
- * Returns the Comments Collection. Read-only.
118517
- *
118499
+ * @remarks
118518
118500
  * [Api set: 1.1]
118519
118501
  */
118520
118502
  readonly comments: Visio.CommentCollection;
118521
118503
  /**
118504
+ * All top-level shapes in the Page.
118522
118505
  *
118523
- * All top-level shapes in the Page.Read-only.
118524
- *
118506
+ * @remarks
118525
118507
  * [Api set: 1.1]
118526
118508
  */
118527
118509
  readonly shapes: Visio.ShapeCollection;
118528
118510
  /**
118511
+ * Returns the view of the page.
118529
118512
  *
118530
- * Returns the view of the page. Read-only.
118531
- *
118513
+ * @remarks
118532
118514
  * [Api set: 1.1]
118533
118515
  */
118534
118516
  readonly view: Visio.PageView;
118535
118517
  /**
118518
+ * Returns the height of the page.
118536
118519
  *
118537
- * Returns the height of the page. Read-only.
118538
- *
118520
+ * @remarks
118539
118521
  * [Api set: 1.1]
118540
118522
  */
118541
118523
  readonly height: number;
118542
118524
  /**
118525
+ * Index of the Page.
118543
118526
  *
118544
- * Index of the Page. Read-only.
118545
- *
118527
+ * @remarks
118546
118528
  * [Api set: 1.1]
118547
118529
  */
118548
118530
  readonly index: number;
118549
118531
  /**
118532
+ * Whether the page is a background page or not.
118550
118533
  *
118551
- * Whether the page is a background page or not. Read-only.
118552
- *
118534
+ * @remarks
118553
118535
  * [Api set: 1.1]
118554
118536
  */
118555
118537
  readonly isBackground: boolean;
118556
118538
  /**
118539
+ * Page name.
118557
118540
  *
118558
- * Page name. Read-only.
118559
- *
118541
+ * @remarks
118560
118542
  * [Api set: 1.1]
118561
118543
  */
118562
118544
  readonly name: string;
118563
118545
  /**
118546
+ * Returns the width of the page.
118564
118547
  *
118565
- * Returns the width of the page. Read-only.
118566
- *
118548
+ * @remarks
118567
118549
  * [Api set: 1.1]
118568
118550
  */
118569
118551
  readonly width: number;
118570
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118571
- *
118572
- * @remarks
118573
- *
118574
- * This method has the following additional signature:
118575
- *
118576
- * `set(properties: Visio.Page): void`
118577
- *
118552
+ /**
118553
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118578
118554
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118579
118555
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118580
118556
  */
@@ -118582,9 +118558,9 @@ declare namespace Visio {
118582
118558
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118583
118559
  set(properties: Visio.Page): void;
118584
118560
  /**
118561
+ * Sets the page as Active Page of the document.
118585
118562
  *
118586
- * Set the page as Active Page of the document.
118587
- *
118563
+ * @remarks
118588
118564
  * [Api set: 1.1]
118589
118565
  */
118590
118566
  activate(): void;
@@ -118620,29 +118596,23 @@ declare namespace Visio {
118620
118596
  setMockData(data: Visio.Interfaces.PageData): void;
118621
118597
  }
118622
118598
  /**
118623
- *
118624
118599
  * Represents the PageView class.
118625
118600
  *
118601
+ * @remarks
118626
118602
  * [Api set: 1.1]
118627
118603
  */
118628
118604
  class PageView extends OfficeExtension.ClientObject {
118629
118605
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118630
118606
  context: RequestContext;
118631
118607
  /**
118632
- *
118633
118608
  * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
118634
118609
  *
118610
+ * @remarks
118635
118611
  * [Api set: 1.1]
118636
118612
  */
118637
118613
  zoom: number;
118638
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118639
- *
118640
- * @remarks
118641
- *
118642
- * This method has the following additional signature:
118643
- *
118644
- * `set(properties: Visio.PageView): void`
118645
- *
118614
+ /**
118615
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118646
118616
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118647
118617
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118648
118618
  */
@@ -118650,48 +118620,48 @@ declare namespace Visio {
118650
118620
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118651
118621
  set(properties: Visio.PageView): void;
118652
118622
  /**
118653
- *
118654
118623
  * Pans the Visio drawing to place the specified shape in the center of the view.
118655
118624
  *
118625
+ * @remarks
118656
118626
  * [Api set: 1.1]
118657
118627
  *
118658
118628
  * @param ShapeId ShapeId to be seen in the center.
118659
118629
  */
118660
118630
  centerViewportOnShape(ShapeId: number): void;
118661
118631
  /**
118662
- *
118663
118632
  * Fit Page to current window.
118664
118633
  *
118634
+ * @remarks
118665
118635
  * [Api set: 1.1]
118666
118636
  */
118667
118637
  fitToWindow(): void;
118668
118638
  /**
118669
- *
118670
118639
  * Returns the position object that specifies the position of the page in the view.
118671
118640
  *
118641
+ * @remarks
118672
118642
  * [Api set: 1.1]
118673
118643
  */
118674
118644
  getPosition(): OfficeExtension.ClientResult<Visio.Position>;
118675
118645
  /**
118676
- *
118677
118646
  * Represents the Selection in the page.
118678
118647
  *
118648
+ * @remarks
118679
118649
  * [Api set: 1.1]
118680
118650
  */
118681
118651
  getSelection(): Visio.Selection;
118682
118652
  /**
118683
- *
118684
118653
  * To check if the shape is in view of the page or not.
118685
118654
  *
118655
+ * @remarks
118686
118656
  * [Api set: 1.1]
118687
118657
  *
118688
118658
  * @param Shape Shape to be checked.
118689
118659
  */
118690
118660
  isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;
118691
118661
  /**
118692
- *
118693
118662
  * Sets the position of the page in the view.
118694
118663
  *
118664
+ * @remarks
118695
118665
  * [Api set: 1.1]
118696
118666
  *
118697
118667
  * @param Position Position object that specifies the new position of the page in the view.
@@ -118729,9 +118699,9 @@ declare namespace Visio {
118729
118699
  setMockData(data: Visio.Interfaces.PageViewData): void;
118730
118700
  }
118731
118701
  /**
118732
- *
118733
118702
  * Represents a collection of Page objects that are part of the document.
118734
118703
  *
118704
+ * @remarks
118735
118705
  * [Api set: 1.1]
118736
118706
  */
118737
118707
  class PageCollection extends OfficeExtension.ClientObject {
@@ -118740,16 +118710,16 @@ declare namespace Visio {
118740
118710
  /** Gets the loaded child items in this collection. */
118741
118711
  readonly items: Visio.Page[];
118742
118712
  /**
118743
- *
118744
118713
  * Gets the number of pages in the collection.
118745
118714
  *
118715
+ * @remarks
118746
118716
  * [Api set: 1.1]
118747
118717
  */
118748
118718
  getCount(): OfficeExtension.ClientResult<number>;
118749
118719
  /**
118750
- *
118751
118720
  * Gets a page using its key (name or Id).
118752
118721
  *
118722
+ * @remarks
118753
118723
  * [Api set: 1.1]
118754
118724
  *
118755
118725
  * @param key Key is the name or Id of the page to be retrieved.
@@ -118784,9 +118754,9 @@ declare namespace Visio {
118784
118754
  setMockData(data: Visio.Interfaces.PageCollectionData): void;
118785
118755
  }
118786
118756
  /**
118787
- *
118788
118757
  * Represents the Shape Collection.
118789
118758
  *
118759
+ * @remarks
118790
118760
  * [Api set: 1.1]
118791
118761
  */
118792
118762
  class ShapeCollection extends OfficeExtension.ClientObject {
@@ -118795,16 +118765,16 @@ declare namespace Visio {
118795
118765
  /** Gets the loaded child items in this collection. */
118796
118766
  readonly items: Visio.Shape[];
118797
118767
  /**
118798
- *
118799
118768
  * Gets the number of Shapes in the collection.
118800
118769
  *
118770
+ * @remarks
118801
118771
  * [Api set: 1.1]
118802
118772
  */
118803
118773
  getCount(): OfficeExtension.ClientResult<number>;
118804
118774
  /**
118805
- *
118806
118775
  * Gets a Shape using its key (name or Index).
118807
118776
  *
118777
+ * @remarks
118808
118778
  * [Api set: 1.1]
118809
118779
  *
118810
118780
  * @param key Key is the Name or Index of the shape to be retrieved.
@@ -118839,85 +118809,79 @@ declare namespace Visio {
118839
118809
  setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
118840
118810
  }
118841
118811
  /**
118842
- *
118843
118812
  * Represents the Shape class.
118844
118813
  *
118814
+ * @remarks
118845
118815
  * [Api set: 1.1]
118846
118816
  */
118847
118817
  class Shape extends OfficeExtension.ClientObject {
118848
118818
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118849
118819
  context: RequestContext;
118850
118820
  /**
118821
+ * Returns the Comments Collection.
118851
118822
  *
118852
- * Returns the Comments Collection. Read-only.
118853
- *
118823
+ * @remarks
118854
118824
  * [Api set: 1.1]
118855
118825
  */
118856
118826
  readonly comments: Visio.CommentCollection;
118857
118827
  /**
118828
+ * Returns the Hyperlinks collection for a Shape object.
118858
118829
  *
118859
- * Returns the Hyperlinks collection for a Shape object. Read-only.
118860
- *
118830
+ * @remarks
118861
118831
  * [Api set: 1.1]
118862
118832
  */
118863
118833
  readonly hyperlinks: Visio.HyperlinkCollection;
118864
118834
  /**
118835
+ * Returns the Shape's Data Section.
118865
118836
  *
118866
- * Returns the Shape's Data Section. Read-only.
118867
- *
118837
+ * @remarks
118868
118838
  * [Api set: 1.1]
118869
118839
  */
118870
118840
  readonly shapeDataItems: Visio.ShapeDataItemCollection;
118871
118841
  /**
118842
+ * Gets SubShape Collection.
118872
118843
  *
118873
- * Gets SubShape Collection. Read-only.
118874
- *
118844
+ * @remarks
118875
118845
  * [Api set: 1.1]
118876
118846
  */
118877
118847
  readonly subShapes: Visio.ShapeCollection;
118878
118848
  /**
118849
+ * Returns the view of the shape.
118879
118850
  *
118880
- * Returns the view of the shape. Read-only.
118881
- *
118851
+ * @remarks
118882
118852
  * [Api set: 1.1]
118883
118853
  */
118884
118854
  readonly view: Visio.ShapeView;
118885
118855
  /**
118856
+ * Shape's identifier.
118886
118857
  *
118887
- * Shape's identifier. Read-only.
118888
- *
118858
+ * @remarks
118889
118859
  * [Api set: 1.1]
118890
118860
  */
118891
118861
  readonly id: number;
118892
118862
  /**
118863
+ * Shape's name.
118893
118864
  *
118894
- * Shape's name. Read-only.
118895
- *
118865
+ * @remarks
118896
118866
  * [Api set: 1.1]
118897
118867
  */
118898
118868
  readonly name: string;
118899
118869
  /**
118900
- *
118901
118870
  * Returns true, if shape is selected. User can set true to select the shape explicitly.
118902
118871
  *
118872
+ * @remarks
118903
118873
  * [Api set: 1.1]
118904
118874
  */
118905
118875
  select: boolean;
118906
118876
  /**
118877
+ * Shape's text.
118907
118878
  *
118908
- * Shape's text. Read-only.
118909
- *
118879
+ * @remarks
118910
118880
  * [Api set: 1.1]
118911
118881
  */
118912
118882
  readonly text: string;
118913
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118914
- *
118915
- * @remarks
118916
- *
118917
- * This method has the following additional signature:
118918
- *
118919
- * `set(properties: Visio.Shape): void`
118920
- *
118883
+ /**
118884
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118921
118885
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118922
118886
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118923
118887
  */
@@ -118925,12 +118889,19 @@ declare namespace Visio {
118925
118889
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118926
118890
  set(properties: Visio.Shape): void;
118927
118891
  /**
118928
- *
118929
118892
  * Returns the BoundingBox object that specifies bounding box of the shape.
118930
118893
  *
118894
+ * @remarks
118931
118895
  * [Api set: 1.1]
118932
118896
  */
118933
118897
  getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
118898
+ /**
118899
+ * Returns the AbsoluteBoundingBox object that specifies absolute bounding box of the shape.
118900
+ *
118901
+ * @remarks
118902
+ * [Api set: 1.1]
118903
+ */
118904
+ getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
118934
118905
  /**
118935
118906
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
118936
118907
  *
@@ -118963,29 +118934,23 @@ declare namespace Visio {
118963
118934
  setMockData(data: Visio.Interfaces.ShapeData): void;
118964
118935
  }
118965
118936
  /**
118966
- *
118967
118937
  * Represents the ShapeView class.
118968
118938
  *
118939
+ * @remarks
118969
118940
  * [Api set: 1.1]
118970
118941
  */
118971
118942
  class ShapeView extends OfficeExtension.ClientObject {
118972
118943
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
118973
118944
  context: RequestContext;
118974
118945
  /**
118975
- *
118976
118946
  * Represents the highlight around the shape.
118977
118947
  *
118948
+ * @remarks
118978
118949
  * [Api set: 1.1]
118979
118950
  */
118980
118951
  highlight: Visio.Highlight;
118981
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118982
- *
118983
- * @remarks
118984
- *
118985
- * This method has the following additional signature:
118986
- *
118987
- * `set(properties: Visio.ShapeView): void`
118988
- *
118952
+ /**
118953
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
118989
118954
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
118990
118955
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
118991
118956
  */
@@ -118993,9 +118958,9 @@ declare namespace Visio {
118993
118958
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
118994
118959
  set(properties: Visio.ShapeView): void;
118995
118960
  /**
118996
- *
118997
118961
  * Adds an overlay on top of the shape.
118998
118962
  *
118963
+ * @remarks
118999
118964
  * [Api set: 1.1]
119000
118965
  *
119001
118966
  * @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
@@ -119007,9 +118972,9 @@ declare namespace Visio {
119007
118972
  */
119008
118973
  addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;
119009
118974
  /**
119010
- *
119011
118975
  * Adds an overlay on top of the shape.
119012
118976
  *
118977
+ * @remarks
119013
118978
  * [Api set: 1.1]
119014
118979
  *
119015
118980
  * @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
@@ -119021,22 +118986,31 @@ declare namespace Visio {
119021
118986
  */
119022
118987
  addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;
119023
118988
  /**
119024
- *
119025
118989
  * Removes particular overlay or all overlays on the Shape.
119026
118990
  *
118991
+ * @remarks
119027
118992
  * [Api set: 1.1]
119028
118993
  *
119029
118994
  * @param OverlayId An Overlay Id. Removes the specific overlay id from the shape.
119030
118995
  */
119031
118996
  removeOverlay(OverlayId: number): void;
119032
118997
  /**
118998
+ * The purpose of SetText API is to update the text inside a Visio Shape in run time. The updated text retains the existing formatting properties of the shape's text.
119033
118999
  *
119000
+ * @remarks
119001
+ * [Api set: 1.1]
119002
+ *
119003
+ * @param Text Text parameter is the updated text to display on the shape.
119004
+ */
119005
+ setText(Text: string): void;
119006
+ /**
119034
119007
  * Shows particular overlay on the Shape.
119035
119008
  *
119009
+ * @remarks
119036
119010
  * [Api set: 1.1]
119037
119011
  *
119038
- * @param overlayId overlay id in context
119039
- * @param show to show or hide
119012
+ * @param overlayId The overlay ID in context.
119013
+ * @param show Whether to show the overlay.
119040
119014
  */
119041
119015
  showOverlay(overlayId: number, show: boolean): void;
119042
119016
  /**
@@ -119071,89 +119045,89 @@ declare namespace Visio {
119071
119045
  setMockData(data: Visio.Interfaces.ShapeViewData): void;
119072
119046
  }
119073
119047
  /**
119074
- *
119075
119048
  * Represents the Position of the object in the view.
119076
119049
  *
119050
+ * @remarks
119077
119051
  * [Api set: 1.1]
119078
119052
  */
119079
119053
  interface Position {
119080
119054
  /**
119081
- *
119082
119055
  * An integer that specifies the x-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the left boundary of the page.
119083
119056
  *
119057
+ * @remarks
119084
119058
  * [Api set: 1.1]
119085
119059
  */
119086
119060
  x: number;
119087
119061
  /**
119088
- *
119089
119062
  * An integer that specifies the y-coordinate of the object, which is the signed value of the distance in pixels from the viewport's center to the top boundary of the page.
119090
119063
  *
119064
+ * @remarks
119091
119065
  * [Api set: 1.1]
119092
119066
  */
119093
119067
  y: number;
119094
119068
  }
119095
119069
  /**
119096
- *
119097
119070
  * Represents the BoundingBox of the shape.
119098
119071
  *
119072
+ * @remarks
119099
119073
  * [Api set: 1.1]
119100
119074
  */
119101
119075
  interface BoundingBox {
119102
119076
  /**
119103
- *
119104
119077
  * The distance between the top and bottom edges of the bounding box of the shape, excluding any data graphics associated with the shape.
119105
119078
  *
119079
+ * @remarks
119106
119080
  * [Api set: 1.1]
119107
119081
  */
119108
119082
  height: number;
119109
119083
  /**
119110
- *
119111
119084
  * The distance between the left and right edges of the bounding box of the shape, excluding any data graphics associated with the shape.
119112
119085
  *
119086
+ * @remarks
119113
119087
  * [Api set: 1.1]
119114
119088
  */
119115
119089
  width: number;
119116
119090
  /**
119117
- *
119118
119091
  * An integer that specifies the x-coordinate of the bounding box.
119119
119092
  *
119093
+ * @remarks
119120
119094
  * [Api set: 1.1]
119121
119095
  */
119122
119096
  x: number;
119123
119097
  /**
119124
- *
119125
119098
  * An integer that specifies the y-coordinate of the bounding box.
119126
119099
  *
119100
+ * @remarks
119127
119101
  * [Api set: 1.1]
119128
119102
  */
119129
119103
  y: number;
119130
119104
  }
119131
119105
  /**
119132
- *
119133
119106
  * Represents the highlight data added to the shape.
119134
119107
  *
119108
+ * @remarks
119135
119109
  * [Api set: 1.1]
119136
119110
  */
119137
119111
  interface Highlight {
119138
119112
  /**
119139
- *
119140
119113
  * A string that specifies the color of the highlight. It must have the form "#RRGGBB", where each letter represents a hexadecimal digit between 0 and F, and where RR is the red value between 0 and 0xFF (255), GG the green value between 0 and 0xFF (255), and BB is the blue value between 0 and 0xFF (255).
119141
119114
  *
119115
+ * @remarks
119142
119116
  * [Api set: 1.1]
119143
119117
  */
119144
119118
  color: string;
119145
119119
  /**
119146
- *
119147
119120
  * A positive integer that specifies the width of the highlight's stroke in pixels.
119148
119121
  *
119122
+ * @remarks
119149
119123
  * [Api set: 1.1]
119150
119124
  */
119151
119125
  width: number;
119152
119126
  }
119153
119127
  /**
119154
- *
119155
119128
  * Represents the ShapeDataItemCollection for a given Shape.
119156
119129
  *
119130
+ * @remarks
119157
119131
  * [Api set: 1.1]
119158
119132
  */
119159
119133
  class ShapeDataItemCollection extends OfficeExtension.ClientObject {
@@ -119162,16 +119136,16 @@ declare namespace Visio {
119162
119136
  /** Gets the loaded child items in this collection. */
119163
119137
  readonly items: Visio.ShapeDataItem[];
119164
119138
  /**
119165
- *
119166
119139
  * Gets the number of Shape Data Items.
119167
119140
  *
119141
+ * @remarks
119168
119142
  * [Api set: 1.1]
119169
119143
  */
119170
119144
  getCount(): OfficeExtension.ClientResult<number>;
119171
119145
  /**
119172
- *
119173
119146
  * Gets the ShapeDataItem using its name.
119174
119147
  *
119148
+ * @remarks
119175
119149
  * [Api set: 1.1]
119176
119150
  *
119177
119151
  * @param key Key is the name of the ShapeDataItem to be retrieved.
@@ -119206,39 +119180,39 @@ declare namespace Visio {
119206
119180
  setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
119207
119181
  }
119208
119182
  /**
119209
- *
119210
119183
  * Represents the ShapeDataItem.
119211
119184
  *
119185
+ * @remarks
119212
119186
  * [Api set: 1.1]
119213
119187
  */
119214
119188
  class ShapeDataItem extends OfficeExtension.ClientObject {
119215
119189
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119216
119190
  context: RequestContext;
119217
119191
  /**
119192
+ * A string that specifies the format of the shape data item.
119218
119193
  *
119219
- * A string that specifies the format of the shape data item. Read-only.
119220
- *
119194
+ * @remarks
119221
119195
  * [Api set: 1.1]
119222
119196
  */
119223
119197
  readonly format: string;
119224
119198
  /**
119199
+ * A string that specifies the formatted value of the shape data item.
119225
119200
  *
119226
- * A string that specifies the formatted value of the shape data item. Read-only.
119227
- *
119201
+ * @remarks
119228
119202
  * [Api set: 1.1]
119229
119203
  */
119230
119204
  readonly formattedValue: string;
119231
119205
  /**
119206
+ * A string that specifies the label of the shape data item.
119232
119207
  *
119233
- * A string that specifies the label of the shape data item. Read-only.
119234
- *
119208
+ * @remarks
119235
119209
  * [Api set: 1.1]
119236
119210
  */
119237
119211
  readonly label: string;
119238
119212
  /**
119213
+ * A string that specifies the value of the shape data item.
119239
119214
  *
119240
- * A string that specifies the value of the shape data item. Read-only.
119241
- *
119215
+ * @remarks
119242
119216
  * [Api set: 1.1]
119243
119217
  */
119244
119218
  readonly value: string;
@@ -119274,9 +119248,9 @@ declare namespace Visio {
119274
119248
  setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
119275
119249
  }
119276
119250
  /**
119277
- *
119278
119251
  * Represents the Hyperlink Collection.
119279
119252
  *
119253
+ * @remarks
119280
119254
  * [Api set: 1.1]
119281
119255
  */
119282
119256
  class HyperlinkCollection extends OfficeExtension.ClientObject {
@@ -119285,16 +119259,16 @@ declare namespace Visio {
119285
119259
  /** Gets the loaded child items in this collection. */
119286
119260
  readonly items: Visio.Hyperlink[];
119287
119261
  /**
119288
- *
119289
119262
  * Gets the number of hyperlinks.
119290
119263
  *
119264
+ * @remarks
119291
119265
  * [Api set: 1.1]
119292
119266
  */
119293
119267
  getCount(): OfficeExtension.ClientResult<number>;
119294
119268
  /**
119295
- *
119296
119269
  * Gets a Hyperlink using its key (name or Id).
119297
119270
  *
119271
+ * @remarks
119298
119272
  * [Api set: 1.1]
119299
119273
  *
119300
119274
  * @param Key Key is the name or index of the Hyperlink to be retrieved.
@@ -119329,39 +119303,39 @@ declare namespace Visio {
119329
119303
  setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
119330
119304
  }
119331
119305
  /**
119332
- *
119333
119306
  * Represents the Hyperlink.
119334
119307
  *
119308
+ * @remarks
119335
119309
  * [Api set: 1.1]
119336
119310
  */
119337
119311
  class Hyperlink extends OfficeExtension.ClientObject {
119338
119312
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119339
119313
  context: RequestContext;
119340
119314
  /**
119315
+ * Gets the address of the Hyperlink object.
119341
119316
  *
119342
- * Gets the address of the Hyperlink object. Read-only.
119343
- *
119317
+ * @remarks
119344
119318
  * [Api set: 1.1]
119345
119319
  */
119346
119320
  readonly address: string;
119347
119321
  /**
119322
+ * Gets the description of a hyperlink.
119348
119323
  *
119349
- * Gets the description of a hyperlink. Read-only.
119350
- *
119324
+ * @remarks
119351
119325
  * [Api set: 1.1]
119352
119326
  */
119353
119327
  readonly description: string;
119354
119328
  /**
119329
+ * Gets the extra URL request information used to resolve the hyperlink's URL.
119355
119330
  *
119356
- * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
119357
- *
119331
+ * @remarks
119358
119332
  * [Api set: 1.1]
119359
119333
  */
119360
119334
  readonly extraInfo: string;
119361
119335
  /**
119336
+ * Gets the sub-address of the Hyperlink object.
119362
119337
  *
119363
- * Gets the sub-address of the Hyperlink object. Read-only.
119364
- *
119338
+ * @remarks
119365
119339
  * [Api set: 1.1]
119366
119340
  */
119367
119341
  readonly subAddress: string;
@@ -119397,9 +119371,9 @@ declare namespace Visio {
119397
119371
  setMockData(data: Visio.Interfaces.HyperlinkData): void;
119398
119372
  }
119399
119373
  /**
119400
- *
119401
119374
  * Represents the CommentCollection for a given Shape.
119402
119375
  *
119376
+ * @remarks
119403
119377
  * [Api set: 1.1]
119404
119378
  */
119405
119379
  class CommentCollection extends OfficeExtension.ClientObject {
@@ -119408,16 +119382,16 @@ declare namespace Visio {
119408
119382
  /** Gets the loaded child items in this collection. */
119409
119383
  readonly items: Visio.Comment[];
119410
119384
  /**
119411
- *
119412
119385
  * Gets the number of Comments.
119413
119386
  *
119387
+ * @remarks
119414
119388
  * [Api set: 1.1]
119415
119389
  */
119416
119390
  getCount(): OfficeExtension.ClientResult<number>;
119417
119391
  /**
119418
- *
119419
119392
  * Gets the Comment using its name.
119420
119393
  *
119394
+ * @remarks
119421
119395
  * [Api set: 1.1]
119422
119396
  *
119423
119397
  * @param key Key is the name of the Comment to be retrieved.
@@ -119452,43 +119426,37 @@ declare namespace Visio {
119452
119426
  setMockData(data: Visio.Interfaces.CommentCollectionData): void;
119453
119427
  }
119454
119428
  /**
119455
- *
119456
119429
  * Represents the Comment.
119457
119430
  *
119431
+ * @remarks
119458
119432
  * [Api set: 1.1]
119459
119433
  */
119460
119434
  class Comment extends OfficeExtension.ClientObject {
119461
119435
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119462
119436
  context: RequestContext;
119463
119437
  /**
119464
- *
119465
119438
  * A string that specifies the name of the author of the comment.
119466
119439
  *
119440
+ * @remarks
119467
119441
  * [Api set: 1.1]
119468
119442
  */
119469
119443
  author: string;
119470
119444
  /**
119471
- *
119472
119445
  * A string that specifies the date when the comment was created.
119473
119446
  *
119447
+ * @remarks
119474
119448
  * [Api set: 1.1]
119475
119449
  */
119476
119450
  date: string;
119477
119451
  /**
119478
- *
119479
119452
  * A string that contains the comment text.
119480
119453
  *
119454
+ * @remarks
119481
119455
  * [Api set: 1.1]
119482
119456
  */
119483
119457
  text: string;
119484
- /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
119485
- *
119486
- * @remarks
119487
- *
119488
- * This method has the following additional signature:
119489
- *
119490
- * `set(properties: Visio.Comment): void`
119491
- *
119458
+ /**
119459
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
119492
119460
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
119493
119461
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
119494
119462
  */
@@ -119527,18 +119495,18 @@ declare namespace Visio {
119527
119495
  setMockData(data: Visio.Interfaces.CommentData): void;
119528
119496
  }
119529
119497
  /**
119530
- *
119531
119498
  * Represents the Selection in the page.
119532
119499
  *
119500
+ * @remarks
119533
119501
  * [Api set: 1.1]
119534
119502
  */
119535
119503
  class Selection extends OfficeExtension.ClientObject {
119536
119504
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119537
119505
  context: RequestContext;
119538
119506
  /**
119507
+ * Gets the Shapes of the Selection.
119539
119508
  *
119540
- * Gets the Shapes of the Selection. Read-only.
119541
- *
119509
+ * @remarks
119542
119510
  * [Api set: 1.1]
119543
119511
  */
119544
119512
  readonly shapes: Visio.ShapeCollection;
@@ -119564,575 +119532,502 @@ declare namespace Visio {
119564
119532
  toJSON(): Visio.Interfaces.SelectionData;
119565
119533
  }
119566
119534
  /**
119567
- *
119568
- * Shape binding informations required for data visualizer diagram
119569
- *
119570
- * [Api set: 1.1]
119571
- */
119572
- interface ShapeBinding {
119573
- /**
119574
- *
119575
- * Column for alternative text for shape.
119576
- *
119577
- * [Api set: 1.1]
119578
- */
119579
- alternativeTextColumnName: string;
119580
- /**
119581
- *
119582
- * Column for Shape label.
119583
- *
119584
- * [Api set: 1.1]
119585
- */
119586
- labelColumnName: string;
119587
- /**
119588
- *
119589
- * Unique Id column.
119590
- *
119591
- * [Api set: 1.1]
119592
- */
119593
- uniqueIDColumnName: string;
119594
- }
119595
- /**
119596
- *
119597
- * Connector bindings for data visualizer diagram.
119598
- *
119599
- * [Api set: 1.1]
119600
- */
119601
- interface ConnectorBinding {
119602
- /**
119603
- *
119604
- * If true then connectors are added in sequence according to the uniqueId column.
119605
- *
119606
- * [Api set: 1.1]
119607
- */
119608
- connectSequentially: boolean;
119609
- /**
119610
- *
119611
- * Delimiter for TargetColumn. It should not have more then one character.
119612
- *
119613
- * [Api set: 1.1]
119614
- */
119615
- delimiter: string;
119616
- /**
119617
- *
119618
- * Direction of connector to use in diagram.
119619
- *
119620
- * [Api set: 1.1]
119621
- */
119622
- direction: Visio.ConnectorDirection | "FromTarget" | "ToTarget";
119623
- /**
119624
- *
119625
- * Column for ConnectorLabel (shape text of connector).
119626
- *
119627
- * [Api set: 1.1]
119628
- */
119629
- labelColumnName: string;
119630
- /**
119631
- *
119632
- * Column for proving connected target shape.
119633
- *
119634
- * [Api set: 1.1]
119635
- */
119636
- targetColumnName: string;
119637
- }
119638
- /**
119639
- *
119640
119535
  * Represents the Horizontal Alignment of the Overlay relative to the shape.
119641
119536
  *
119537
+ * @remarks
119642
119538
  * [Api set: 1.1]
119643
119539
  */
119644
119540
  enum OverlayHorizontalAlignment {
119645
119541
  /**
119646
- *
119647
- * left
119648
- *
119542
+ * @remarks
119543
+ * [Api set: 1.1]
119649
119544
  */
119650
119545
  left = "Left",
119651
119546
  /**
119652
- *
119653
- * center
119654
- *
119547
+ * @remarks
119548
+ * [Api set: 1.1]
119655
119549
  */
119656
119550
  center = "Center",
119657
119551
  /**
119658
- *
119659
- * right
119660
- *
119552
+ * @remarks
119553
+ * [Api set: 1.1]
119661
119554
  */
119662
119555
  right = "Right",
119663
119556
  }
119664
119557
  /**
119665
- *
119666
119558
  * Represents the Vertical Alignment of the Overlay relative to the shape.
119667
119559
  *
119560
+ * @remarks
119668
119561
  * [Api set: 1.1]
119669
119562
  */
119670
119563
  enum OverlayVerticalAlignment {
119671
119564
  /**
119672
- *
119673
- * top
119674
- *
119565
+ * @remarks
119566
+ * [Api set: 1.1]
119675
119567
  */
119676
119568
  top = "Top",
119677
119569
  /**
119678
- *
119679
- * middle
119680
- *
119570
+ * @remarks
119571
+ * [Api set: 1.1]
119681
119572
  */
119682
119573
  middle = "Middle",
119683
119574
  /**
119684
- *
119685
- * bottom
119686
- *
119575
+ * @remarks
119576
+ * [Api set: 1.1]
119687
119577
  */
119688
119578
  bottom = "Bottom",
119689
119579
  }
119690
119580
  /**
119691
- *
119692
119581
  * Represents the type of the overlay.
119693
119582
  *
119583
+ * @remarks
119694
119584
  * [Api set: 1.1]
119695
119585
  */
119696
119586
  enum OverlayType {
119697
119587
  /**
119698
- *
119699
- * text
119700
- *
119588
+ * @remarks
119589
+ * [Api set: 1.1]
119701
119590
  */
119702
119591
  text = "Text",
119703
119592
  /**
119704
- *
119705
- * image
119706
- *
119593
+ * @remarks
119594
+ * [Api set: 1.1]
119707
119595
  */
119708
119596
  image = "Image",
119709
119597
  /**
119710
- *
119711
- * html
119712
- *
119598
+ * @remarks
119599
+ * [Api set: 1.1]
119713
119600
  */
119714
119601
  html = "Html",
119715
119602
  }
119716
119603
  /**
119604
+ * Toolbar IDs of the app.
119717
119605
  *
119718
- * Toolbar IDs of the app
119719
- *
119606
+ * @remarks
119720
119607
  * [Api set: 1.1]
119721
119608
  */
119722
119609
  enum ToolBarType {
119723
119610
  /**
119724
- *
119725
- * CommandBar
119726
- *
119611
+ * The command toolbar type.
119612
+ * @remarks
119613
+ * [Api set: 1.1]
119727
119614
  */
119728
119615
  commandBar = "CommandBar",
119729
119616
  /**
119730
- *
119731
- * PageNavigationBar
119732
- *
119617
+ * The page navigation toolbar type.
119618
+ * @remarks
119619
+ * [Api set: 1.1]
119733
119620
  */
119734
119621
  pageNavigationBar = "PageNavigationBar",
119735
119622
  /**
119736
- *
119737
- * StatusBar
119738
- *
119623
+ * The status toolbar type.
119624
+ * @remarks
119625
+ * [Api set: 1.1]
119739
119626
  */
119740
119627
  statusBar = "StatusBar",
119741
119628
  }
119742
119629
  /**
119743
- *
119744
119630
  * Result of Data Visualizer Diagram operations.
119745
119631
  *
119632
+ * @remarks
119746
119633
  * [Api set: 1.1]
119747
119634
  */
119748
119635
  enum DataVisualizerDiagramResultType {
119749
119636
  /**
119750
- *
119751
- * Operation is success.
119752
- *
119637
+ * Operation is successful.
119638
+ * @remarks
119639
+ * [Api set: 1.1]
119753
119640
  */
119754
119641
  success = "Success",
119755
119642
  /**
119756
- *
119757
119643
  * Unexpected error during operation.
119758
- *
119644
+ * @remarks
119645
+ * [Api set: 1.1]
119759
119646
  */
119760
119647
  unexpected = "Unexpected",
119761
119648
  /**
119762
- *
119763
119649
  * Validation error in operation.
119764
- *
119650
+ * @remarks
119651
+ * [Api set: 1.1]
119765
119652
  */
119766
119653
  validationError = "ValidationError",
119767
119654
  /**
119768
- *
119769
119655
  * Conflict error in operation.
119770
- *
119656
+ * @remarks
119657
+ * [Api set: 1.1]
119771
119658
  */
119772
119659
  conflictError = "ConflictError",
119773
119660
  }
119774
119661
  /**
119775
- *
119776
119662
  * Type of the Data Visualizer Diagram operation
119777
119663
  *
119664
+ * @remarks
119778
119665
  * [Api set: 1.1]
119779
119666
  */
119780
119667
  enum DataVisualizerDiagramOperationType {
119781
119668
  /**
119782
- *
119783
- * unknown operation type.
119784
- *
119669
+ * Unknown operation type.
119670
+ * @remarks
119671
+ * [Api set: 1.1]
119785
119672
  */
119786
119673
  unknown = "Unknown",
119787
119674
  /**
119788
- *
119789
119675
  * Creation operation.
119790
- *
119676
+ * @remarks
119677
+ * [Api set: 1.1]
119791
119678
  */
119792
119679
  create = "Create",
119793
119680
  /**
119794
- *
119795
119681
  * Update Mappings operation.
119796
- *
119682
+ * @remarks
119683
+ * [Api set: 1.1]
119797
119684
  */
119798
119685
  updateMappings = "UpdateMappings",
119799
119686
  /**
119800
- *
119801
119687
  * Update data associated with diagram.
119802
- *
119688
+ * @remarks
119689
+ * [Api set: 1.1]
119803
119690
  */
119804
119691
  updateData = "UpdateData",
119805
119692
  /**
119806
- *
119807
119693
  * Update both data and mappings.
119808
- *
119694
+ * @remarks
119695
+ * [Api set: 1.1]
119809
119696
  */
119810
119697
  update = "Update",
119811
119698
  /**
119812
- *
119813
119699
  * Delete the diagram content.
119814
- *
119700
+ * @remarks
119701
+ * [Api set: 1.1]
119815
119702
  */
119816
119703
  delete = "Delete",
119817
119704
  }
119818
119705
  /**
119706
+ * DiagramType for Data Visualizer diagrams.
119819
119707
  *
119820
- * DiagramType for Data Visualizer diagrams
119821
- *
119708
+ * @remarks
119822
119709
  * [Api set: 1.1]
119823
119710
  */
119824
119711
  enum DataVisualizerDiagramType {
119825
119712
  /**
119826
- *
119827
- * Unknown
119828
- *
119713
+ * @remarks
119714
+ * [Api set: 1.1]
119829
119715
  */
119830
119716
  unknown = "Unknown",
119831
119717
  /**
119832
- *
119833
- * Basic Flowchart
119834
- *
119718
+ * @remarks
119719
+ * [Api set: 1.1]
119835
119720
  */
119836
119721
  basicFlowchart = "BasicFlowchart",
119837
119722
  /**
119838
- *
119839
- * Horizontal Cross-Functional Flowchart
119840
- *
119723
+ * @remarks
119724
+ * [Api set: 1.1]
119841
119725
  */
119842
119726
  crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
119843
119727
  /**
119844
- *
119845
- * Vertical Cross-Functional Flowchart
119846
- *
119728
+ * @remarks
119729
+ * [Api set: 1.1]
119847
119730
  */
119848
119731
  crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
119849
119732
  /**
119850
- *
119851
- * Audit
119852
- *
119733
+ * @remarks
119734
+ * [Api set: 1.1]
119853
119735
  */
119854
119736
  audit = "Audit",
119855
119737
  /**
119856
- *
119857
- * OrgChart
119858
- *
119738
+ * @remarks
119739
+ * [Api set: 1.1]
119859
119740
  */
119860
119741
  orgChart = "OrgChart",
119861
119742
  /**
119862
- *
119863
- * Network
119864
- *
119743
+ * @remarks
119744
+ * [Api set: 1.1]
119865
119745
  */
119866
119746
  network = "Network",
119867
119747
  }
119868
119748
  /**
119869
- *
119870
119749
  * Represents the type of column values.
119871
119750
  *
119751
+ * @remarks
119872
119752
  * [Api set: 1.1]
119873
119753
  */
119874
119754
  enum ColumnType {
119875
119755
  /**
119876
- *
119877
- * Other
119878
- *
119756
+ * @remarks
119757
+ * [Api set: 1.1]
119879
119758
  */
119880
119759
  unknown = "Unknown",
119881
119760
  /**
119882
- *
119883
- * String values
119884
- *
119761
+ * @remarks
119762
+ * [Api set: 1.1]
119885
119763
  */
119886
119764
  string = "String",
119887
119765
  /**
119888
- *
119889
- * Numerical values
119890
- *
119766
+ * @remarks
119767
+ * [Api set: 1.1]
119891
119768
  */
119892
119769
  number = "Number",
119893
119770
  /**
119894
- *
119895
- * Date
119896
- *
119771
+ * @remarks
119772
+ * [Api set: 1.1]
119897
119773
  */
119898
119774
  date = "Date",
119899
119775
  /**
119900
- *
119901
- * Currency
119902
- *
119776
+ * @remarks
119777
+ * [Api set: 1.1]
119903
119778
  */
119904
119779
  currency = "Currency",
119905
119780
  }
119906
119781
  /**
119907
- *
119908
119782
  * Represents the type of source for the data connection.
119909
119783
  *
119784
+ * @remarks
119910
119785
  * [Api set: 1.1]
119911
119786
  */
119912
119787
  enum DataSourceType {
119913
119788
  /**
119914
- *
119915
- * Unknown Data Source
119916
- *
119789
+ * Unknown Data Source.
119790
+ * @remarks
119791
+ * [Api set: 1.1]
119917
119792
  */
119918
119793
  unknown = "Unknown",
119919
119794
  /**
119920
- *
119921
- * Microsoft Excel workbook
119922
- *
119795
+ * Microsoft Excel workbook.
119796
+ * @remarks
119797
+ * [Api set: 1.1]
119923
119798
  */
119924
119799
  excel = "Excel",
119925
119800
  }
119926
119801
  /**
119927
- *
119928
119802
  * Represents the orientation of the Cross Functional Flowchart diagram.
119929
119803
  *
119804
+ * @remarks
119930
119805
  * [Api set: 1.1]
119931
119806
  */
119932
119807
  enum CrossFunctionalFlowchartOrientation {
119933
119808
  /**
119934
- *
119935
119809
  * Horizontal Cross Functional Flowchart.
119936
- *
119810
+ * @remarks
119811
+ * [Api set: 1.1]
119937
119812
  */
119938
119813
  horizontal = "Horizontal",
119939
119814
  /**
119940
- *
119941
119815
  * Vertical Cross Functional Flowchart.
119942
- *
119816
+ * @remarks
119817
+ * [Api set: 1.1]
119943
119818
  */
119944
119819
  vertical = "Vertical",
119945
119820
  }
119946
119821
  /**
119947
- *
119948
119822
  * Represents the type of layout.
119949
119823
  *
119824
+ * @remarks
119950
119825
  * [Api set: 1.1]
119951
119826
  */
119952
119827
  enum LayoutVariant {
119953
119828
  /**
119954
- *
119955
- * Invalid layout
119956
- *
119829
+ * Invalid layout.
119830
+ * @remarks
119831
+ * [Api set: 1.1]
119957
119832
  */
119958
119833
  unknown = "Unknown",
119959
119834
  /**
119960
- *
119961
- * Use the Page default layout
119962
- *
119835
+ * Use the Page default layout.
119836
+ * @remarks
119837
+ * [Api set: 1.1]
119963
119838
  */
119964
119839
  pageDefault = "PageDefault",
119965
119840
  /**
119966
- *
119967
- * Use Flowchart with TopToBottom orientation
119968
- *
119841
+ * Use Flowchart with TopToBottom orientation.
119842
+ * @remarks
119843
+ * [Api set: 1.1]
119969
119844
  */
119970
119845
  flowchart_TopToBottom = "Flowchart_TopToBottom",
119971
119846
  /**
119972
- *
119973
- * Use Flowchart with BottomToTop orientation
119974
- *
119847
+ * Use Flowchart with BottomToTop orientation.
119848
+ * @remarks
119849
+ * [Api set: 1.1]
119975
119850
  */
119976
119851
  flowchart_BottomToTop = "Flowchart_BottomToTop",
119977
119852
  /**
119978
- *
119979
- * Use Flowchart with LeftToRight orientation
119980
- *
119853
+ * Use Flowchart with LeftToRight orientation.
119854
+ * @remarks
119855
+ * [Api set: 1.1]
119981
119856
  */
119982
119857
  flowchart_LeftToRight = "Flowchart_LeftToRight",
119983
119858
  /**
119984
- *
119985
- * Use Flowchart with RightToLeft orientation
119986
- *
119859
+ * Use Flowchart with RightToLeft orientation.
119860
+ * @remarks
119861
+ * [Api set: 1.1]
119987
119862
  */
119988
119863
  flowchart_RightToLeft = "Flowchart_RightToLeft",
119989
119864
  /**
119990
- *
119991
- * Use WideTree with DownThenRight orientation
119992
- *
119865
+ * Use WideTree with DownThenRight orientation.
119866
+ * @remarks
119867
+ * [Api set: 1.1]
119993
119868
  */
119994
119869
  wideTree_DownThenRight = "WideTree_DownThenRight",
119995
119870
  /**
119996
- *
119997
- * Use WideTree with DownThenLeft orientation
119998
- *
119871
+ * Use WideTree with DownThenLeft orientation.
119872
+ * @remarks
119873
+ * [Api set: 1.1]
119999
119874
  */
120000
119875
  wideTree_DownThenLeft = "WideTree_DownThenLeft",
120001
119876
  /**
120002
- *
120003
- * Use WideTree with RightThenDown orientation
120004
- *
119877
+ * Use WideTree with RightThenDown orientation.
119878
+ * @remarks
119879
+ * [Api set: 1.1]
120005
119880
  */
120006
119881
  wideTree_RightThenDown = "WideTree_RightThenDown",
120007
119882
  /**
120008
- *
120009
- * Use WideTree with LeftThenDown orientation
120010
- *
119883
+ * Use WideTree with LeftThenDown orientation.
119884
+ * @remarks
119885
+ * [Api set: 1.1]
120011
119886
  */
120012
119887
  wideTree_LeftThenDown = "WideTree_LeftThenDown",
120013
119888
  }
120014
119889
  /**
120015
- *
120016
119890
  * Represents the types of data validation error.
120017
119891
  *
119892
+ * @remarks
120018
119893
  * [Api set: 1.1]
120019
119894
  */
120020
119895
  enum DataValidationErrorType {
120021
119896
  /**
120022
- *
120023
- * No error
120024
- *
119897
+ * No error.
119898
+ * @remarks
119899
+ * [Api set: 1.1]
120025
119900
  */
120026
119901
  none = "None",
120027
119902
  /**
120028
- *
120029
119903
  * Data does not have one of the mapped column.
120030
- *
119904
+ * @remarks
119905
+ * [Api set: 1.1]
120031
119906
  */
120032
119907
  columnNotMapped = "ColumnNotMapped",
120033
119908
  /**
120034
- *
120035
119909
  * UniqueId column has error.
120036
- *
119910
+ * @remarks
119911
+ * [Api set: 1.1]
120037
119912
  */
120038
119913
  uniqueIdColumnError = "UniqueIdColumnError",
120039
119914
  /**
120040
- *
120041
119915
  * Swim-lane column is empty.
120042
- *
119916
+ * @remarks
119917
+ * [Api set: 1.1]
120043
119918
  */
120044
119919
  swimlaneColumnError = "SwimlaneColumnError",
120045
119920
  /**
120046
- *
120047
119921
  * Delimiter can not have more then one character.
120048
- *
119922
+ * @remarks
119923
+ * [Api set: 1.1]
120049
119924
  */
120050
119925
  delimiterError = "DelimiterError",
120051
119926
  /**
120052
- *
120053
- * Connector column has error
120054
- *
119927
+ * Connector column has error.
119928
+ * @remarks
119929
+ * [Api set: 1.1]
120055
119930
  */
120056
119931
  connectorColumnError = "ConnectorColumnError",
120057
119932
  /**
120058
- *
120059
119933
  * Connector column is already mapped
120060
- to another setting
120061
- *
119934
+ to another setting.
119935
+ * @remarks
119936
+ * [Api set: 1.1]
120062
119937
  */
120063
119938
  connectorColumnMappedElsewhere = "ConnectorColumnMappedElsewhere",
120064
119939
  /**
120065
- *
120066
119940
  * Connector label column already mapped
120067
- to other setting
120068
- *
119941
+ to other setting.
119942
+ * @remarks
119943
+ * [Api set: 1.1]
120069
119944
  */
120070
119945
  connectorLabelColumnMappedElsewhere = "ConnectorLabelColumnMappedElsewhere",
120071
119946
  /**
120072
- *
120073
119947
  * Connector column and connector label column are
120074
- already mapped to other setting.
120075
- *
119948
+ already mapped to other setting.
119949
+ * @remarks
119950
+ * [Api set: 1.1]
120076
119951
  */
120077
119952
  connectorColumnAndConnectorLabelMappedElsewhere = "ConnectorColumnAndConnectorLabelMappedElsewhere",
120078
119953
  }
120079
119954
  /**
120080
- *
120081
119955
  * Direction of connector in DataVisualizer diagram.
120082
119956
  *
119957
+ * @remarks
120083
119958
  * [Api set: 1.1]
120084
119959
  */
120085
119960
  enum ConnectorDirection {
120086
119961
  /**
120087
- *
120088
119962
  * Direction will be from target to source shape.
120089
- *
119963
+ * @remarks
119964
+ * [Api set: 1.1]
120090
119965
  */
120091
119966
  fromTarget = "FromTarget",
120092
119967
  /**
120093
- *
120094
119968
  * Direction will be from source to target shape.
120095
- *
119969
+ * @remarks
119970
+ * [Api set: 1.1]
120096
119971
  */
120097
119972
  toTarget = "ToTarget",
120098
119973
  }
120099
119974
  /**
119975
+ * TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API, TaskPane State Changed, or similar events.
120100
119976
  *
120101
- * TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API/ TaskPane State Changed Event etc
120102
- *
119977
+ * @remarks
120103
119978
  * [Api set: 1.1]
120104
119979
  */
120105
119980
  enum TaskPaneType {
120106
119981
  /**
120107
- *
120108
- * None Type
120109
- *
119982
+ * No task pane.
119983
+ * @remarks
119984
+ * [Api set: 1.1]
120110
119985
  */
120111
119986
  none = "None",
120112
119987
  /**
120113
- *
120114
- * Data Visualizer Process Mapping Pane
120115
- *
119988
+ * Data Visualizer Process Mapping pane.
119989
+ * @remarks
119990
+ * [Api set: 1.1]
120116
119991
  */
120117
119992
  dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
120118
119993
  /**
120119
- *
120120
- * Data Visualizer Organisation Mapping Pane
120121
- *
119994
+ * Data Visualizer Organization Mapping pane.
119995
+ * @remarks
119996
+ * [Api set: 1.1]
120122
119997
  */
120123
119998
  dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
120124
119999
  }
120125
120000
  /**
120001
+ * MessageType represents the type of message when event is fired from Host.
120126
120002
  *
120127
- * EventType represents the type of the events Host supports
120003
+ * @remarks
120004
+ * [Api set: 1.1]
120005
+ */
120006
+ enum MessageType {
120007
+ /**
120008
+ * No message.
120009
+ * @remarks
120010
+ * [Api set: 1.1]
120011
+ */
120012
+ none = 0,
120013
+ /**
120014
+ * DataVisualizer diagram operation complete Event Message.
120015
+ * @remarks
120016
+ * [Api set: 1.1]
120017
+ */
120018
+ dataVisualizerDiagramOperationCompletedEvent = 1,
120019
+ }
120020
+ /**
120021
+ * EventType represents the type of the events Host supports.
120128
120022
  *
120023
+ * @remarks
120129
120024
  * [Api set: 1.1]
120130
120025
  */
120131
120026
  enum EventType {
120132
120027
  /**
120133
- *
120134
- * DataVisualizer diagram operation complete Event
120135
- *
120028
+ * DataVisualizer diagram operation complete Event.
120029
+ * @remarks
120030
+ * [Api set: 1.1]
120136
120031
  */
120137
120032
  dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
120138
120033
  }
@@ -120161,16 +120056,16 @@ declare namespace Visio {
120161
120056
  /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
120162
120057
  interface ApplicationUpdateData {
120163
120058
  /**
120059
+ * Shows or hides the iframe application borders.
120164
120060
  *
120165
- * Show or hide the iFrame application borders.
120166
- *
120061
+ * @remarks
120167
120062
  * [Api set: 1.1]
120168
120063
  */
120169
120064
  showBorders?: boolean;
120170
120065
  /**
120066
+ * Shows or hides the standard toolbars.
120171
120067
  *
120172
- * Show or hide the standard toolbars.
120173
- *
120068
+ * @remarks
120174
120069
  * [Api set: 1.1]
120175
120070
  */
120176
120071
  showToolbars?: boolean;
@@ -120178,16 +120073,16 @@ declare namespace Visio {
120178
120073
  /** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
120179
120074
  interface DocumentUpdateData {
120180
120075
  /**
120181
- *
120182
120076
  * Represents a Visio application instance that contains this document.
120183
120077
  *
120078
+ * @remarks
120184
120079
  * [Api set: 1.1]
120185
120080
  */
120186
120081
  application?: Visio.Interfaces.ApplicationUpdateData;
120187
120082
  /**
120188
- *
120189
120083
  * Returns the DocumentView object.
120190
120084
  *
120085
+ * @remarks
120191
120086
  * [Api set: 1.1]
120192
120087
  */
120193
120088
  view?: Visio.Interfaces.DocumentViewUpdateData;
@@ -120195,37 +120090,37 @@ declare namespace Visio {
120195
120090
  /** An interface for updating data on the DocumentView object, for use in `documentView.set({ ... })`. */
120196
120091
  interface DocumentViewUpdateData {
120197
120092
  /**
120198
- *
120199
120093
  * Disable Hyperlinks.
120200
120094
  *
120095
+ * @remarks
120201
120096
  * [Api set: 1.1]
120202
120097
  */
120203
120098
  disableHyperlinks?: boolean;
120204
120099
  /**
120205
- *
120206
120100
  * Disable Pan.
120207
120101
  *
120102
+ * @remarks
120208
120103
  * [Api set: 1.1]
120209
120104
  */
120210
120105
  disablePan?: boolean;
120211
120106
  /**
120212
- *
120213
120107
  * Disable PanZoomWindow.
120214
120108
  *
120109
+ * @remarks
120215
120110
  * [Api set: 1.1]
120216
120111
  */
120217
120112
  disablePanZoomWindow?: boolean;
120218
120113
  /**
120219
- *
120220
120114
  * Disable Zoom.
120221
120115
  *
120116
+ * @remarks
120222
120117
  * [Api set: 1.1]
120223
120118
  */
120224
120119
  disableZoom?: boolean;
120225
120120
  /**
120226
- *
120227
120121
  * Hide Diagram Boundary.
120228
120122
  *
120123
+ * @remarks
120229
120124
  * [Api set: 1.1]
120230
120125
  */
120231
120126
  hideDiagramBoundary?: boolean;
@@ -120233,9 +120128,9 @@ declare namespace Visio {
120233
120128
  /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
120234
120129
  interface PageUpdateData {
120235
120130
  /**
120236
- *
120237
120131
  * Returns the view of the page.
120238
120132
  *
120133
+ * @remarks
120239
120134
  * [Api set: 1.1]
120240
120135
  */
120241
120136
  view?: Visio.Interfaces.PageViewUpdateData;
@@ -120243,9 +120138,9 @@ declare namespace Visio {
120243
120138
  /** An interface for updating data on the PageView object, for use in `pageView.set({ ... })`. */
120244
120139
  interface PageViewUpdateData {
120245
120140
  /**
120141
+ * Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120246
120142
  *
120247
- * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120248
- *
120143
+ * @remarks
120249
120144
  * [Api set: 1.1]
120250
120145
  */
120251
120146
  zoom?: number;
@@ -120261,16 +120156,16 @@ declare namespace Visio {
120261
120156
  /** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
120262
120157
  interface ShapeUpdateData {
120263
120158
  /**
120264
- *
120265
120159
  * Returns the view of the shape.
120266
120160
  *
120161
+ * @remarks
120267
120162
  * [Api set: 1.1]
120268
120163
  */
120269
120164
  view?: Visio.Interfaces.ShapeViewUpdateData;
120270
120165
  /**
120271
- *
120272
120166
  * Returns true, if shape is selected. User can set true to select the shape explicitly.
120273
120167
  *
120168
+ * @remarks
120274
120169
  * [Api set: 1.1]
120275
120170
  */
120276
120171
  select?: boolean;
@@ -120278,9 +120173,9 @@ declare namespace Visio {
120278
120173
  /** An interface for updating data on the ShapeView object, for use in `shapeView.set({ ... })`. */
120279
120174
  interface ShapeViewUpdateData {
120280
120175
  /**
120281
- *
120282
120176
  * Represents the highlight around the shape.
120283
120177
  *
120178
+ * @remarks
120284
120179
  * [Api set: 1.1]
120285
120180
  */
120286
120181
  highlight?: Visio.Highlight;
@@ -120300,23 +120195,23 @@ declare namespace Visio {
120300
120195
  /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
120301
120196
  interface CommentUpdateData {
120302
120197
  /**
120303
- *
120304
120198
  * A string that specifies the name of the author of the comment.
120305
120199
  *
120200
+ * @remarks
120306
120201
  * [Api set: 1.1]
120307
120202
  */
120308
120203
  author?: string;
120309
120204
  /**
120310
- *
120311
120205
  * A string that specifies the date when the comment was created.
120312
120206
  *
120207
+ * @remarks
120313
120208
  * [Api set: 1.1]
120314
120209
  */
120315
120210
  date?: string;
120316
120211
  /**
120317
- *
120318
120212
  * A string that contains the comment text.
120319
120213
  *
120214
+ * @remarks
120320
120215
  * [Api set: 1.1]
120321
120216
  */
120322
120217
  text?: string;
@@ -120324,16 +120219,16 @@ declare namespace Visio {
120324
120219
  /** An interface describing the data returned by calling `application.toJSON()`. */
120325
120220
  interface ApplicationData {
120326
120221
  /**
120222
+ * Shows or hides the iframe application borders.
120327
120223
  *
120328
- * Show or hide the iFrame application borders.
120329
- *
120224
+ * @remarks
120330
120225
  * [Api set: 1.1]
120331
120226
  */
120332
120227
  showBorders?: boolean;
120333
120228
  /**
120229
+ * Shows or hides the standard toolbars.
120334
120230
  *
120335
- * Show or hide the standard toolbars.
120336
- *
120231
+ * @remarks
120337
120232
  * [Api set: 1.1]
120338
120233
  */
120339
120234
  showToolbars?: boolean;
@@ -120341,23 +120236,23 @@ declare namespace Visio {
120341
120236
  /** An interface describing the data returned by calling `document.toJSON()`. */
120342
120237
  interface DocumentData {
120343
120238
  /**
120239
+ * Represents a Visio application instance that contains this document.
120344
120240
  *
120345
- * Represents a Visio application instance that contains this document. Read-only.
120346
- *
120241
+ * @remarks
120347
120242
  * [Api set: 1.1]
120348
120243
  */
120349
120244
  application?: Visio.Interfaces.ApplicationData;
120350
120245
  /**
120246
+ * Represents a collection of pages associated with the document.
120351
120247
  *
120352
- * Represents a collection of pages associated with the document. Read-only.
120353
- *
120248
+ * @remarks
120354
120249
  * [Api set: 1.1]
120355
120250
  */
120356
120251
  pages?: Visio.Interfaces.PageData[];
120357
120252
  /**
120253
+ * Returns the DocumentView object.
120358
120254
  *
120359
- * Returns the DocumentView object. Read-only.
120360
- *
120255
+ * @remarks
120361
120256
  * [Api set: 1.1]
120362
120257
  */
120363
120258
  view?: Visio.Interfaces.DocumentViewData;
@@ -120365,37 +120260,37 @@ declare namespace Visio {
120365
120260
  /** An interface describing the data returned by calling `documentView.toJSON()`. */
120366
120261
  interface DocumentViewData {
120367
120262
  /**
120368
- *
120369
120263
  * Disable Hyperlinks.
120370
120264
  *
120265
+ * @remarks
120371
120266
  * [Api set: 1.1]
120372
120267
  */
120373
120268
  disableHyperlinks?: boolean;
120374
120269
  /**
120375
- *
120376
120270
  * Disable Pan.
120377
120271
  *
120272
+ * @remarks
120378
120273
  * [Api set: 1.1]
120379
120274
  */
120380
120275
  disablePan?: boolean;
120381
120276
  /**
120382
- *
120383
120277
  * Disable PanZoomWindow.
120384
120278
  *
120279
+ * @remarks
120385
120280
  * [Api set: 1.1]
120386
120281
  */
120387
120282
  disablePanZoomWindow?: boolean;
120388
120283
  /**
120389
- *
120390
120284
  * Disable Zoom.
120391
120285
  *
120286
+ * @remarks
120392
120287
  * [Api set: 1.1]
120393
120288
  */
120394
120289
  disableZoom?: boolean;
120395
120290
  /**
120396
- *
120397
120291
  * Hide Diagram Boundary.
120398
120292
  *
120293
+ * @remarks
120399
120294
  * [Api set: 1.1]
120400
120295
  */
120401
120296
  hideDiagramBoundary?: boolean;
@@ -120403,65 +120298,65 @@ declare namespace Visio {
120403
120298
  /** An interface describing the data returned by calling `page.toJSON()`. */
120404
120299
  interface PageData {
120405
120300
  /**
120301
+ * All shapes in the Page, including subshapes.
120406
120302
  *
120407
- * All shapes in the Page, including subshapes. Read-only.
120408
- *
120303
+ * @remarks
120409
120304
  * [Api set: 1.1]
120410
120305
  */
120411
120306
  allShapes?: Visio.Interfaces.ShapeData[];
120412
120307
  /**
120308
+ * Returns the Comments Collection.
120413
120309
  *
120414
- * Returns the Comments Collection. Read-only.
120415
- *
120310
+ * @remarks
120416
120311
  * [Api set: 1.1]
120417
120312
  */
120418
120313
  comments?: Visio.Interfaces.CommentData[];
120419
120314
  /**
120315
+ * All top-level shapes in the Page.
120420
120316
  *
120421
- * All top-level shapes in the Page.Read-only.
120422
- *
120317
+ * @remarks
120423
120318
  * [Api set: 1.1]
120424
120319
  */
120425
120320
  shapes?: Visio.Interfaces.ShapeData[];
120426
120321
  /**
120322
+ * Returns the view of the page.
120427
120323
  *
120428
- * Returns the view of the page. Read-only.
120429
- *
120324
+ * @remarks
120430
120325
  * [Api set: 1.1]
120431
120326
  */
120432
120327
  view?: Visio.Interfaces.PageViewData;
120433
120328
  /**
120329
+ * Returns the height of the page.
120434
120330
  *
120435
- * Returns the height of the page. Read-only.
120436
- *
120331
+ * @remarks
120437
120332
  * [Api set: 1.1]
120438
120333
  */
120439
120334
  height?: number;
120440
120335
  /**
120336
+ * Index of the Page.
120441
120337
  *
120442
- * Index of the Page. Read-only.
120443
- *
120338
+ * @remarks
120444
120339
  * [Api set: 1.1]
120445
120340
  */
120446
120341
  index?: number;
120447
120342
  /**
120343
+ * Whether the page is a background page or not.
120448
120344
  *
120449
- * Whether the page is a background page or not. Read-only.
120450
- *
120345
+ * @remarks
120451
120346
  * [Api set: 1.1]
120452
120347
  */
120453
120348
  isBackground?: boolean;
120454
120349
  /**
120350
+ * Page name.
120455
120351
  *
120456
- * Page name. Read-only.
120457
- *
120352
+ * @remarks
120458
120353
  * [Api set: 1.1]
120459
120354
  */
120460
120355
  name?: string;
120461
120356
  /**
120357
+ * Returns the width of the page.
120462
120358
  *
120463
- * Returns the width of the page. Read-only.
120464
- *
120359
+ * @remarks
120465
120360
  * [Api set: 1.1]
120466
120361
  */
120467
120362
  width?: number;
@@ -120469,9 +120364,9 @@ declare namespace Visio {
120469
120364
  /** An interface describing the data returned by calling `pageView.toJSON()`. */
120470
120365
  interface PageViewData {
120471
120366
  /**
120367
+ * Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120472
120368
  *
120473
- * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120474
- *
120369
+ * @remarks
120475
120370
  * [Api set: 1.1]
120476
120371
  */
120477
120372
  zoom?: number;
@@ -120487,65 +120382,65 @@ declare namespace Visio {
120487
120382
  /** An interface describing the data returned by calling `shape.toJSON()`. */
120488
120383
  interface ShapeData {
120489
120384
  /**
120385
+ * Returns the Comments Collection.
120490
120386
  *
120491
- * Returns the Comments Collection. Read-only.
120492
- *
120387
+ * @remarks
120493
120388
  * [Api set: 1.1]
120494
120389
  */
120495
120390
  comments?: Visio.Interfaces.CommentData[];
120496
120391
  /**
120392
+ * Returns the Hyperlinks collection for a Shape object.
120497
120393
  *
120498
- * Returns the Hyperlinks collection for a Shape object. Read-only.
120499
- *
120394
+ * @remarks
120500
120395
  * [Api set: 1.1]
120501
120396
  */
120502
120397
  hyperlinks?: Visio.Interfaces.HyperlinkData[];
120503
120398
  /**
120399
+ * Returns the Shape's Data Section.
120504
120400
  *
120505
- * Returns the Shape's Data Section. Read-only.
120506
- *
120401
+ * @remarks
120507
120402
  * [Api set: 1.1]
120508
120403
  */
120509
120404
  shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
120510
120405
  /**
120406
+ * Gets SubShape Collection.
120511
120407
  *
120512
- * Gets SubShape Collection. Read-only.
120513
- *
120408
+ * @remarks
120514
120409
  * [Api set: 1.1]
120515
120410
  */
120516
120411
  subShapes?: Visio.Interfaces.ShapeData[];
120517
120412
  /**
120413
+ * Returns the view of the shape.
120518
120414
  *
120519
- * Returns the view of the shape. Read-only.
120520
- *
120415
+ * @remarks
120521
120416
  * [Api set: 1.1]
120522
120417
  */
120523
120418
  view?: Visio.Interfaces.ShapeViewData;
120524
120419
  /**
120420
+ * Shape's identifier.
120525
120421
  *
120526
- * Shape's identifier. Read-only.
120527
- *
120422
+ * @remarks
120528
120423
  * [Api set: 1.1]
120529
120424
  */
120530
120425
  id?: number;
120531
120426
  /**
120427
+ * Shape's name.
120532
120428
  *
120533
- * Shape's name. Read-only.
120534
- *
120429
+ * @remarks
120535
120430
  * [Api set: 1.1]
120536
120431
  */
120537
120432
  name?: string;
120538
120433
  /**
120539
- *
120540
120434
  * Returns true, if shape is selected. User can set true to select the shape explicitly.
120541
120435
  *
120436
+ * @remarks
120542
120437
  * [Api set: 1.1]
120543
120438
  */
120544
120439
  select?: boolean;
120545
120440
  /**
120441
+ * Shape's text.
120546
120442
  *
120547
- * Shape's text. Read-only.
120548
- *
120443
+ * @remarks
120549
120444
  * [Api set: 1.1]
120550
120445
  */
120551
120446
  text?: string;
@@ -120553,9 +120448,9 @@ declare namespace Visio {
120553
120448
  /** An interface describing the data returned by calling `shapeView.toJSON()`. */
120554
120449
  interface ShapeViewData {
120555
120450
  /**
120556
- *
120557
120451
  * Represents the highlight around the shape.
120558
120452
  *
120453
+ * @remarks
120559
120454
  * [Api set: 1.1]
120560
120455
  */
120561
120456
  highlight?: Visio.Highlight;
@@ -120567,30 +120462,30 @@ declare namespace Visio {
120567
120462
  /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
120568
120463
  interface ShapeDataItemData {
120569
120464
  /**
120465
+ * A string that specifies the format of the shape data item.
120570
120466
  *
120571
- * A string that specifies the format of the shape data item. Read-only.
120572
- *
120467
+ * @remarks
120573
120468
  * [Api set: 1.1]
120574
120469
  */
120575
120470
  format?: string;
120576
120471
  /**
120472
+ * A string that specifies the formatted value of the shape data item.
120577
120473
  *
120578
- * A string that specifies the formatted value of the shape data item. Read-only.
120579
- *
120474
+ * @remarks
120580
120475
  * [Api set: 1.1]
120581
120476
  */
120582
120477
  formattedValue?: string;
120583
120478
  /**
120479
+ * A string that specifies the label of the shape data item.
120584
120480
  *
120585
- * A string that specifies the label of the shape data item. Read-only.
120586
- *
120481
+ * @remarks
120587
120482
  * [Api set: 1.1]
120588
120483
  */
120589
120484
  label?: string;
120590
120485
  /**
120486
+ * A string that specifies the value of the shape data item.
120591
120487
  *
120592
- * A string that specifies the value of the shape data item. Read-only.
120593
- *
120488
+ * @remarks
120594
120489
  * [Api set: 1.1]
120595
120490
  */
120596
120491
  value?: string;
@@ -120602,30 +120497,30 @@ declare namespace Visio {
120602
120497
  /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
120603
120498
  interface HyperlinkData {
120604
120499
  /**
120500
+ * Gets the address of the Hyperlink object.
120605
120501
  *
120606
- * Gets the address of the Hyperlink object. Read-only.
120607
- *
120502
+ * @remarks
120608
120503
  * [Api set: 1.1]
120609
120504
  */
120610
120505
  address?: string;
120611
120506
  /**
120507
+ * Gets the description of a hyperlink.
120612
120508
  *
120613
- * Gets the description of a hyperlink. Read-only.
120614
- *
120509
+ * @remarks
120615
120510
  * [Api set: 1.1]
120616
120511
  */
120617
120512
  description?: string;
120618
120513
  /**
120514
+ * Gets the extra URL request information used to resolve the hyperlink's URL.
120619
120515
  *
120620
- * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
120621
- *
120516
+ * @remarks
120622
120517
  * [Api set: 1.1]
120623
120518
  */
120624
120519
  extraInfo?: string;
120625
120520
  /**
120521
+ * Gets the sub-address of the Hyperlink object.
120626
120522
  *
120627
- * Gets the sub-address of the Hyperlink object. Read-only.
120628
- *
120523
+ * @remarks
120629
120524
  * [Api set: 1.1]
120630
120525
  */
120631
120526
  subAddress?: string;
@@ -120637,23 +120532,23 @@ declare namespace Visio {
120637
120532
  /** An interface describing the data returned by calling `comment.toJSON()`. */
120638
120533
  interface CommentData {
120639
120534
  /**
120640
- *
120641
120535
  * A string that specifies the name of the author of the comment.
120642
120536
  *
120537
+ * @remarks
120643
120538
  * [Api set: 1.1]
120644
120539
  */
120645
120540
  author?: string;
120646
120541
  /**
120647
- *
120648
120542
  * A string that specifies the date when the comment was created.
120649
120543
  *
120544
+ * @remarks
120650
120545
  * [Api set: 1.1]
120651
120546
  */
120652
120547
  date?: string;
120653
120548
  /**
120654
- *
120655
120549
  * A string that contains the comment text.
120656
120550
  *
120551
+ * @remarks
120657
120552
  * [Api set: 1.1]
120658
120553
  */
120659
120554
  text?: string;
@@ -120661,17 +120556,17 @@ declare namespace Visio {
120661
120556
  /** An interface describing the data returned by calling `selection.toJSON()`. */
120662
120557
  interface SelectionData {
120663
120558
  /**
120559
+ * Gets the Shapes of the Selection.
120664
120560
  *
120665
- * Gets the Shapes of the Selection. Read-only.
120666
- *
120561
+ * @remarks
120667
120562
  * [Api set: 1.1]
120668
120563
  */
120669
120564
  shapes?: Visio.Interfaces.ShapeData[];
120670
120565
  }
120671
120566
  /**
120672
- *
120673
120567
  * Represents the Application.
120674
120568
  *
120569
+ * @remarks
120675
120570
  * [Api set: 1.1]
120676
120571
  */
120677
120572
  interface ApplicationLoadOptions {
@@ -120680,24 +120575,24 @@ declare namespace Visio {
120680
120575
  */
120681
120576
  $all?: boolean;
120682
120577
  /**
120578
+ * Shows or hides the iframe application borders.
120683
120579
  *
120684
- * Show or hide the iFrame application borders.
120685
- *
120580
+ * @remarks
120686
120581
  * [Api set: 1.1]
120687
120582
  */
120688
120583
  showBorders?: boolean;
120689
120584
  /**
120585
+ * Shows or hides the standard toolbars.
120690
120586
  *
120691
- * Show or hide the standard toolbars.
120692
- *
120587
+ * @remarks
120693
120588
  * [Api set: 1.1]
120694
120589
  */
120695
120590
  showToolbars?: boolean;
120696
120591
  }
120697
120592
  /**
120698
- *
120699
120593
  * Represents the Document class.
120700
120594
  *
120595
+ * @remarks
120701
120596
  * [Api set: 1.1]
120702
120597
  */
120703
120598
  interface DocumentLoadOptions {
@@ -120706,24 +120601,24 @@ declare namespace Visio {
120706
120601
  */
120707
120602
  $all?: boolean;
120708
120603
  /**
120709
- *
120710
120604
  * Represents a Visio application instance that contains this document.
120711
120605
  *
120606
+ * @remarks
120712
120607
  * [Api set: 1.1]
120713
120608
  */
120714
120609
  application?: Visio.Interfaces.ApplicationLoadOptions;
120715
120610
  /**
120716
- *
120717
120611
  * Returns the DocumentView object.
120718
120612
  *
120613
+ * @remarks
120719
120614
  * [Api set: 1.1]
120720
120615
  */
120721
120616
  view?: Visio.Interfaces.DocumentViewLoadOptions;
120722
120617
  }
120723
120618
  /**
120724
- *
120725
120619
  * Represents the DocumentView class.
120726
120620
  *
120621
+ * @remarks
120727
120622
  * [Api set: 1.1]
120728
120623
  */
120729
120624
  interface DocumentViewLoadOptions {
@@ -120732,45 +120627,45 @@ declare namespace Visio {
120732
120627
  */
120733
120628
  $all?: boolean;
120734
120629
  /**
120735
- *
120736
120630
  * Disable Hyperlinks.
120737
120631
  *
120632
+ * @remarks
120738
120633
  * [Api set: 1.1]
120739
120634
  */
120740
120635
  disableHyperlinks?: boolean;
120741
120636
  /**
120742
- *
120743
120637
  * Disable Pan.
120744
120638
  *
120639
+ * @remarks
120745
120640
  * [Api set: 1.1]
120746
120641
  */
120747
120642
  disablePan?: boolean;
120748
120643
  /**
120749
- *
120750
120644
  * Disable PanZoomWindow.
120751
120645
  *
120646
+ * @remarks
120752
120647
  * [Api set: 1.1]
120753
120648
  */
120754
120649
  disablePanZoomWindow?: boolean;
120755
120650
  /**
120756
- *
120757
120651
  * Disable Zoom.
120758
120652
  *
120653
+ * @remarks
120759
120654
  * [Api set: 1.1]
120760
120655
  */
120761
120656
  disableZoom?: boolean;
120762
120657
  /**
120763
- *
120764
120658
  * Hide Diagram Boundary.
120765
120659
  *
120660
+ * @remarks
120766
120661
  * [Api set: 1.1]
120767
120662
  */
120768
120663
  hideDiagramBoundary?: boolean;
120769
120664
  }
120770
120665
  /**
120771
- *
120772
120666
  * Represents the Page class.
120773
120667
  *
120668
+ * @remarks
120774
120669
  * [Api set: 1.1]
120775
120670
  */
120776
120671
  interface PageLoadOptions {
@@ -120779,52 +120674,52 @@ declare namespace Visio {
120779
120674
  */
120780
120675
  $all?: boolean;
120781
120676
  /**
120782
- *
120783
120677
  * Returns the view of the page.
120784
120678
  *
120679
+ * @remarks
120785
120680
  * [Api set: 1.1]
120786
120681
  */
120787
120682
  view?: Visio.Interfaces.PageViewLoadOptions;
120788
120683
  /**
120684
+ * Returns the height of the page.
120789
120685
  *
120790
- * Returns the height of the page. Read-only.
120791
- *
120686
+ * @remarks
120792
120687
  * [Api set: 1.1]
120793
120688
  */
120794
120689
  height?: boolean;
120795
120690
  /**
120691
+ * Index of the Page.
120796
120692
  *
120797
- * Index of the Page. Read-only.
120798
- *
120693
+ * @remarks
120799
120694
  * [Api set: 1.1]
120800
120695
  */
120801
120696
  index?: boolean;
120802
120697
  /**
120698
+ * Whether the page is a background page or not.
120803
120699
  *
120804
- * Whether the page is a background page or not. Read-only.
120805
- *
120700
+ * @remarks
120806
120701
  * [Api set: 1.1]
120807
120702
  */
120808
120703
  isBackground?: boolean;
120809
120704
  /**
120705
+ * Page name.
120810
120706
  *
120811
- * Page name. Read-only.
120812
- *
120707
+ * @remarks
120813
120708
  * [Api set: 1.1]
120814
120709
  */
120815
120710
  name?: boolean;
120816
120711
  /**
120712
+ * Returns the width of the page.
120817
120713
  *
120818
- * Returns the width of the page. Read-only.
120819
- *
120714
+ * @remarks
120820
120715
  * [Api set: 1.1]
120821
120716
  */
120822
120717
  width?: boolean;
120823
120718
  }
120824
120719
  /**
120825
- *
120826
120720
  * Represents the PageView class.
120827
120721
  *
120722
+ * @remarks
120828
120723
  * [Api set: 1.1]
120829
120724
  */
120830
120725
  interface PageViewLoadOptions {
@@ -120833,17 +120728,17 @@ declare namespace Visio {
120833
120728
  */
120834
120729
  $all?: boolean;
120835
120730
  /**
120731
+ * Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120836
120732
  *
120837
- * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
120838
- *
120733
+ * @remarks
120839
120734
  * [Api set: 1.1]
120840
120735
  */
120841
120736
  zoom?: boolean;
120842
120737
  }
120843
120738
  /**
120844
- *
120845
120739
  * Represents a collection of Page objects that are part of the document.
120846
120740
  *
120741
+ * @remarks
120847
120742
  * [Api set: 1.1]
120848
120743
  */
120849
120744
  interface PageCollectionLoadOptions {
@@ -120852,52 +120747,52 @@ declare namespace Visio {
120852
120747
  */
120853
120748
  $all?: boolean;
120854
120749
  /**
120855
- *
120856
120750
  * For EACH ITEM in the collection: Returns the view of the page.
120857
120751
  *
120752
+ * @remarks
120858
120753
  * [Api set: 1.1]
120859
120754
  */
120860
120755
  view?: Visio.Interfaces.PageViewLoadOptions;
120861
120756
  /**
120757
+ * For EACH ITEM in the collection: Returns the height of the page.
120862
120758
  *
120863
- * For EACH ITEM in the collection: Returns the height of the page. Read-only.
120864
- *
120759
+ * @remarks
120865
120760
  * [Api set: 1.1]
120866
120761
  */
120867
120762
  height?: boolean;
120868
120763
  /**
120764
+ * For EACH ITEM in the collection: Index of the Page.
120869
120765
  *
120870
- * For EACH ITEM in the collection: Index of the Page. Read-only.
120871
- *
120766
+ * @remarks
120872
120767
  * [Api set: 1.1]
120873
120768
  */
120874
120769
  index?: boolean;
120875
120770
  /**
120771
+ * For EACH ITEM in the collection: Whether the page is a background page or not.
120876
120772
  *
120877
- * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
120878
- *
120773
+ * @remarks
120879
120774
  * [Api set: 1.1]
120880
120775
  */
120881
120776
  isBackground?: boolean;
120882
120777
  /**
120778
+ * For EACH ITEM in the collection: Page name.
120883
120779
  *
120884
- * For EACH ITEM in the collection: Page name. Read-only.
120885
- *
120780
+ * @remarks
120886
120781
  * [Api set: 1.1]
120887
120782
  */
120888
120783
  name?: boolean;
120889
120784
  /**
120785
+ * For EACH ITEM in the collection: Returns the width of the page.
120890
120786
  *
120891
- * For EACH ITEM in the collection: Returns the width of the page. Read-only.
120892
- *
120787
+ * @remarks
120893
120788
  * [Api set: 1.1]
120894
120789
  */
120895
120790
  width?: boolean;
120896
120791
  }
120897
120792
  /**
120898
- *
120899
120793
  * Represents the Shape Collection.
120900
120794
  *
120795
+ * @remarks
120901
120796
  * [Api set: 1.1]
120902
120797
  */
120903
120798
  interface ShapeCollectionLoadOptions {
@@ -120906,52 +120801,45 @@ declare namespace Visio {
120906
120801
  */
120907
120802
  $all?: boolean;
120908
120803
  /**
120909
- *
120910
120804
  * For EACH ITEM in the collection: Returns the view of the shape.
120911
120805
  *
120806
+ * @remarks
120912
120807
  * [Api set: 1.1]
120913
120808
  */
120914
120809
  view?: Visio.Interfaces.ShapeViewLoadOptions;
120915
120810
  /**
120811
+ * For EACH ITEM in the collection: Shape's identifier.
120916
120812
  *
120917
- * For EACH ITEM in the collection: Shape's identifier. Read-only.
120918
- *
120813
+ * @remarks
120919
120814
  * [Api set: 1.1]
120920
120815
  */
120921
120816
  id?: boolean;
120922
120817
  /**
120818
+ * For EACH ITEM in the collection: Shape's name.
120923
120819
  *
120924
- * For EACH ITEM in the collection: Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
120925
- *
120926
- * [Api set: 1.1]
120927
- */
120928
- isBoundToData?: boolean;
120929
- /**
120930
- *
120931
- * For EACH ITEM in the collection: Shape's name. Read-only.
120932
- *
120820
+ * @remarks
120933
120821
  * [Api set: 1.1]
120934
120822
  */
120935
120823
  name?: boolean;
120936
120824
  /**
120937
- *
120938
120825
  * For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
120939
120826
  *
120827
+ * @remarks
120940
120828
  * [Api set: 1.1]
120941
120829
  */
120942
120830
  select?: boolean;
120943
120831
  /**
120832
+ * For EACH ITEM in the collection: Shape's text.
120944
120833
  *
120945
- * For EACH ITEM in the collection: Shape's text. Read-only.
120946
- *
120834
+ * @remarks
120947
120835
  * [Api set: 1.1]
120948
120836
  */
120949
120837
  text?: boolean;
120950
120838
  }
120951
120839
  /**
120952
- *
120953
120840
  * Represents the Shape class.
120954
120841
  *
120842
+ * @remarks
120955
120843
  * [Api set: 1.1]
120956
120844
  */
120957
120845
  interface ShapeLoadOptions {
@@ -120960,52 +120848,45 @@ declare namespace Visio {
120960
120848
  */
120961
120849
  $all?: boolean;
120962
120850
  /**
120963
- *
120964
120851
  * Returns the view of the shape.
120965
120852
  *
120853
+ * @remarks
120966
120854
  * [Api set: 1.1]
120967
120855
  */
120968
120856
  view?: Visio.Interfaces.ShapeViewLoadOptions;
120969
120857
  /**
120858
+ * Shape's identifier.
120970
120859
  *
120971
- * Shape's identifier. Read-only.
120972
- *
120860
+ * @remarks
120973
120861
  * [Api set: 1.1]
120974
120862
  */
120975
120863
  id?: boolean;
120976
120864
  /**
120865
+ * Shape's name.
120977
120866
  *
120978
- * Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
120979
- *
120980
- * [Api set: 1.1]
120981
- */
120982
- isBoundToData?: boolean;
120983
- /**
120984
- *
120985
- * Shape's name. Read-only.
120986
- *
120867
+ * @remarks
120987
120868
  * [Api set: 1.1]
120988
120869
  */
120989
120870
  name?: boolean;
120990
120871
  /**
120991
- *
120992
120872
  * Returns true, if shape is selected. User can set true to select the shape explicitly.
120993
120873
  *
120874
+ * @remarks
120994
120875
  * [Api set: 1.1]
120995
120876
  */
120996
120877
  select?: boolean;
120997
120878
  /**
120879
+ * Shape's text.
120998
120880
  *
120999
- * Shape's text. Read-only.
121000
- *
120881
+ * @remarks
121001
120882
  * [Api set: 1.1]
121002
120883
  */
121003
120884
  text?: boolean;
121004
120885
  }
121005
120886
  /**
121006
- *
121007
120887
  * Represents the ShapeView class.
121008
120888
  *
120889
+ * @remarks
121009
120890
  * [Api set: 1.1]
121010
120891
  */
121011
120892
  interface ShapeViewLoadOptions {
@@ -121014,17 +120895,17 @@ declare namespace Visio {
121014
120895
  */
121015
120896
  $all?: boolean;
121016
120897
  /**
121017
- *
121018
120898
  * Represents the highlight around the shape.
121019
120899
  *
120900
+ * @remarks
121020
120901
  * [Api set: 1.1]
121021
120902
  */
121022
120903
  highlight?: boolean;
121023
120904
  }
121024
120905
  /**
121025
- *
121026
120906
  * Represents the ShapeDataItemCollection for a given Shape.
121027
120907
  *
120908
+ * @remarks
121028
120909
  * [Api set: 1.1]
121029
120910
  */
121030
120911
  interface ShapeDataItemCollectionLoadOptions {
@@ -121033,38 +120914,38 @@ declare namespace Visio {
121033
120914
  */
121034
120915
  $all?: boolean;
121035
120916
  /**
120917
+ * For EACH ITEM in the collection: A string that specifies the format of the shape data item.
121036
120918
  *
121037
- * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.
121038
- *
120919
+ * @remarks
121039
120920
  * [Api set: 1.1]
121040
120921
  */
121041
120922
  format?: boolean;
121042
120923
  /**
120924
+ * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.
121043
120925
  *
121044
- * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.
121045
- *
120926
+ * @remarks
121046
120927
  * [Api set: 1.1]
121047
120928
  */
121048
120929
  formattedValue?: boolean;
121049
120930
  /**
120931
+ * For EACH ITEM in the collection: A string that specifies the label of the shape data item.
121050
120932
  *
121051
- * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.
121052
- *
120933
+ * @remarks
121053
120934
  * [Api set: 1.1]
121054
120935
  */
121055
120936
  label?: boolean;
121056
120937
  /**
120938
+ * For EACH ITEM in the collection: A string that specifies the value of the shape data item.
121057
120939
  *
121058
- * For EACH ITEM in the collection: A string that specifies the value of the shape data item. Read-only.
121059
- *
120940
+ * @remarks
121060
120941
  * [Api set: 1.1]
121061
120942
  */
121062
120943
  value?: boolean;
121063
120944
  }
121064
120945
  /**
121065
- *
121066
120946
  * Represents the ShapeDataItem.
121067
120947
  *
120948
+ * @remarks
121068
120949
  * [Api set: 1.1]
121069
120950
  */
121070
120951
  interface ShapeDataItemLoadOptions {
@@ -121073,38 +120954,38 @@ declare namespace Visio {
121073
120954
  */
121074
120955
  $all?: boolean;
121075
120956
  /**
120957
+ * A string that specifies the format of the shape data item.
121076
120958
  *
121077
- * A string that specifies the format of the shape data item. Read-only.
121078
- *
120959
+ * @remarks
121079
120960
  * [Api set: 1.1]
121080
120961
  */
121081
120962
  format?: boolean;
121082
120963
  /**
120964
+ * A string that specifies the formatted value of the shape data item.
121083
120965
  *
121084
- * A string that specifies the formatted value of the shape data item. Read-only.
121085
- *
120966
+ * @remarks
121086
120967
  * [Api set: 1.1]
121087
120968
  */
121088
120969
  formattedValue?: boolean;
121089
120970
  /**
120971
+ * A string that specifies the label of the shape data item.
121090
120972
  *
121091
- * A string that specifies the label of the shape data item. Read-only.
121092
- *
120973
+ * @remarks
121093
120974
  * [Api set: 1.1]
121094
120975
  */
121095
120976
  label?: boolean;
121096
120977
  /**
120978
+ * A string that specifies the value of the shape data item.
121097
120979
  *
121098
- * A string that specifies the value of the shape data item. Read-only.
121099
- *
120980
+ * @remarks
121100
120981
  * [Api set: 1.1]
121101
120982
  */
121102
120983
  value?: boolean;
121103
120984
  }
121104
120985
  /**
121105
- *
121106
120986
  * Represents the Hyperlink Collection.
121107
120987
  *
120988
+ * @remarks
121108
120989
  * [Api set: 1.1]
121109
120990
  */
121110
120991
  interface HyperlinkCollectionLoadOptions {
@@ -121113,38 +120994,38 @@ declare namespace Visio {
121113
120994
  */
121114
120995
  $all?: boolean;
121115
120996
  /**
120997
+ * For EACH ITEM in the collection: Gets the address of the Hyperlink object.
121116
120998
  *
121117
- * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.
121118
- *
120999
+ * @remarks
121119
121000
  * [Api set: 1.1]
121120
121001
  */
121121
121002
  address?: boolean;
121122
121003
  /**
121004
+ * For EACH ITEM in the collection: Gets the description of a hyperlink.
121123
121005
  *
121124
- * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.
121125
- *
121006
+ * @remarks
121126
121007
  * [Api set: 1.1]
121127
121008
  */
121128
121009
  description?: boolean;
121129
121010
  /**
121011
+ * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL.
121130
121012
  *
121131
- * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
121132
- *
121013
+ * @remarks
121133
121014
  * [Api set: 1.1]
121134
121015
  */
121135
121016
  extraInfo?: boolean;
121136
121017
  /**
121018
+ * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.
121137
121019
  *
121138
- * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.
121139
- *
121020
+ * @remarks
121140
121021
  * [Api set: 1.1]
121141
121022
  */
121142
121023
  subAddress?: boolean;
121143
121024
  }
121144
121025
  /**
121145
- *
121146
121026
  * Represents the Hyperlink.
121147
121027
  *
121028
+ * @remarks
121148
121029
  * [Api set: 1.1]
121149
121030
  */
121150
121031
  interface HyperlinkLoadOptions {
@@ -121153,38 +121034,38 @@ declare namespace Visio {
121153
121034
  */
121154
121035
  $all?: boolean;
121155
121036
  /**
121037
+ * Gets the address of the Hyperlink object.
121156
121038
  *
121157
- * Gets the address of the Hyperlink object. Read-only.
121158
- *
121039
+ * @remarks
121159
121040
  * [Api set: 1.1]
121160
121041
  */
121161
121042
  address?: boolean;
121162
121043
  /**
121044
+ * Gets the description of a hyperlink.
121163
121045
  *
121164
- * Gets the description of a hyperlink. Read-only.
121165
- *
121046
+ * @remarks
121166
121047
  * [Api set: 1.1]
121167
121048
  */
121168
121049
  description?: boolean;
121169
121050
  /**
121051
+ * Gets the extra URL request information used to resolve the hyperlink's URL.
121170
121052
  *
121171
- * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
121172
- *
121053
+ * @remarks
121173
121054
  * [Api set: 1.1]
121174
121055
  */
121175
121056
  extraInfo?: boolean;
121176
121057
  /**
121058
+ * Gets the sub-address of the Hyperlink object.
121177
121059
  *
121178
- * Gets the sub-address of the Hyperlink object. Read-only.
121179
- *
121060
+ * @remarks
121180
121061
  * [Api set: 1.1]
121181
121062
  */
121182
121063
  subAddress?: boolean;
121183
121064
  }
121184
121065
  /**
121185
- *
121186
121066
  * Represents the CommentCollection for a given Shape.
121187
121067
  *
121068
+ * @remarks
121188
121069
  * [Api set: 1.1]
121189
121070
  */
121190
121071
  interface CommentCollectionLoadOptions {
@@ -121193,31 +121074,31 @@ declare namespace Visio {
121193
121074
  */
121194
121075
  $all?: boolean;
121195
121076
  /**
121196
- *
121197
121077
  * For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
121198
121078
  *
121079
+ * @remarks
121199
121080
  * [Api set: 1.1]
121200
121081
  */
121201
121082
  author?: boolean;
121202
121083
  /**
121203
- *
121204
121084
  * For EACH ITEM in the collection: A string that specifies the date when the comment was created.
121205
121085
  *
121086
+ * @remarks
121206
121087
  * [Api set: 1.1]
121207
121088
  */
121208
121089
  date?: boolean;
121209
121090
  /**
121210
- *
121211
121091
  * For EACH ITEM in the collection: A string that contains the comment text.
121212
121092
  *
121093
+ * @remarks
121213
121094
  * [Api set: 1.1]
121214
121095
  */
121215
121096
  text?: boolean;
121216
121097
  }
121217
121098
  /**
121218
- *
121219
121099
  * Represents the Comment.
121220
121100
  *
121101
+ * @remarks
121221
121102
  * [Api set: 1.1]
121222
121103
  */
121223
121104
  interface CommentLoadOptions {
@@ -121226,23 +121107,23 @@ declare namespace Visio {
121226
121107
  */
121227
121108
  $all?: boolean;
121228
121109
  /**
121229
- *
121230
121110
  * A string that specifies the name of the author of the comment.
121231
121111
  *
121112
+ * @remarks
121232
121113
  * [Api set: 1.1]
121233
121114
  */
121234
121115
  author?: boolean;
121235
121116
  /**
121236
- *
121237
121117
  * A string that specifies the date when the comment was created.
121238
121118
  *
121119
+ * @remarks
121239
121120
  * [Api set: 1.1]
121240
121121
  */
121241
121122
  date?: boolean;
121242
121123
  /**
121243
- *
121244
121124
  * A string that contains the comment text.
121245
121125
  *
121126
+ * @remarks
121246
121127
  * [Api set: 1.1]
121247
121128
  */
121248
121129
  text?: boolean;
@@ -121278,19 +121159,12 @@ declare namespace Visio {
121278
121159
  * Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
121279
121160
  * @param contextObject - A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context.
121280
121161
  * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in.
121281
- * @remarks
121282
- * In addition to this signature, the method also has the following signatures:
121283
- *
121284
- * `run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
121285
- *
121286
- * `run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
121287
- *
121288
- * `run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
121289
121162
  */
121290
121163
  function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
121291
121164
  }
121292
121165
 
121293
121166
 
121167
+
121294
121168
  ////////////////////////////////////////////////////////////////
121295
121169
  //////////////////////// End Visio APIs ////////////////////////
121296
121170
  ////////////////////////////////////////////////////////////////