@types/office-js 1.0.229 → 1.0.230

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +1901 -673
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -93491,32 +93491,91 @@ declare namespace OneNote {
93491
93491
  declare namespace Visio {
93492
93492
  /**
93493
93493
  *
93494
- * Provides information about the document that raised the ShapeAdded event.
93494
+ * Provides information about the shape that raised the ShapeMouseEnter event.
93495
93495
  *
93496
93496
  * [Api set: 1.1]
93497
93497
  */
93498
- interface ShapeAddedEventArgs {
93498
+ interface ShapeMouseEnterEventArgs {
93499
93499
  /**
93500
93500
  *
93501
- * Gets the type of the event. See Visio.EventType for details.
93501
+ * Gets the name of the page which has the shape object that raised the ShapeMouseEnter event.
93502
93502
  *
93503
93503
  * [Api set: 1.1]
93504
93504
  */
93505
- type: "ShapeAdded";
93505
+ pageName: string;
93506
93506
  /**
93507
93507
  *
93508
- * ID of the page the shape belongs to.
93508
+ * Gets the name of the shape object that raised the ShapeMouseEnter event.
93509
93509
  *
93510
93510
  * [Api set: 1.1]
93511
93511
  */
93512
- pageId: string;
93512
+ shapeName: string;
93513
+ }
93514
+ /**
93515
+ *
93516
+ * Provides information about the shape that raised the ShapeMouseLeave event.
93517
+ *
93518
+ * [Api set: 1.1]
93519
+ */
93520
+ interface ShapeMouseLeaveEventArgs {
93513
93521
  /**
93514
93522
  *
93515
- * ID of the shape.
93523
+ * Gets the name of the page which has the shape object that raised the ShapeMouseLeave event.
93516
93524
  *
93517
93525
  * [Api set: 1.1]
93518
93526
  */
93519
- shapeId: string;
93527
+ pageName: string;
93528
+ /**
93529
+ *
93530
+ * Gets the name of the shape object that raised the ShapeMouseLeave event.
93531
+ *
93532
+ * [Api set: 1.1]
93533
+ */
93534
+ shapeName: string;
93535
+ }
93536
+ /**
93537
+ *
93538
+ * Provides information about the page that raised the PageLoadComplete event.
93539
+ *
93540
+ * [Api set: 1.1]
93541
+ */
93542
+ interface PageLoadCompleteEventArgs {
93543
+ /**
93544
+ *
93545
+ * Gets the name of the page that raised the PageLoad event.
93546
+ *
93547
+ * [Api set: 1.1]
93548
+ */
93549
+ pageName: string;
93550
+ /**
93551
+ *
93552
+ * Gets the success or failure of the PageLoadComplete event.
93553
+ *
93554
+ * [Api set: 1.1]
93555
+ */
93556
+ success: boolean;
93557
+ }
93558
+ /**
93559
+ *
93560
+ * Provides information about the document that raised the DataRefreshComplete event.
93561
+ *
93562
+ * [Api set: 1.1]
93563
+ */
93564
+ interface DataRefreshCompleteEventArgs {
93565
+ /**
93566
+ *
93567
+ * Gets the document object that raised the DataRefreshComplete event.
93568
+ *
93569
+ * [Api set: 1.1]
93570
+ */
93571
+ document: Visio.Document;
93572
+ /**
93573
+ *
93574
+ * Gets the success or failure of the DataRefreshComplete event.
93575
+ *
93576
+ * [Api set: 1.1]
93577
+ */
93578
+ success: boolean;
93520
93579
  }
93521
93580
  /**
93522
93581
  *
@@ -93527,68 +93586,137 @@ declare namespace Visio {
93527
93586
  interface SelectionChangedEventArgs {
93528
93587
  /**
93529
93588
  *
93530
- * Gets the page ID that raised the SelectionChanged event.
93589
+ * Gets the name of the page which has the ShapeCollection object that raised the SelectionChanged event.
93531
93590
  *
93532
93591
  * [Api set: 1.1]
93533
93592
  */
93534
- pageID: number;
93593
+ pageName: string;
93535
93594
  /**
93536
93595
  *
93537
- * Gets the array of shape IDs that raised the SelectionChanged event.
93596
+ * Gets the array of shape names that raised the SelectionChanged event.
93538
93597
  *
93539
93598
  * [Api set: 1.1]
93540
93599
  */
93541
- shapeIDs: number[];
93600
+ shapeNames: string[];
93542
93601
  }
93543
93602
  /**
93603
+ *
93604
+ * Provides information about the success or failure of the DocumentLoadComplete event.
93605
+ *
93544
93606
  * [Api set: 1.1]
93545
93607
  */
93546
- class Application extends OfficeExtension.ClientObject {
93547
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93548
- context: RequestContext;
93608
+ interface DocumentLoadCompleteEventArgs {
93609
+ /**
93610
+ *
93611
+ * Gets the success or failure of the DocumentLoadComplete event.
93612
+ *
93613
+ * [Api set: 1.1]
93614
+ */
93615
+ success: boolean;
93616
+ }
93617
+ /**
93618
+ *
93619
+ * Provides information about the page that raised the PageRenderComplete event.
93620
+ *
93621
+ * [Api set: 1.1]
93622
+ */
93623
+ interface PageRenderCompleteEventArgs {
93624
+ /**
93625
+ *
93626
+ * Gets the name of the page that raised the PageLoad event.
93627
+ *
93628
+ * [Api set: 1.1]
93629
+ */
93630
+ pageName: string;
93631
+ /**
93632
+ *
93633
+ * Gets the success/failure of the PageRender event.
93634
+ *
93635
+ * [Api set: 1.1]
93636
+ */
93637
+ success: boolean;
93638
+ }
93639
+ /**
93640
+ *
93641
+ * Provides information about DocumentError event
93642
+ *
93643
+ * [Api set: 1.1]
93644
+ */
93645
+ interface DocumentErrorEventArgs {
93549
93646
  /**
93550
93647
  *
93551
- * Returns the active document. Read-only.
93648
+ * Visio Error code
93552
93649
  *
93553
93650
  * [Api set: 1.1]
93554
93651
  */
93555
- readonly activeDocument: Visio.Document;
93652
+ errorCode: number;
93556
93653
  /**
93557
93654
  *
93558
- * Returns the active page. Read-only.
93655
+ * Message about error that occured
93559
93656
  *
93560
93657
  * [Api set: 1.1]
93561
93658
  */
93562
- readonly activePage: Visio.Page;
93659
+ errorMessage: string;
93563
93660
  /**
93564
93661
  *
93565
- * Returns the documents collection for a Microsoft Visio instance. Read-only.
93662
+ * Tells if the error is critical or not. If critical the session cannot continue.
93566
93663
  *
93567
93664
  * [Api set: 1.1]
93568
93665
  */
93569
- readonly documents: Visio.DocumentCollection;
93666
+ isCritical: boolean;
93667
+ }
93668
+ /**
93669
+ *
93670
+ * Provides information about the TaskPaneStateChanged event.
93671
+ *
93672
+ * [Api set: 1.1]
93673
+ */
93674
+ interface TaskPaneStateChangedEventArgs {
93570
93675
  /**
93571
93676
  *
93572
- * Gets or sets if the application is visible.
93677
+ * Current state of the taskpane
93573
93678
  *
93574
93679
  * [Api set: 1.1]
93575
93680
  */
93576
93681
  isVisible: boolean;
93577
93682
  /**
93578
93683
  *
93579
- * Specifies the name of the application. Read-only.
93684
+ * Type of the TaskPane.
93580
93685
  *
93581
93686
  * [Api set: 1.1]
93582
93687
  */
93583
- readonly name: string;
93688
+ paneType: Visio.TaskPaneType | "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings";
93689
+ }
93690
+ /**
93691
+ *
93692
+ * Represents the Application.
93693
+ *
93694
+ * [Api set: 1.1]
93695
+ */
93696
+ class Application extends OfficeExtension.ClientObject {
93697
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93698
+ context: RequestContext;
93699
+ /**
93700
+ *
93701
+ * Show or hide the iFrame application borders.
93702
+ *
93703
+ * [Api set: 1.1]
93704
+ */
93705
+ showBorders: boolean;
93584
93706
  /**
93585
93707
  *
93586
- * Gets or sets the user name of the application.
93708
+ * Show or hide the standard toolbars.
93587
93709
  *
93588
93710
  * [Api set: 1.1]
93589
93711
  */
93590
- userName: string;
93712
+ showToolbars: boolean;
93591
93713
  /** 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.
93714
+ *
93715
+ * @remarks
93716
+ *
93717
+ * This method has the following additional signature:
93718
+ *
93719
+ * `set(properties: Visio.Application): void`
93592
93720
  *
93593
93721
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
93594
93722
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
@@ -93598,14 +93726,24 @@ declare namespace Visio {
93598
93726
  set(properties: Visio.Application): void;
93599
93727
  /**
93600
93728
  *
93601
- * Get the stencil information.
93729
+ * Sets the visibility of a specific toolbar in the application.
93730
+ *
93731
+ * [Api set: 1.1]
93732
+ *
93733
+ * @param id The type of the Toolbar
93734
+ * @param show Whether the toolbar is visibile or not.
93735
+ */
93736
+ showToolbar(id: Visio.ToolBarType, show: boolean): void;
93737
+ /**
93738
+ *
93739
+ * Sets the visibility of a specific toolbar in the application.
93602
93740
  *
93603
93741
  * [Api set: 1.1]
93604
93742
  *
93605
- * @param stencilName StencilName represents file name of a stencil.
93606
- * @param includeHiddenMasters Specifies whether to Include Masters which are Hidden from Visio's UI(like Shapes Panel).The default value is false.
93743
+ * @param id The type of the Toolbar
93744
+ * @param show Whether the toolbar is visibile or not.
93607
93745
  */
93608
- getStencilInfo(stencilName: string, includeHiddenMasters?: boolean): OfficeExtension.ClientResult<Visio.StencilInfo>;
93746
+ showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;
93609
93747
  /**
93610
93748
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93611
93749
  *
@@ -93632,8 +93770,15 @@ declare namespace Visio {
93632
93770
  * Whereas the original Visio.Application object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object.
93633
93771
  */
93634
93772
  toJSON(): Visio.Interfaces.ApplicationData;
93773
+ /**
93774
+ * Set mock data
93775
+ */
93776
+ setMockData(data: Visio.Interfaces.ApplicationData): void;
93635
93777
  }
93636
93778
  /**
93779
+ *
93780
+ * Represents the Document class.
93781
+ *
93637
93782
  * [Api set: 1.1]
93638
93783
  */
93639
93784
  class Document extends OfficeExtension.ClientObject {
@@ -93655,40 +93800,18 @@ declare namespace Visio {
93655
93800
  readonly pages: Visio.PageCollection;
93656
93801
  /**
93657
93802
  *
93658
- * Gets or sets the description of the document.
93659
- *
93660
- * [Api set: 1.1]
93661
- */
93662
- description: string;
93663
- /**
93664
- *
93665
- * Returns the name of the document, including the drive and path. Read-only.
93666
- *
93667
- * [Api set: 1.1]
93668
- */
93669
- readonly fullName: string;
93670
- /**
93671
- *
93672
- * Returns the ID of the document. Read-only
93803
+ * Returns the DocumentView object. Read-only.
93673
93804
  *
93674
93805
  * [Api set: 1.1]
93675
93806
  */
93676
- readonly id: string;
93677
- /**
93678
- *
93679
- * Returns the ordinal position of a Document object in the Documents Collection. Read-only.
93807
+ readonly view: Visio.DocumentView;
93808
+ /** 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.
93680
93809
  *
93681
- * [Api set: 1.1]
93682
- */
93683
- readonly index: number;
93684
- /**
93810
+ * @remarks
93685
93811
  *
93686
- * Returns the name of the document.
93812
+ * This method has the following additional signature:
93687
93813
  *
93688
- * [Api set: 1.1]
93689
- */
93690
- readonly name: string;
93691
- /** 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.
93814
+ * `set(properties: Visio.Document): void`
93692
93815
  *
93693
93816
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
93694
93817
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
@@ -93698,21 +93821,14 @@ declare namespace Visio {
93698
93821
  set(properties: Visio.Document): void;
93699
93822
  /**
93700
93823
  *
93701
- * Closes a document.
93702
- *
93703
- * [Api set: 1.1]
93704
- */
93705
- close(): void;
93706
- /**
93707
- *
93708
- * Returns the active page of the document.
93824
+ * Returns the Active Page of the document.
93709
93825
  *
93710
93826
  * [Api set: 1.1]
93711
93827
  */
93712
93828
  getActivePage(): Visio.Page;
93713
93829
  /**
93714
93830
  *
93715
- * Set the active page of the document.
93831
+ * Set the Active Page of the document.
93716
93832
  *
93717
93833
  * [Api set: 1.1]
93718
93834
  *
@@ -93721,28 +93837,35 @@ declare namespace Visio {
93721
93837
  setActivePage(PageName: string): void;
93722
93838
  /**
93723
93839
  *
93724
- * Show or hide a TaskPane.
93840
+ * Show or Hide a TaskPane.
93725
93841
  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.
93726
93842
  *
93727
93843
  * [Api set: 1.1]
93728
93844
  *
93729
- * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType.
93730
- * @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.
93731
- * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane.
93845
+ * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
93846
+ * @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
93847
+ * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
93732
93848
  */
93733
93849
  showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;
93734
93850
  /**
93735
93851
  *
93736
- * Show or hide a TaskPane.
93852
+ * Show or Hide a TaskPane.
93737
93853
  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.
93738
93854
  *
93739
93855
  * [Api set: 1.1]
93740
93856
  *
93741
- * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType.
93742
- * @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.
93743
- * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane.
93857
+ * @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
93858
+ * @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
93859
+ * @param show Optional Parameter. If it is set to false, it will hide the specified taskpane
93744
93860
  */
93745
93861
  showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
93862
+ /**
93863
+ *
93864
+ * Triggers the refresh of the data in the Diagram, for all pages.
93865
+ *
93866
+ * [Api set: 1.1]
93867
+ */
93868
+ startDataRefresh(): void;
93746
93869
  /**
93747
93870
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93748
93871
  *
@@ -93766,12 +93889,40 @@ declare namespace Visio {
93766
93889
  }): Visio.Document;
93767
93890
  /**
93768
93891
  *
93769
- * Event raised when a data visualizer diagram is created or updated with new mappings and/or data.
93892
+ * Occurs when the data is refreshed in the diagram.
93893
+ *
93894
+ * [Api set: 1.1]
93895
+ *
93896
+ * @eventproperty
93897
+ */
93898
+ readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
93899
+ /**
93900
+ *
93901
+ * Occurs when there is an expected or unexpected error occured in the session.
93902
+ *
93903
+ * [Api set: 1.1]
93904
+ *
93905
+ * @eventproperty
93906
+ */
93907
+ readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;
93908
+ /**
93909
+ *
93910
+ * Occurs when the Document is loaded, refreshed, or changed.
93770
93911
  *
93771
93912
  * [Api set: 1.1]
93772
93913
  *
93773
93914
  * @eventproperty
93774
93915
  */
93916
+ readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;
93917
+ /**
93918
+ *
93919
+ * Occurs when the page is finished loading.
93920
+ *
93921
+ * [Api set: 1.1]
93922
+ *
93923
+ * @eventproperty
93924
+ */
93925
+ readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;
93775
93926
  /**
93776
93927
  *
93777
93928
  * Occurs when the current selection of shapes changes.
@@ -93783,81 +93934,134 @@ declare namespace Visio {
93783
93934
  readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;
93784
93935
  /**
93785
93936
  *
93786
- * Occurs when the shape is added.
93937
+ * Occurs when the user moves the mouse pointer into the bounding box of a shape.
93938
+ *
93939
+ * [Api set: 1.1]
93940
+ *
93941
+ * @eventproperty
93942
+ */
93943
+ readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;
93944
+ /**
93945
+ *
93946
+ * Occurs when the user moves the mouse out of the bounding box of a shape.
93947
+ *
93948
+ * [Api set: 1.1]
93949
+ *
93950
+ * @eventproperty
93951
+ */
93952
+ readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;
93953
+ /**
93954
+ *
93955
+ * Occurs whenever a task pane state is changed
93787
93956
  *
93788
93957
  * [Api set: 1.1]
93789
93958
  *
93790
93959
  * @eventproperty
93791
93960
  */
93792
- readonly onShapeAdded: OfficeExtension.EventHandlers<Visio.ShapeAddedEventArgs>;
93961
+ readonly onTaskPaneStateChanged: OfficeExtension.EventHandlers<Visio.TaskPaneStateChangedEventArgs>;
93793
93962
  /**
93794
93963
  * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93795
93964
  * Whereas the original Visio.Document object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object.
93796
93965
  */
93797
93966
  toJSON(): Visio.Interfaces.DocumentData;
93967
+ /**
93968
+ * Set mock data
93969
+ */
93970
+ setMockData(data: Visio.Interfaces.DocumentData): void;
93798
93971
  }
93799
93972
  /**
93973
+ *
93974
+ * Represents the DocumentView class.
93975
+ *
93800
93976
  * [Api set: 1.1]
93801
93977
  */
93802
- class DocumentCollection extends OfficeExtension.ClientObject {
93978
+ class DocumentView extends OfficeExtension.ClientObject {
93803
93979
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93804
93980
  context: RequestContext;
93805
- /** Gets the loaded child items in this collection. */
93806
- readonly items: Visio.Document[];
93807
93981
  /**
93808
93982
  *
93809
- * Adds a new Document object to the Documents collection.
93983
+ * Disable Hyperlinks.
93810
93984
  *
93811
93985
  * [Api set: 1.1]
93986
+ */
93987
+ disableHyperlinks: boolean;
93988
+ /**
93812
93989
  *
93813
- * @param FileName
93814
- * @returns
93990
+ * Disable Pan.
93991
+ *
93992
+ * [Api set: 1.1]
93815
93993
  */
93816
- add(FileName: string): Visio.Document;
93994
+ disablePan: boolean;
93817
93995
  /**
93818
93996
  *
93819
- * Returns the number of Documents in Document Collection.
93997
+ * Disable PanZoomWindow.
93820
93998
  *
93821
93999
  * [Api set: 1.1]
93822
- * @returns
93823
94000
  */
93824
- getCount(): OfficeExtension.ClientResult<number>;
93825
- getItem(key: number | string): Visio.Document;
94001
+ disablePanZoomWindow: boolean;
93826
94002
  /**
93827
94003
  *
93828
- * Returns an item from a collection.
94004
+ * Disable Zoom.
93829
94005
  *
93830
94006
  * [Api set: 1.1]
94007
+ */
94008
+ disableZoom: boolean;
94009
+ /**
93831
94010
  *
93832
- * @param index
93833
- * @returns
94011
+ * Hide Diagram Boundary.
94012
+ *
94013
+ * [Api set: 1.1]
94014
+ */
94015
+ hideDiagramBoundary: boolean;
94016
+ /** 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.
94017
+ *
94018
+ * @remarks
94019
+ *
94020
+ * This method has the following additional signature:
94021
+ *
94022
+ * `set(properties: Visio.DocumentView): void`
94023
+ *
94024
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
94025
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
93834
94026
  */
93835
- getItemOrNullObject(index: number): Visio.Document;
94027
+ set(properties: Interfaces.DocumentViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
94028
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
94029
+ set(properties: Visio.DocumentView): void;
93836
94030
  /**
93837
94031
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93838
94032
  *
93839
94033
  * @param options Provides options for which properties of the object to load.
93840
94034
  */
93841
- load(options?: Visio.Interfaces.DocumentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.DocumentCollection;
94035
+ load(options?: Visio.Interfaces.DocumentViewLoadOptions): Visio.DocumentView;
93842
94036
  /**
93843
94037
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93844
94038
  *
93845
94039
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
93846
94040
  */
93847
- load(propertyNames?: string | string[]): Visio.DocumentCollection;
94041
+ load(propertyNames?: string | string[]): Visio.DocumentView;
93848
94042
  /**
93849
94043
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93850
94044
  *
93851
94045
  * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
93852
94046
  */
93853
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.DocumentCollection;
94047
+ load(propertyNamesAndPaths?: {
94048
+ select?: string;
94049
+ expand?: string;
94050
+ }): Visio.DocumentView;
93854
94051
  /**
93855
94052
  * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
93856
- * Whereas the original `Visio.DocumentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.DocumentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94053
+ * Whereas the original Visio.DocumentView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.DocumentViewData`) that contains shallow copies of any loaded child properties from the original object.
93857
94054
  */
93858
- toJSON(): Visio.Interfaces.DocumentCollectionData;
94055
+ toJSON(): Visio.Interfaces.DocumentViewData;
94056
+ /**
94057
+ * Set mock data
94058
+ */
94059
+ setMockData(data: Visio.Interfaces.DocumentViewData): void;
93859
94060
  }
93860
94061
  /**
94062
+ *
94063
+ * Represents the Page class.
94064
+ *
93861
94065
  * [Api set: 1.1]
93862
94066
  */
93863
94067
  class Page extends OfficeExtension.ClientObject {
@@ -93865,39 +94069,53 @@ declare namespace Visio {
93865
94069
  context: RequestContext;
93866
94070
  /**
93867
94071
  *
93868
- * Returns the instance of Microsoft Visio that is associated with an object. Read-only.
94072
+ * All shapes in the Page, including subshapes. Read-only.
93869
94073
  *
93870
94074
  * [Api set: 1.1]
93871
94075
  */
93872
- readonly application: Visio.Application;
94076
+ readonly allShapes: Visio.ShapeCollection;
93873
94077
  /**
93874
94078
  *
93875
- * Gets the document object that is assocaited with the page. Read-only.
94079
+ * Returns the Comments Collection. Read-only.
93876
94080
  *
93877
94081
  * [Api set: 1.1]
93878
94082
  */
93879
- readonly document: Visio.Document;
94083
+ readonly comments: Visio.CommentCollection;
93880
94084
  /**
93881
94085
  *
93882
- * Shapes at root level, in the page. Read-only.
94086
+ * All top-level shapes in the Page.Read-only.
93883
94087
  *
93884
94088
  * [Api set: 1.1]
93885
94089
  */
93886
94090
  readonly shapes: Visio.ShapeCollection;
93887
94091
  /**
93888
94092
  *
93889
- * Returns the ID of the page. Read-only
94093
+ * Returns the view of the page. Read-only.
93890
94094
  *
93891
94095
  * [Api set: 1.1]
93892
94096
  */
93893
- readonly id: number;
94097
+ readonly view: Visio.PageView;
94098
+ /**
94099
+ *
94100
+ * Returns the height of the page. Read-only.
94101
+ *
94102
+ * [Api set: 1.1]
94103
+ */
94104
+ readonly height: number;
93894
94105
  /**
93895
94106
  *
93896
- * Index of the Page.
94107
+ * Index of the Page. Read-only.
93897
94108
  *
93898
94109
  * [Api set: 1.1]
93899
94110
  */
93900
94111
  readonly index: number;
94112
+ /**
94113
+ *
94114
+ * Whether the page is a background page or not. Read-only.
94115
+ *
94116
+ * [Api set: 1.1]
94117
+ */
94118
+ readonly isBackground: boolean;
93901
94119
  /**
93902
94120
  *
93903
94121
  * Page name. Read-only.
@@ -93905,7 +94123,20 @@ declare namespace Visio {
93905
94123
  * [Api set: 1.1]
93906
94124
  */
93907
94125
  readonly name: string;
94126
+ /**
94127
+ *
94128
+ * Returns the width of the page. Read-only.
94129
+ *
94130
+ * [Api set: 1.1]
94131
+ */
94132
+ readonly width: number;
93908
94133
  /** 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.
94134
+ *
94135
+ * @remarks
94136
+ *
94137
+ * This method has the following additional signature:
94138
+ *
94139
+ * `set(properties: Visio.Page): void`
93909
94140
  *
93910
94141
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
93911
94142
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
@@ -93915,17 +94146,11 @@ declare namespace Visio {
93915
94146
  set(properties: Visio.Page): void;
93916
94147
  /**
93917
94148
  *
93918
- * Returns a rectangle that tightly encloses the shapes of a page.
94149
+ * Set the page as Active Page of the document.
93919
94150
  *
93920
94151
  * [Api set: 1.1]
93921
- *
93922
- * @param Flags
93923
- * @param lpr8Left
93924
- * @param lpr8Bottom
93925
- * @param lpr8Right
93926
- * @param lpr8Top
93927
94152
  */
93928
- boundingBox(Flags: number, lpr8Left: number, lpr8Bottom: number, lpr8Right: number, lpr8Top: number): void;
94153
+ activate(): void;
93929
94154
  /**
93930
94155
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93931
94156
  *
@@ -93952,28 +94177,131 @@ declare namespace Visio {
93952
94177
  * Whereas the original Visio.Page object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object.
93953
94178
  */
93954
94179
  toJSON(): Visio.Interfaces.PageData;
94180
+ /**
94181
+ * Set mock data
94182
+ */
94183
+ setMockData(data: Visio.Interfaces.PageData): void;
93955
94184
  }
93956
94185
  /**
93957
94186
  *
93958
- * Represents a collection of Page objects that are part of the document.
94187
+ * Represents the PageView class.
93959
94188
  *
93960
94189
  * [Api set: 1.1]
93961
94190
  */
93962
- class PageCollection extends OfficeExtension.ClientObject {
94191
+ class PageView extends OfficeExtension.ClientObject {
93963
94192
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
93964
94193
  context: RequestContext;
93965
- /** Gets the loaded child items in this collection. */
93966
- readonly items: Visio.Page[];
93967
94194
  /**
93968
94195
  *
93969
- * Adds a new page to a collection.
94196
+ * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
93970
94197
  *
93971
94198
  * [Api set: 1.1]
94199
+ */
94200
+ zoom: number;
94201
+ /** 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.
93972
94202
  *
93973
- * @param FileName
93974
- * @returns
94203
+ * @remarks
94204
+ *
94205
+ * This method has the following additional signature:
94206
+ *
94207
+ * `set(properties: Visio.PageView): void`
94208
+ *
94209
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
94210
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
93975
94211
  */
93976
- add(FileName: string): Visio.Page;
94212
+ set(properties: Interfaces.PageViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
94213
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
94214
+ set(properties: Visio.PageView): void;
94215
+ /**
94216
+ *
94217
+ * Pans the Visio drawing to place the specified shape in the center of the view.
94218
+ *
94219
+ * [Api set: 1.1]
94220
+ *
94221
+ * @param ShapeId ShapeId to be seen in the center.
94222
+ */
94223
+ centerViewportOnShape(ShapeId: number): void;
94224
+ /**
94225
+ *
94226
+ * Fit Page to current window.
94227
+ *
94228
+ * [Api set: 1.1]
94229
+ */
94230
+ fitToWindow(): void;
94231
+ /**
94232
+ *
94233
+ * Returns the position object that specifies the position of the page in the view.
94234
+ *
94235
+ * [Api set: 1.1]
94236
+ */
94237
+ getPosition(): OfficeExtension.ClientResult<Visio.Position>;
94238
+ /**
94239
+ *
94240
+ * Represents the Selection in the page.
94241
+ *
94242
+ * [Api set: 1.1]
94243
+ */
94244
+ getSelection(): Visio.Selection;
94245
+ /**
94246
+ *
94247
+ * To check if the shape is in view of the page or not.
94248
+ *
94249
+ * [Api set: 1.1]
94250
+ *
94251
+ * @param Shape Shape to be checked.
94252
+ */
94253
+ isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;
94254
+ /**
94255
+ *
94256
+ * Sets the position of the page in the view.
94257
+ *
94258
+ * [Api set: 1.1]
94259
+ *
94260
+ * @param Position Position object that specifies the new position of the page in the view.
94261
+ */
94262
+ setPosition(Position: Visio.Position): void;
94263
+ /**
94264
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94265
+ *
94266
+ * @param options Provides options for which properties of the object to load.
94267
+ */
94268
+ load(options?: Visio.Interfaces.PageViewLoadOptions): Visio.PageView;
94269
+ /**
94270
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94271
+ *
94272
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94273
+ */
94274
+ load(propertyNames?: string | string[]): Visio.PageView;
94275
+ /**
94276
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94277
+ *
94278
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94279
+ */
94280
+ load(propertyNamesAndPaths?: {
94281
+ select?: string;
94282
+ expand?: string;
94283
+ }): Visio.PageView;
94284
+ /**
94285
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94286
+ * Whereas the original Visio.PageView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageViewData`) that contains shallow copies of any loaded child properties from the original object.
94287
+ */
94288
+ toJSON(): Visio.Interfaces.PageViewData;
94289
+ /**
94290
+ * Set mock data
94291
+ */
94292
+ setMockData(data: Visio.Interfaces.PageViewData): void;
94293
+ }
94294
+ /**
94295
+ *
94296
+ * Represents a collection of Page objects that are part of the document.
94297
+ *
94298
+ * [Api set: 1.1]
94299
+ */
94300
+ class PageCollection extends OfficeExtension.ClientObject {
94301
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94302
+ context: RequestContext;
94303
+ /** Gets the loaded child items in this collection. */
94304
+ readonly items: Visio.Page[];
93977
94305
  /**
93978
94306
  *
93979
94307
  * Gets the number of pages in the collection.
@@ -93981,17 +94309,15 @@ declare namespace Visio {
93981
94309
  * [Api set: 1.1]
93982
94310
  */
93983
94311
  getCount(): OfficeExtension.ClientResult<number>;
93984
- getItem(key: number | string): Visio.Page;
93985
94312
  /**
93986
94313
  *
93987
- * Returns an item from a collection.
94314
+ * Gets a page using its key (name or Id).
93988
94315
  *
93989
94316
  * [Api set: 1.1]
93990
94317
  *
93991
- * @param index
93992
- * @returns
94318
+ * @param key Key is the name or Id of the page to be retrieved.
93993
94319
  */
93994
- getItemOrNullObject(index: number): Visio.Page;
94320
+ getItem(key: number | string): Visio.Page;
93995
94321
  /**
93996
94322
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
93997
94323
  *
@@ -94015,6 +94341,65 @@ declare namespace Visio {
94015
94341
  * Whereas the original `Visio.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94016
94342
  */
94017
94343
  toJSON(): Visio.Interfaces.PageCollectionData;
94344
+ /**
94345
+ * Set mock data
94346
+ */
94347
+ setMockData(data: Visio.Interfaces.PageCollectionData): void;
94348
+ }
94349
+ /**
94350
+ *
94351
+ * Represents the Shape Collection.
94352
+ *
94353
+ * [Api set: 1.1]
94354
+ */
94355
+ class ShapeCollection extends OfficeExtension.ClientObject {
94356
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94357
+ context: RequestContext;
94358
+ /** Gets the loaded child items in this collection. */
94359
+ readonly items: Visio.Shape[];
94360
+ /**
94361
+ *
94362
+ * Gets the number of Shapes in the collection.
94363
+ *
94364
+ * [Api set: 1.1]
94365
+ */
94366
+ getCount(): OfficeExtension.ClientResult<number>;
94367
+ /**
94368
+ *
94369
+ * Gets a Shape using its key (name or Index).
94370
+ *
94371
+ * [Api set: 1.1]
94372
+ *
94373
+ * @param key Key is the Name or Index of the shape to be retrieved.
94374
+ */
94375
+ getItem(key: number | string): Visio.Shape;
94376
+ /**
94377
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94378
+ *
94379
+ * @param options Provides options for which properties of the object to load.
94380
+ */
94381
+ load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;
94382
+ /**
94383
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94384
+ *
94385
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94386
+ */
94387
+ load(propertyNames?: string | string[]): Visio.ShapeCollection;
94388
+ /**
94389
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94390
+ *
94391
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94392
+ */
94393
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;
94394
+ /**
94395
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94396
+ * Whereas the original `Visio.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94397
+ */
94398
+ toJSON(): Visio.Interfaces.ShapeCollectionData;
94399
+ /**
94400
+ * Set mock data
94401
+ */
94402
+ setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
94018
94403
  }
94019
94404
  /**
94020
94405
  *
@@ -94027,68 +94412,74 @@ declare namespace Visio {
94027
94412
  context: RequestContext;
94028
94413
  /**
94029
94414
  *
94030
- * Returns the instance of Microsoft Visio that is associated with an object. Read-only.
94415
+ * Returns the Comments Collection. Read-only.
94031
94416
  *
94032
94417
  * [Api set: 1.1]
94033
94418
  */
94034
- readonly application: Visio.Application;
94419
+ readonly comments: Visio.CommentCollection;
94035
94420
  /**
94036
94421
  *
94037
- * Gets the document object that is assocaited with the shape. Read-only.
94422
+ * Returns the Hyperlinks collection for a Shape object. Read-only.
94038
94423
  *
94039
94424
  * [Api set: 1.1]
94040
94425
  */
94041
- readonly document: Visio.Document;
94426
+ readonly hyperlinks: Visio.HyperlinkCollection;
94042
94427
  /**
94043
94428
  *
94044
- * Shape's Identifier.
94429
+ * Returns the Shape's Data Section. Read-only.
94045
94430
  *
94046
94431
  * [Api set: 1.1]
94047
94432
  */
94048
- readonly id: number;
94433
+ readonly shapeDataItems: Visio.ShapeDataItemCollection;
94049
94434
  /**
94050
94435
  *
94051
- * Indicates whether the shape is a callout shape. Read-only.
94436
+ * Gets SubShape Collection. Read-only.
94052
94437
  *
94053
94438
  * [Api set: 1.1]
94054
94439
  */
94055
- readonly isCallout: boolean;
94440
+ readonly subShapes: Visio.ShapeCollection;
94056
94441
  /**
94057
94442
  *
94058
- * Specifes whether a shape is a data graphic callout. Read-only.
94443
+ * Returns the view of the shape. Read-only.
94059
94444
  *
94060
94445
  * [Api set: 1.1]
94061
94446
  */
94062
- readonly isDataGraphicCallout: boolean;
94447
+ readonly view: Visio.ShapeView;
94063
94448
  /**
94064
94449
  *
94065
- * Indicates whether a shape is currently open for interactive text editing. Read-only.
94450
+ * Shape's identifier. Read-only.
94066
94451
  *
94067
94452
  * [Api set: 1.1]
94068
94453
  */
94069
- readonly isOpenForTextEdit: boolean;
94454
+ readonly id: number;
94070
94455
  /**
94071
94456
  *
94072
- * Shape's name.
94457
+ * Shape's name. Read-only.
94073
94458
  *
94074
94459
  * [Api set: 1.1]
94075
94460
  */
94076
94461
  readonly name: string;
94077
94462
  /**
94078
94463
  *
94079
- * Returns the type of the object. Read-only.(Shape_Type will give OACR Warning :61721)
94464
+ * Returns true, if shape is selected. User can set true to select the shape explicitly.
94080
94465
  *
94081
94466
  * [Api set: 1.1]
94082
94467
  */
94083
- readonly objType: number;
94468
+ select: boolean;
94084
94469
  /**
94085
94470
  *
94086
- * Shape's Text.
94471
+ * Shape's text. Read-only.
94087
94472
  *
94088
94473
  * [Api set: 1.1]
94089
94474
  */
94090
94475
  readonly text: string;
94091
94476
  /** 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.
94477
+ *
94478
+ * @remarks
94479
+ *
94480
+ * This method has the following additional signature:
94481
+ *
94482
+ * `set(properties: Visio.Shape): void`
94092
94483
  *
94093
94484
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
94094
94485
  * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
@@ -94098,17 +94489,11 @@ declare namespace Visio {
94098
94489
  set(properties: Visio.Shape): void;
94099
94490
  /**
94100
94491
  *
94101
- * Returns a rectangle that tightly encloses a shape.
94492
+ * Returns the BoundingBox object that specifies bounding box of the shape.
94102
94493
  *
94103
94494
  * [Api set: 1.1]
94104
- *
94105
- * @param Flags
94106
- * @param left
94107
- * @param bottom
94108
- * @param right
94109
- * @param top
94110
94495
  */
94111
- boundingBox(Flags: number, left: number, bottom: number, right: number, top: number): void;
94496
+ getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
94112
94497
  /**
94113
94498
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94114
94499
  *
@@ -94135,635 +94520,1059 @@ declare namespace Visio {
94135
94520
  * Whereas the original Visio.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
94136
94521
  */
94137
94522
  toJSON(): Visio.Interfaces.ShapeData;
94523
+ /**
94524
+ * Set mock data
94525
+ */
94526
+ setMockData(data: Visio.Interfaces.ShapeData): void;
94138
94527
  }
94139
94528
  /**
94140
94529
  *
94141
- * Represents the Shape Collection.
94530
+ * Represents the ShapeView class.
94142
94531
  *
94143
94532
  * [Api set: 1.1]
94144
94533
  */
94145
- class ShapeCollection extends OfficeExtension.ClientObject {
94534
+ class ShapeView extends OfficeExtension.ClientObject {
94146
94535
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94147
94536
  context: RequestContext;
94148
- /** Gets the loaded child items in this collection. */
94149
- readonly items: Visio.Shape[];
94150
94537
  /**
94151
94538
  *
94152
- * Adds a new shape to a collection.
94539
+ * Represents the highlight around the shape.
94153
94540
  *
94154
94541
  * [Api set: 1.1]
94542
+ */
94543
+ highlight: Visio.Highlight;
94544
+ /** 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.
94155
94545
  *
94156
- * @param FileName
94157
- * @returns
94546
+ * @remarks
94547
+ *
94548
+ * This method has the following additional signature:
94549
+ *
94550
+ * `set(properties: Visio.ShapeView): void`
94551
+ *
94552
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
94553
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
94158
94554
  */
94159
- add(FileName: string): Visio.Shape;
94555
+ set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
94556
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
94557
+ set(properties: Visio.ShapeView): void;
94160
94558
  /**
94161
94559
  *
94162
- * Gets the number of Shapes in the collection.
94560
+ * Adds an overlay on top of the shape.
94163
94561
  *
94164
94562
  * [Api set: 1.1]
94563
+ *
94564
+ * @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
94565
+ * @param Content Content of Overlay.
94566
+ * @param OverlayHorizontalAlignment Horizontal Alignment of Overlay. Can be 'Left', 'Center', or 'Right'.
94567
+ * @param OverlayVerticalAlignment Vertical Alignment of Overlay. Can be 'Top', 'Middle', 'Bottom'.
94568
+ * @param Width Overlay Width.
94569
+ * @param Height Overlay Height.
94165
94570
  */
94166
- getCount(): OfficeExtension.ClientResult<number>;
94167
- getItem(key: number | string): Visio.Shape;
94571
+ addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;
94168
94572
  /**
94169
94573
  *
94170
- * Returns an item from a collection.
94574
+ * Adds an overlay on top of the shape.
94171
94575
  *
94172
94576
  * [Api set: 1.1]
94173
94577
  *
94174
- * @param index
94175
- * @returns
94578
+ * @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
94579
+ * @param Content Content of Overlay.
94580
+ * @param OverlayHorizontalAlignment Horizontal Alignment of Overlay. Can be 'Left', 'Center', or 'Right'.
94581
+ * @param OverlayVerticalAlignment Vertical Alignment of Overlay. Can be 'Top', 'Middle', 'Bottom'.
94582
+ * @param Width Overlay Width.
94583
+ * @param Height Overlay Height.
94584
+ */
94585
+ addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;
94586
+ /**
94587
+ *
94588
+ * Removes particular overlay or all overlays on the Shape.
94589
+ *
94590
+ * [Api set: 1.1]
94591
+ *
94592
+ * @param OverlayId An Overlay Id. Removes the specific overlay id from the shape.
94593
+ */
94594
+ removeOverlay(OverlayId: number): void;
94595
+ /**
94596
+ *
94597
+ * Shows particular overlay on the Shape.
94598
+ *
94599
+ * [Api set: 1.1]
94600
+ *
94601
+ * @param overlayId overlay id in context
94602
+ * @param show to show or hide
94176
94603
  */
94177
- getItemOrNullObject(index: number): Visio.Shape;
94604
+ showOverlay(overlayId: number, show: boolean): void;
94178
94605
  /**
94179
94606
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94180
94607
  *
94181
94608
  * @param options Provides options for which properties of the object to load.
94182
94609
  */
94183
- load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;
94610
+ load(options?: Visio.Interfaces.ShapeViewLoadOptions): Visio.ShapeView;
94184
94611
  /**
94185
94612
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94186
94613
  *
94187
94614
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94188
94615
  */
94189
- load(propertyNames?: string | string[]): Visio.ShapeCollection;
94616
+ load(propertyNames?: string | string[]): Visio.ShapeView;
94190
94617
  /**
94191
94618
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94192
94619
  *
94193
94620
  * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94194
94621
  */
94195
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;
94622
+ load(propertyNamesAndPaths?: {
94623
+ select?: string;
94624
+ expand?: string;
94625
+ }): Visio.ShapeView;
94196
94626
  /**
94197
94627
  * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94198
- * Whereas the original `Visio.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94628
+ * Whereas the original Visio.ShapeView object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeViewData`) that contains shallow copies of any loaded child properties from the original object.
94199
94629
  */
94200
- toJSON(): Visio.Interfaces.ShapeCollectionData;
94630
+ toJSON(): Visio.Interfaces.ShapeViewData;
94631
+ /**
94632
+ * Set mock data
94633
+ */
94634
+ setMockData(data: Visio.Interfaces.ShapeViewData): void;
94201
94635
  }
94202
94636
  /**
94203
94637
  *
94204
- * Master ionformation.
94638
+ * Represents the Position of the object in the view.
94205
94639
  *
94206
94640
  * [Api set: 1.1]
94207
94641
  */
94208
- interface MasterInfo {
94642
+ interface Position {
94209
94643
  /**
94210
94644
  *
94211
- * Localised Display Name of the Master.
94645
+ * 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.
94212
94646
  *
94213
94647
  * [Api set: 1.1]
94214
94648
  */
94215
- name: string;
94649
+ x: number;
94216
94650
  /**
94217
94651
  *
94218
- * Master Name.
94652
+ * 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.
94219
94653
  *
94220
94654
  * [Api set: 1.1]
94221
94655
  */
94222
- nameU: string;
94656
+ y: number;
94223
94657
  }
94224
94658
  /**
94225
94659
  *
94226
- * Stencil Information.
94660
+ * Represents the BoundingBox of the shape.
94227
94661
  *
94228
94662
  * [Api set: 1.1]
94229
94663
  */
94230
- interface StencilInfo {
94664
+ interface BoundingBox {
94231
94665
  /**
94232
94666
  *
94233
- * List of MasterInfo.
94667
+ * The distance between the top and bottom edges of the bounding box of the shape, excluding any data graphics associated with the shape.
94234
94668
  *
94235
94669
  * [Api set: 1.1]
94236
94670
  */
94237
- mastersInfo: Visio.MasterInfo[];
94671
+ height: number;
94238
94672
  /**
94239
94673
  *
94240
- * Name represents file name of a stencil.
94674
+ * The distance between the left and right edges of the bounding box of the shape, excluding any data graphics associated with the shape.
94241
94675
  *
94242
94676
  * [Api set: 1.1]
94243
94677
  */
94244
- name: string;
94678
+ width: number;
94245
94679
  /**
94246
94680
  *
94247
- * Title represents Display Name of the Stencil.
94681
+ * An integer that specifies the x-coordinate of the bounding box.
94248
94682
  *
94249
94683
  * [Api set: 1.1]
94250
94684
  */
94251
- title: string;
94685
+ x: number;
94686
+ /**
94687
+ *
94688
+ * An integer that specifies the y-coordinate of the bounding box.
94689
+ *
94690
+ * [Api set: 1.1]
94691
+ */
94692
+ y: number;
94252
94693
  }
94253
94694
  /**
94254
94695
  *
94255
- * Message category.
94696
+ * Represents the highlight data added to the shape.
94256
94697
  *
94257
94698
  * [Api set: 1.1]
94258
94699
  */
94259
- enum MessageCategory {
94700
+ interface Highlight {
94260
94701
  /**
94261
94702
  *
94262
- * None category.
94703
+ * 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).
94263
94704
  *
94705
+ * [Api set: 1.1]
94264
94706
  */
94265
- none = 0,
94707
+ color: string;
94266
94708
  /**
94267
94709
  *
94268
- * Event category.
94710
+ * A positive integer that specifies the width of the highlight's stroke in pixels.
94269
94711
  *
94712
+ * [Api set: 1.1]
94270
94713
  */
94271
- event = 65536,
94714
+ width: number;
94272
94715
  }
94273
94716
  /**
94274
94717
  *
94275
- * MessageType represents the type of message when event is fired from Host.
94718
+ * Represents the ShapeDataItemCollection for a given Shape.
94276
94719
  *
94277
94720
  * [Api set: 1.1]
94278
94721
  */
94279
- enum MessageType {
94722
+ class ShapeDataItemCollection extends OfficeExtension.ClientObject {
94723
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94724
+ context: RequestContext;
94725
+ /** Gets the loaded child items in this collection. */
94726
+ readonly items: Visio.ShapeDataItem[];
94280
94727
  /**
94281
94728
  *
94282
- * None type.
94729
+ * Gets the number of Shape Data Items.
94283
94730
  *
94731
+ * [Api set: 1.1]
94284
94732
  */
94285
- none = 0,
94733
+ getCount(): OfficeExtension.ClientResult<number>;
94286
94734
  /**
94287
94735
  *
94288
- * Shape Added Event Message.
94736
+ * Gets the ShapeDataItem using its name.
94737
+ *
94738
+ * [Api set: 1.1]
94289
94739
  *
94740
+ * @param key Key is the name of the ShapeDataItem to be retrieved.
94290
94741
  */
94291
- shapeAddedEvent = 1,
94742
+ getItem(key: string): Visio.ShapeDataItem;
94292
94743
  /**
94744
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94293
94745
  *
94294
- * Selection Changed Event Message.
94295
- *
94746
+ * @param options Provides options for which properties of the object to load.
94296
94747
  */
94297
- selectionChangedEvent = 2,
94748
+ load(options?: Visio.Interfaces.ShapeDataItemCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeDataItemCollection;
94298
94749
  /**
94750
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94299
94751
  *
94300
- * DataVisualizer diagram operation complete Event Message.
94752
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94753
+ */
94754
+ load(propertyNames?: string | string[]): Visio.ShapeDataItemCollection;
94755
+ /**
94756
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94301
94757
  *
94758
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94759
+ */
94760
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeDataItemCollection;
94761
+ /**
94762
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94763
+ * Whereas the original `Visio.ShapeDataItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeDataItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94764
+ */
94765
+ toJSON(): Visio.Interfaces.ShapeDataItemCollectionData;
94766
+ /**
94767
+ * Set mock data
94302
94768
  */
94303
- dataVisualizerDiagramOperationCompletedEvent = 3,
94769
+ setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
94304
94770
  }
94305
94771
  /**
94306
94772
  *
94307
- * EventType represents the type of the events Host supports.
94773
+ * Represents the ShapeDataItem.
94308
94774
  *
94309
94775
  * [Api set: 1.1]
94310
94776
  */
94311
- enum EventType {
94777
+ class ShapeDataItem extends OfficeExtension.ClientObject {
94778
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94779
+ context: RequestContext;
94312
94780
  /**
94313
94781
  *
94314
- * Shape Added Event.
94782
+ * A string that specifies the format of the shape data item. Read-only.
94315
94783
  *
94784
+ * [Api set: 1.1]
94316
94785
  */
94317
- shapeAdded = "ShapeAdded",
94786
+ readonly format: string;
94318
94787
  /**
94319
94788
  *
94320
- * Selection Changed Event.
94789
+ * A string that specifies the formatted value of the shape data item. Read-only.
94321
94790
  *
94791
+ * [Api set: 1.1]
94322
94792
  */
94323
- selectionChanged = "SelectionChanged",
94793
+ readonly formattedValue: string;
94324
94794
  /**
94325
94795
  *
94326
- * DataVisualizer diagram operation complete Event.
94796
+ * A string that specifies the label of the shape data item. Read-only.
94327
94797
  *
94798
+ * [Api set: 1.1]
94328
94799
  */
94329
- dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
94330
- }
94331
- /**
94332
- *
94333
- * 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.
94334
- *
94335
- * [Api set: 1.1]
94336
- */
94337
- enum TaskPaneType {
94800
+ readonly label: string;
94338
94801
  /**
94339
94802
  *
94340
- * None type.
94803
+ * A string that specifies the value of the shape data item. Read-only.
94341
94804
  *
94805
+ * [Api set: 1.1]
94342
94806
  */
94343
- none = "None",
94807
+ readonly value: string;
94344
94808
  /**
94809
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94345
94810
  *
94346
- * Data Visualizer Process Mapping Pane.
94347
- *
94811
+ * @param options Provides options for which properties of the object to load.
94348
94812
  */
94349
- dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
94813
+ load(options?: Visio.Interfaces.ShapeDataItemLoadOptions): Visio.ShapeDataItem;
94350
94814
  /**
94815
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94351
94816
  *
94352
- * Data Visualizer Organisation Mapping Pane
94817
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94818
+ */
94819
+ load(propertyNames?: string | string[]): Visio.ShapeDataItem;
94820
+ /**
94821
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94353
94822
  *
94823
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94354
94824
  */
94355
- dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
94825
+ load(propertyNamesAndPaths?: {
94826
+ select?: string;
94827
+ expand?: string;
94828
+ }): Visio.ShapeDataItem;
94829
+ /**
94830
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94831
+ * Whereas the original Visio.ShapeDataItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.ShapeDataItemData`) that contains shallow copies of any loaded child properties from the original object.
94832
+ */
94833
+ toJSON(): Visio.Interfaces.ShapeDataItemData;
94834
+ /**
94835
+ * Set mock data
94836
+ */
94837
+ setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
94356
94838
  }
94357
94839
  /**
94358
94840
  *
94359
- * Result of Data Visualizer Diagram operations.
94841
+ * Represents the Hyperlink Collection.
94360
94842
  *
94361
94843
  * [Api set: 1.1]
94362
94844
  */
94363
- enum DataVisualizerDiagramResultType {
94845
+ class HyperlinkCollection extends OfficeExtension.ClientObject {
94846
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94847
+ context: RequestContext;
94848
+ /** Gets the loaded child items in this collection. */
94849
+ readonly items: Visio.Hyperlink[];
94364
94850
  /**
94365
94851
  *
94366
- * Operation is success.
94852
+ * Gets the number of hyperlinks.
94367
94853
  *
94854
+ * [Api set: 1.1]
94368
94855
  */
94369
- success = "Success",
94856
+ getCount(): OfficeExtension.ClientResult<number>;
94370
94857
  /**
94371
94858
  *
94372
- * Unexpected error during operation.
94859
+ * Gets a Hyperlink using its key (name or Id).
94373
94860
  *
94861
+ * [Api set: 1.1]
94862
+ *
94863
+ * @param Key Key is the name or index of the Hyperlink to be retrieved.
94374
94864
  */
94375
- unexpected = "Unexpected",
94865
+ getItem(Key: number | string): Visio.Hyperlink;
94376
94866
  /**
94867
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94377
94868
  *
94378
- * Validation error in operation.
94379
- *
94869
+ * @param options Provides options for which properties of the object to load.
94380
94870
  */
94381
- validationError = "ValidationError",
94871
+ load(options?: Visio.Interfaces.HyperlinkCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.HyperlinkCollection;
94382
94872
  /**
94873
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94383
94874
  *
94384
- * Conflict error in operation.
94875
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94876
+ */
94877
+ load(propertyNames?: string | string[]): Visio.HyperlinkCollection;
94878
+ /**
94879
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94385
94880
  *
94881
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94386
94882
  */
94387
- conflictError = "ConflictError",
94883
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.HyperlinkCollection;
94884
+ /**
94885
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94886
+ * Whereas the original `Visio.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
94887
+ */
94888
+ toJSON(): Visio.Interfaces.HyperlinkCollectionData;
94889
+ /**
94890
+ * Set mock data
94891
+ */
94892
+ setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
94388
94893
  }
94389
94894
  /**
94390
94895
  *
94391
- * Type of the Data Visualizer Diagram operation.
94896
+ * Represents the Hyperlink.
94392
94897
  *
94393
94898
  * [Api set: 1.1]
94394
94899
  */
94395
- enum DataVisualizerDiagramOperationType {
94900
+ class Hyperlink extends OfficeExtension.ClientObject {
94901
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94902
+ context: RequestContext;
94396
94903
  /**
94397
94904
  *
94398
- * unknown operation type.
94905
+ * Gets the address of the Hyperlink object. Read-only.
94399
94906
  *
94907
+ * [Api set: 1.1]
94400
94908
  */
94401
- unknown = "Unknown",
94909
+ readonly address: string;
94402
94910
  /**
94403
94911
  *
94404
- * Creation operation.
94912
+ * Gets the description of a hyperlink. Read-only.
94405
94913
  *
94914
+ * [Api set: 1.1]
94406
94915
  */
94407
- create = "Create",
94916
+ readonly description: string;
94408
94917
  /**
94409
94918
  *
94410
- * Update Mappings operation.
94919
+ * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
94411
94920
  *
94921
+ * [Api set: 1.1]
94412
94922
  */
94413
- updateMappings = "UpdateMappings",
94923
+ readonly extraInfo: string;
94414
94924
  /**
94415
94925
  *
94416
- * Update data associated with diagram.
94926
+ * Gets the sub-address of the Hyperlink object. Read-only.
94417
94927
  *
94928
+ * [Api set: 1.1]
94418
94929
  */
94419
- updateData = "UpdateData",
94930
+ readonly subAddress: string;
94420
94931
  /**
94932
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94421
94933
  *
94422
- * Update both data and mappings.
94423
- *
94934
+ * @param options Provides options for which properties of the object to load.
94424
94935
  */
94425
- update = "Update",
94936
+ load(options?: Visio.Interfaces.HyperlinkLoadOptions): Visio.Hyperlink;
94426
94937
  /**
94938
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94427
94939
  *
94428
- * Delete the diagram content.
94940
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94941
+ */
94942
+ load(propertyNames?: string | string[]): Visio.Hyperlink;
94943
+ /**
94944
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94429
94945
  *
94946
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94430
94947
  */
94431
- delete = "Delete",
94948
+ load(propertyNamesAndPaths?: {
94949
+ select?: string;
94950
+ expand?: string;
94951
+ }): Visio.Hyperlink;
94952
+ /**
94953
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
94954
+ * Whereas the original Visio.Hyperlink object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
94955
+ */
94956
+ toJSON(): Visio.Interfaces.HyperlinkData;
94957
+ /**
94958
+ * Set mock data
94959
+ */
94960
+ setMockData(data: Visio.Interfaces.HyperlinkData): void;
94432
94961
  }
94433
94962
  /**
94434
94963
  *
94435
- * DiagramType for Data Visualizer diagrams.
94964
+ * Represents the CommentCollection for a given Shape.
94436
94965
  *
94437
94966
  * [Api set: 1.1]
94438
94967
  */
94439
- enum DataVisualizerDiagramType {
94968
+ class CommentCollection extends OfficeExtension.ClientObject {
94969
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
94970
+ context: RequestContext;
94971
+ /** Gets the loaded child items in this collection. */
94972
+ readonly items: Visio.Comment[];
94440
94973
  /**
94441
94974
  *
94442
- * Unknown.
94975
+ * Gets the number of Comments.
94443
94976
  *
94977
+ * [Api set: 1.1]
94444
94978
  */
94445
- unknown = "Unknown",
94979
+ getCount(): OfficeExtension.ClientResult<number>;
94446
94980
  /**
94447
94981
  *
94448
- * Basic Flowchart.
94449
- *
94450
- */
94451
- basicFlowchart = "BasicFlowchart",
94452
- /**
94982
+ * Gets the Comment using its name.
94453
94983
  *
94454
- * Horizontal Cross-Functional Flowchart.
94984
+ * [Api set: 1.1]
94455
94985
  *
94986
+ * @param key Key is the name of the Comment to be retrieved.
94456
94987
  */
94457
- crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
94988
+ getItem(key: string): Visio.Comment;
94458
94989
  /**
94990
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94459
94991
  *
94460
- * Vertical Cross-Functional Flowchart.
94461
- *
94992
+ * @param options Provides options for which properties of the object to load.
94462
94993
  */
94463
- crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
94994
+ load(options?: Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.CommentCollection;
94464
94995
  /**
94996
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94465
94997
  *
94466
- * Audit.
94467
- *
94998
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
94468
94999
  */
94469
- audit = "Audit",
95000
+ load(propertyNames?: string | string[]): Visio.CommentCollection;
94470
95001
  /**
95002
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94471
95003
  *
94472
- * OrgChart.
94473
- *
95004
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94474
95005
  */
94475
- orgChart = "OrgChart",
95006
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.CommentCollection;
94476
95007
  /**
94477
- *
94478
- * Network.
94479
- *
95008
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
95009
+ * Whereas the original `Visio.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
95010
+ */
95011
+ toJSON(): Visio.Interfaces.CommentCollectionData;
95012
+ /**
95013
+ * Set mock data
94480
95014
  */
94481
- network = "Network",
95015
+ setMockData(data: Visio.Interfaces.CommentCollectionData): void;
94482
95016
  }
94483
95017
  /**
94484
95018
  *
94485
- * Represents the type of column values.
95019
+ * Represents the Comment.
94486
95020
  *
94487
95021
  * [Api set: 1.1]
94488
95022
  */
94489
- enum ColumnType {
95023
+ class Comment extends OfficeExtension.ClientObject {
95024
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
95025
+ context: RequestContext;
94490
95026
  /**
94491
95027
  *
94492
- * Other.
95028
+ * A string that specifies the name of the author of the comment.
94493
95029
  *
95030
+ * [Api set: 1.1]
94494
95031
  */
94495
- unknown = "Unknown",
95032
+ author: string;
94496
95033
  /**
94497
95034
  *
94498
- * String values.
95035
+ * A string that specifies the date when the comment was created.
94499
95036
  *
95037
+ * [Api set: 1.1]
94500
95038
  */
94501
- string = "String",
95039
+ date: string;
94502
95040
  /**
94503
95041
  *
94504
- * Numerical values.
95042
+ * A string that contains the comment text.
94505
95043
  *
95044
+ * [Api set: 1.1]
94506
95045
  */
94507
- number = "Number",
94508
- /**
95046
+ text: string;
95047
+ /** 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.
94509
95048
  *
94510
- * Date.
95049
+ * @remarks
94511
95050
  *
94512
- */
94513
- date = "Date",
94514
- /**
95051
+ * This method has the following additional signature:
94515
95052
  *
94516
- * Currency.
95053
+ * `set(properties: Visio.Comment): void`
94517
95054
  *
95055
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
95056
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
94518
95057
  */
94519
- currency = "Currency",
94520
- }
94521
- /**
94522
- *
94523
- * Represents the type of source for the data connection.
94524
- *
94525
- * [Api set: 1.1]
94526
- */
94527
- enum DataSourceType {
95058
+ set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;
95059
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
95060
+ set(properties: Visio.Comment): void;
94528
95061
  /**
95062
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94529
95063
  *
94530
- * Unknown Data Source.
94531
- *
95064
+ * @param options Provides options for which properties of the object to load.
94532
95065
  */
94533
- unknown = "Unknown",
95066
+ load(options?: Visio.Interfaces.CommentLoadOptions): Visio.Comment;
94534
95067
  /**
95068
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94535
95069
  *
94536
- * Microsoft Excel workbook.
95070
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
95071
+ */
95072
+ load(propertyNames?: string | string[]): Visio.Comment;
95073
+ /**
95074
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94537
95075
  *
95076
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94538
95077
  */
94539
- excel = "Excel",
95078
+ load(propertyNamesAndPaths?: {
95079
+ select?: string;
95080
+ expand?: string;
95081
+ }): Visio.Comment;
95082
+ /**
95083
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
95084
+ * Whereas the original Visio.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object.
95085
+ */
95086
+ toJSON(): Visio.Interfaces.CommentData;
95087
+ /**
95088
+ * Set mock data
95089
+ */
95090
+ setMockData(data: Visio.Interfaces.CommentData): void;
94540
95091
  }
94541
95092
  /**
94542
95093
  *
94543
- * Represents the orientation of the Cross Functional Flowchart diagram.
95094
+ * Represents the Selection in the page.
94544
95095
  *
94545
95096
  * [Api set: 1.1]
94546
95097
  */
94547
- enum CrossFunctionalFlowchartOrientation {
95098
+ class Selection extends OfficeExtension.ClientObject {
95099
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
95100
+ context: RequestContext;
94548
95101
  /**
94549
95102
  *
94550
- * Horizontal Cross Functional Flowchart.
95103
+ * Gets the Shapes of the Selection. Read-only.
94551
95104
  *
95105
+ * [Api set: 1.1]
94552
95106
  */
94553
- horizontal = "Horizontal",
95107
+ readonly shapes: Visio.ShapeCollection;
94554
95108
  /**
95109
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94555
95110
  *
94556
- * Vertical Cross Functional Flowchart.
95111
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
95112
+ */
95113
+ load(propertyNames?: string | string[]): Visio.Selection;
95114
+ /**
95115
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
94557
95116
  *
95117
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
94558
95118
  */
94559
- vertical = "Vertical",
95119
+ load(propertyNamesAndPaths?: {
95120
+ select?: string;
95121
+ expand?: string;
95122
+ }): Visio.Selection;
95123
+ /**
95124
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
95125
+ * Whereas the original Visio.Selection object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Visio.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object.
95126
+ */
95127
+ toJSON(): Visio.Interfaces.SelectionData;
94560
95128
  }
94561
95129
  /**
94562
95130
  *
94563
- * Represents the type of layout.
94564
- Make sure that this enum is same as DVSupportedLayouts visio/Engine/inc/databindingtypes.h
95131
+ * Shape binding informations required for data visualizer diagram
94565
95132
  *
94566
95133
  * [Api set: 1.1]
94567
95134
  */
94568
- enum LayoutVariant {
95135
+ interface ShapeBinding {
94569
95136
  /**
94570
95137
  *
94571
- * Invalid layout.
95138
+ * Column for alternative text for shape.
94572
95139
  *
95140
+ * [Api set: 1.1]
94573
95141
  */
94574
- unknown = "Unknown",
95142
+ alternativeTextColumnName: string;
94575
95143
  /**
94576
95144
  *
94577
- * Use the Page default layout.
95145
+ * Column for Shape label.
94578
95146
  *
95147
+ * [Api set: 1.1]
94579
95148
  */
94580
- pageDefault = "PageDefault",
95149
+ labelColumnName: string;
94581
95150
  /**
94582
95151
  *
94583
- * Use Flowchart with TopToBottom orientation.
95152
+ * Unique Id column.
94584
95153
  *
95154
+ * [Api set: 1.1]
94585
95155
  */
94586
- flowchart_TopToBottom = "Flowchart_TopToBottom",
95156
+ uniqueIDColumnName: string;
95157
+ }
95158
+ /**
95159
+ *
95160
+ * Connector bindings for data visualizer diagram.
95161
+ *
95162
+ * [Api set: 1.1]
95163
+ */
95164
+ interface ConnectorBinding {
94587
95165
  /**
94588
95166
  *
94589
- * Use Flowchart with LeftToRight orientation.
95167
+ * If true then connectors are added in sequence according to the uniqueId column.
94590
95168
  *
95169
+ * [Api set: 1.1]
94591
95170
  */
94592
- flowchart_LeftToRight = "Flowchart_LeftToRight",
95171
+ connectSequentially: boolean;
94593
95172
  /**
94594
95173
  *
94595
- * Use Radial Layout.
95174
+ * Delimiter for TargetColumn. It should not have more then one character.
94596
95175
  *
95176
+ * [Api set: 1.1]
94597
95177
  */
94598
- radial = "Radial",
95178
+ delimiter: string;
94599
95179
  /**
94600
95180
  *
94601
- * Use Flowchart with BottomToTop orientation.
95181
+ * Direction of connector to use in diagram.
94602
95182
  *
95183
+ * [Api set: 1.1]
94603
95184
  */
94604
- flowchart_BottomToTop = "Flowchart_BottomToTop",
95185
+ direction: Visio.ConnectorDirection | "FromTarget" | "ToTarget";
94605
95186
  /**
94606
95187
  *
94607
- * Use Flowchart with RightToLeft orientation.
95188
+ * Column for ConnectorLabel (shape text of connector).
94608
95189
  *
95190
+ * [Api set: 1.1]
94609
95191
  */
94610
- flowchart_RightToLeft = "Flowchart_RightToLeft",
95192
+ labelColumnName: string;
94611
95193
  /**
94612
95194
  *
94613
- * Use Circular layout.
95195
+ * Column for proving connected target shape.
94614
95196
  *
95197
+ * [Api set: 1.1]
94615
95198
  */
94616
- circular = "Circular",
95199
+ targetColumnName: string;
95200
+ }
95201
+ /**
95202
+ *
95203
+ * Represents the Horizontal Alignment of the Overlay relative to the shape.
95204
+ *
95205
+ * [Api set: 1.1]
95206
+ */
95207
+ enum OverlayHorizontalAlignment {
94617
95208
  /**
94618
95209
  *
94619
- * Use WideTree with DownThenRight orientation.
95210
+ * left
94620
95211
  *
94621
95212
  */
94622
- wideTree_DownThenRight = "WideTree_DownThenRight",
95213
+ left = "Left",
94623
95214
  /**
94624
95215
  *
94625
- * Use WideTree with RightThenDown orientation.
95216
+ * center
94626
95217
  *
94627
95218
  */
94628
- wideTree_RightThenDown = "WideTree_RightThenDown",
95219
+ center = "Center",
94629
95220
  /**
94630
95221
  *
94631
- * Use WideTree with RightThenUp orientation.
95222
+ * right
94632
95223
  *
94633
95224
  */
94634
- wideTree_RightThenUp = "WideTree_RightThenUp",
95225
+ right = "Right",
95226
+ }
95227
+ /**
95228
+ *
95229
+ * Represents the Vertical Alignment of the Overlay relative to the shape.
95230
+ *
95231
+ * [Api set: 1.1]
95232
+ */
95233
+ enum OverlayVerticalAlignment {
94635
95234
  /**
94636
95235
  *
94637
- * Use WideTree with UpThenRight orientation.
95236
+ * top
94638
95237
  *
94639
95238
  */
94640
- wideTree_UpThenRight = "WideTree_UpThenRight",
95239
+ top = "Top",
94641
95240
  /**
94642
95241
  *
94643
- * Use WideTree with UpThenLeft orientation.
95242
+ * middle
94644
95243
  *
94645
95244
  */
94646
- wideTree_UpThenLeft = "WideTree_UpThenLeft",
95245
+ middle = "Middle",
94647
95246
  /**
94648
95247
  *
94649
- * Use WideTree with LeftThenUp orientation.
95248
+ * bottom
94650
95249
  *
94651
95250
  */
94652
- wideTree_LeftThenUp = "WideTree_LeftThenUp",
95251
+ bottom = "Bottom",
95252
+ }
95253
+ /**
95254
+ *
95255
+ * Represents the type of the overlay.
95256
+ *
95257
+ * [Api set: 1.1]
95258
+ */
95259
+ enum OverlayType {
94653
95260
  /**
94654
95261
  *
94655
- * Use WideTree with LeftThenDown orientation.
95262
+ * text
94656
95263
  *
94657
95264
  */
94658
- wideTree_LeftThenDown = "WideTree_LeftThenDown",
95265
+ text = "Text",
94659
95266
  /**
94660
95267
  *
94661
- * Use WideTree with DownThenLeft orientation.
95268
+ * image
94662
95269
  *
94663
95270
  */
94664
- wideTree_DownThenLeft = "WideTree_DownThenLeft",
95271
+ image = "Image",
94665
95272
  /**
94666
95273
  *
94667
- * Use ParentDefault layout.
95274
+ * html
94668
95275
  *
94669
95276
  */
94670
- parentDefault = "ParentDefault",
95277
+ html = "Html",
95278
+ }
95279
+ /**
95280
+ *
95281
+ * Toolbar IDs of the app
95282
+ *
95283
+ * [Api set: 1.1]
95284
+ */
95285
+ enum ToolBarType {
94671
95286
  /**
94672
95287
  *
94673
- * Use Hierarchy TopToBottomLeft orientation.
95288
+ * CommandBar
94674
95289
  *
94675
95290
  */
94676
- hierarchy_TopToBottomLeft = "Hierarchy_TopToBottomLeft",
95291
+ commandBar = "CommandBar",
94677
95292
  /**
94678
95293
  *
94679
- * Use Hierarchy TopToBottomCenter orientation.
95294
+ * PageNavigationBar
94680
95295
  *
94681
95296
  */
94682
- hierarchy_TopToBottomCenter = "Hierarchy_TopToBottomCenter",
95297
+ pageNavigationBar = "PageNavigationBar",
94683
95298
  /**
94684
95299
  *
94685
- * Use Hierarchy TopToBottomRight orientation.
95300
+ * StatusBar
94686
95301
  *
94687
95302
  */
94688
- hierarchy_TopToBottomRight = "Hierarchy_TopToBottomRight",
95303
+ statusBar = "StatusBar",
95304
+ }
95305
+ /**
95306
+ *
95307
+ * Result of Data Visualizer Diagram operations.
95308
+ *
95309
+ * [Api set: 1.1]
95310
+ */
95311
+ enum DataVisualizerDiagramResultType {
94689
95312
  /**
94690
95313
  *
94691
- * Use Hierarchy BottomToTopLeft orientation.
95314
+ * Operation is success.
94692
95315
  *
94693
95316
  */
94694
- hierarchy_BottomToTopLeft = "Hierarchy_BottomToTopLeft",
95317
+ success = "Success",
94695
95318
  /**
94696
95319
  *
94697
- * Use Hierarchy BottomToTopCenter orientation.
95320
+ * Unexpected error during operation.
94698
95321
  *
94699
95322
  */
94700
- hierarchy_BottomToTopCenter = "Hierarchy_BottomToTopCenter",
95323
+ unexpected = "Unexpected",
94701
95324
  /**
94702
95325
  *
94703
- * Use Hierarchy BottomToTopRight orientation.
95326
+ * Validation error in operation.
94704
95327
  *
94705
95328
  */
94706
- hierarchy_BottomToTopRight = "Hierarchy_BottomToTopRight",
95329
+ validationError = "ValidationError",
94707
95330
  /**
94708
95331
  *
94709
- * Use Hierarchy LeftToRightTop orientation.
95332
+ * Conflict error in operation.
94710
95333
  *
94711
95334
  */
94712
- hierarchy_LeftToRightTop = "Hierarchy_LeftToRightTop",
95335
+ conflictError = "ConflictError",
95336
+ }
95337
+ /**
95338
+ *
95339
+ * Type of the Data Visualizer Diagram operation
95340
+ *
95341
+ * [Api set: 1.1]
95342
+ */
95343
+ enum DataVisualizerDiagramOperationType {
94713
95344
  /**
94714
95345
  *
94715
- * Use Hierarchy LeftToRightMiddle orientation.
95346
+ * unknown operation type.
94716
95347
  *
94717
95348
  */
94718
- hierarchy_LeftToRightMiddle = "Hierarchy_LeftToRightMiddle",
95349
+ unknown = "Unknown",
94719
95350
  /**
94720
95351
  *
94721
- * Use Hierarchy LeftToRightBottom orientation.
95352
+ * Creation operation.
94722
95353
  *
94723
95354
  */
94724
- hierarchy_LeftToRightBottom = "Hierarchy_LeftToRightBottom",
95355
+ create = "Create",
94725
95356
  /**
94726
95357
  *
94727
- * Use Hierarchy RightToLeftTop orientation.
95358
+ * Update Mappings operation.
94728
95359
  *
94729
95360
  */
94730
- hierarchy_RightToLeftTop = "Hierarchy_RightToLeftTop",
95361
+ updateMappings = "UpdateMappings",
94731
95362
  /**
94732
95363
  *
94733
- * Use Hierarchy RightToLeftMiddle orientation.
95364
+ * Update data associated with diagram.
94734
95365
  *
94735
95366
  */
94736
- hierarchy_RightToLeftMiddle = "Hierarchy_RightToLeftMiddle",
95367
+ updateData = "UpdateData",
94737
95368
  /**
94738
95369
  *
94739
- * Use Hierarchy RightToLeftBottom orientation.
95370
+ * Update both data and mappings.
94740
95371
  *
94741
95372
  */
94742
- hierarchy_RightToLeftBottom = "Hierarchy_RightToLeftBottom",
95373
+ update = "Update",
94743
95374
  /**
94744
95375
  *
94745
- * Use OrgChart with HorizontalCenter orientation.
95376
+ * Delete the diagram content.
95377
+ *
95378
+ */
95379
+ delete = "Delete",
95380
+ }
95381
+ /**
95382
+ *
95383
+ * DiagramType for Data Visualizer diagrams
95384
+ *
95385
+ * [Api set: 1.1]
95386
+ */
95387
+ enum DataVisualizerDiagramType {
95388
+ /**
95389
+ *
95390
+ * Unknown
95391
+ *
95392
+ */
95393
+ unknown = "Unknown",
95394
+ /**
95395
+ *
95396
+ * Basic Flowchart
95397
+ *
95398
+ */
95399
+ basicFlowchart = "BasicFlowchart",
95400
+ /**
95401
+ *
95402
+ * Horizontal Cross-Functional Flowchart
95403
+ *
95404
+ */
95405
+ crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
95406
+ /**
95407
+ *
95408
+ * Vertical Cross-Functional Flowchart
95409
+ *
95410
+ */
95411
+ crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
95412
+ /**
95413
+ *
95414
+ * Audit
95415
+ *
95416
+ */
95417
+ audit = "Audit",
95418
+ /**
95419
+ *
95420
+ * OrgChart
95421
+ *
95422
+ */
95423
+ orgChart = "OrgChart",
95424
+ /**
95425
+ *
95426
+ * Network
95427
+ *
95428
+ */
95429
+ network = "Network",
95430
+ }
95431
+ /**
95432
+ *
95433
+ * Represents the type of column values.
95434
+ *
95435
+ * [Api set: 1.1]
95436
+ */
95437
+ enum ColumnType {
95438
+ /**
95439
+ *
95440
+ * Other
95441
+ *
95442
+ */
95443
+ unknown = "Unknown",
95444
+ /**
95445
+ *
95446
+ * String values
95447
+ *
95448
+ */
95449
+ string = "String",
95450
+ /**
95451
+ *
95452
+ * Numerical values
95453
+ *
95454
+ */
95455
+ number = "Number",
95456
+ /**
95457
+ *
95458
+ * Date
95459
+ *
95460
+ */
95461
+ date = "Date",
95462
+ /**
95463
+ *
95464
+ * Currency
95465
+ *
95466
+ */
95467
+ currency = "Currency",
95468
+ }
95469
+ /**
95470
+ *
95471
+ * Represents the type of source for the data connection.
95472
+ *
95473
+ * [Api set: 1.1]
95474
+ */
95475
+ enum DataSourceType {
95476
+ /**
95477
+ *
95478
+ * Unknown Data Source
95479
+ *
95480
+ */
95481
+ unknown = "Unknown",
95482
+ /**
95483
+ *
95484
+ * Microsoft Excel workbook
95485
+ *
95486
+ */
95487
+ excel = "Excel",
95488
+ }
95489
+ /**
95490
+ *
95491
+ * Represents the orientation of the Cross Functional Flowchart diagram.
95492
+ *
95493
+ * [Api set: 1.1]
95494
+ */
95495
+ enum CrossFunctionalFlowchartOrientation {
95496
+ /**
95497
+ *
95498
+ * Horizontal Cross Functional Flowchart.
95499
+ *
95500
+ */
95501
+ horizontal = "Horizontal",
95502
+ /**
95503
+ *
95504
+ * Vertical Cross Functional Flowchart.
95505
+ *
95506
+ */
95507
+ vertical = "Vertical",
95508
+ }
95509
+ /**
95510
+ *
95511
+ * Represents the type of layout.
95512
+ *
95513
+ * [Api set: 1.1]
95514
+ */
95515
+ enum LayoutVariant {
95516
+ /**
95517
+ *
95518
+ * Invalid layout
95519
+ *
95520
+ */
95521
+ unknown = "Unknown",
95522
+ /**
95523
+ *
95524
+ * Use the Page default layout
95525
+ *
95526
+ */
95527
+ pageDefault = "PageDefault",
95528
+ /**
95529
+ *
95530
+ * Use Flowchart with TopToBottom orientation
95531
+ *
95532
+ */
95533
+ flowchart_TopToBottom = "Flowchart_TopToBottom",
95534
+ /**
95535
+ *
95536
+ * Use Flowchart with BottomToTop orientation
95537
+ *
95538
+ */
95539
+ flowchart_BottomToTop = "Flowchart_BottomToTop",
95540
+ /**
95541
+ *
95542
+ * Use Flowchart with LeftToRight orientation
95543
+ *
95544
+ */
95545
+ flowchart_LeftToRight = "Flowchart_LeftToRight",
95546
+ /**
95547
+ *
95548
+ * Use Flowchart with RightToLeft orientation
94746
95549
  *
94747
95550
  */
94748
- orgChart_HorizontalCenter = "OrgChart_HorizontalCenter",
95551
+ flowchart_RightToLeft = "Flowchart_RightToLeft",
95552
+ /**
95553
+ *
95554
+ * Use WideTree with DownThenRight orientation
95555
+ *
95556
+ */
95557
+ wideTree_DownThenRight = "WideTree_DownThenRight",
94749
95558
  /**
94750
95559
  *
94751
- * Use OrgChart with HorizontalCenter LeftToRight orientation.
95560
+ * Use WideTree with DownThenLeft orientation
94752
95561
  *
94753
95562
  */
94754
- orgChart_HorizontalCenter_LeftToRight = "OrgChart_HorizontalCenter_LeftToRight",
95563
+ wideTree_DownThenLeft = "WideTree_DownThenLeft",
94755
95564
  /**
94756
95565
  *
94757
- * Use OrgChart with Hybrid HorizontalCenter and VerticalRight orientation.
95566
+ * Use WideTree with RightThenDown orientation
94758
95567
  *
94759
95568
  */
94760
- orgChart_Hybrid_HorizontalCenter_VerticalRight = "OrgChart_Hybrid_HorizontalCenter_VerticalRight",
95569
+ wideTree_RightThenDown = "WideTree_RightThenDown",
94761
95570
  /**
94762
95571
  *
94763
- * Use OrgChart with SideBySide orientation.
95572
+ * Use WideTree with LeftThenDown orientation
94764
95573
  *
94765
95574
  */
94766
- orgChart_SideBySide = "OrgChart_SideBySide",
95575
+ wideTree_LeftThenDown = "WideTree_LeftThenDown",
94767
95576
  }
94768
95577
  /**
94769
95578
  *
@@ -94774,7 +95583,7 @@ declare namespace Visio {
94774
95583
  enum DataValidationErrorType {
94775
95584
  /**
94776
95585
  *
94777
- * No error.
95586
+ * No error
94778
95587
  *
94779
95588
  */
94780
95589
  none = "None",
@@ -94804,21 +95613,21 @@ declare namespace Visio {
94804
95613
  delimiterError = "DelimiterError",
94805
95614
  /**
94806
95615
  *
94807
- * Connector column has error.
95616
+ * Connector column has error
94808
95617
  *
94809
95618
  */
94810
95619
  connectorColumnError = "ConnectorColumnError",
94811
95620
  /**
94812
95621
  *
94813
95622
  * Connector column is already mapped
94814
- to another setting.
95623
+ to another setting
94815
95624
  *
94816
95625
  */
94817
95626
  connectorColumnMappedElsewhere = "ConnectorColumnMappedElsewhere",
94818
95627
  /**
94819
95628
  *
94820
95629
  * Connector label column already mapped
94821
- to other setting.
95630
+ to other setting
94822
95631
  *
94823
95632
  */
94824
95633
  connectorLabelColumnMappedElsewhere = "ConnectorLabelColumnMappedElsewhere",
@@ -94850,8 +95659,53 @@ declare namespace Visio {
94850
95659
  */
94851
95660
  toTarget = "ToTarget",
94852
95661
  }
95662
+ /**
95663
+ *
95664
+ * 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
95665
+ *
95666
+ * [Api set: 1.1]
95667
+ */
95668
+ enum TaskPaneType {
95669
+ /**
95670
+ *
95671
+ * None Type
95672
+ *
95673
+ */
95674
+ none = "None",
95675
+ /**
95676
+ *
95677
+ * Data Visualizer Process Mapping Pane
95678
+ *
95679
+ */
95680
+ dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
95681
+ /**
95682
+ *
95683
+ * Data Visualizer Organisation Mapping Pane
95684
+ *
95685
+ */
95686
+ dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
95687
+ }
95688
+ /**
95689
+ *
95690
+ * EventType represents the type of the events Host supports
95691
+ *
95692
+ * [Api set: 1.1]
95693
+ */
95694
+ enum EventType {
95695
+ /**
95696
+ *
95697
+ * DataVisualizer diagram operation complete Event
95698
+ *
95699
+ */
95700
+ dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
95701
+ }
94853
95702
  enum ErrorCodes {
95703
+ accessDenied = "AccessDenied",
94854
95704
  generalException = "GeneralException",
95705
+ invalidArgument = "InvalidArgument",
95706
+ itemNotFound = "ItemNotFound",
95707
+ notImplemented = "NotImplemented",
95708
+ unsupportedOperation = "UnsupportedOperation",
94855
95709
  }
94856
95710
  module Interfaces {
94857
95711
  /**
@@ -94869,714 +95723,1088 @@ declare namespace Visio {
94869
95723
  }
94870
95724
  /** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
94871
95725
  interface ApplicationUpdateData {
95726
+ /**
95727
+ *
95728
+ * Show or hide the iFrame application borders.
95729
+ *
95730
+ * [Api set: 1.1]
95731
+ */
95732
+ showBorders?: boolean;
95733
+ /**
95734
+ *
95735
+ * Show or hide the standard toolbars.
95736
+ *
95737
+ * [Api set: 1.1]
95738
+ */
95739
+ showToolbars?: boolean;
95740
+ }
95741
+ /** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
95742
+ interface DocumentUpdateData {
94872
95743
  /**
94873
95744
  *
94874
- * Returns the Active Document.
95745
+ * Represents a Visio application instance that contains this document.
94875
95746
  *
94876
95747
  * [Api set: 1.1]
94877
95748
  */
94878
- activeDocument?: Visio.Interfaces.DocumentUpdateData;
95749
+ application?: Visio.Interfaces.ApplicationUpdateData;
94879
95750
  /**
94880
95751
  *
94881
- * Returns the Active Page.
95752
+ * Returns the DocumentView object.
94882
95753
  *
94883
95754
  * [Api set: 1.1]
94884
95755
  */
94885
- activePage?: Visio.Interfaces.PageUpdateData;
95756
+ view?: Visio.Interfaces.DocumentViewUpdateData;
95757
+ }
95758
+ /** An interface for updating data on the DocumentView object, for use in `documentView.set({ ... })`. */
95759
+ interface DocumentViewUpdateData {
94886
95760
  /**
94887
95761
  *
94888
- * Gets or sets if the application is visible.
95762
+ * Disable Hyperlinks.
94889
95763
  *
94890
95764
  * [Api set: 1.1]
94891
95765
  */
94892
- isVisible?: boolean;
95766
+ disableHyperlinks?: boolean;
94893
95767
  /**
94894
95768
  *
94895
- * Gets or sets the user name of the application.
95769
+ * Disable Pan.
94896
95770
  *
94897
95771
  * [Api set: 1.1]
94898
95772
  */
94899
- userName?: string;
94900
- }
94901
- /** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
94902
- interface DocumentUpdateData {
95773
+ disablePan?: boolean;
94903
95774
  /**
94904
- *
94905
- * Represents a Visio application instance that contains this document.
94906
- *
94907
- * [Api set: 1.1]
94908
- */
94909
- application?: Visio.Interfaces.ApplicationUpdateData;
95775
+ *
95776
+ * Disable PanZoomWindow.
95777
+ *
95778
+ * [Api set: 1.1]
95779
+ */
95780
+ disablePanZoomWindow?: boolean;
94910
95781
  /**
94911
95782
  *
94912
- * Gets or sets the description of the document.
95783
+ * Disable Zoom.
94913
95784
  *
94914
95785
  * [Api set: 1.1]
94915
95786
  */
94916
- description?: string;
94917
- }
94918
- /** An interface for updating data on the DocumentCollection object, for use in `documentCollection.set({ ... })`. */
94919
- interface DocumentCollectionUpdateData {
94920
- items?: Visio.Interfaces.DocumentData[];
95787
+ disableZoom?: boolean;
95788
+ /**
95789
+ *
95790
+ * Hide Diagram Boundary.
95791
+ *
95792
+ * [Api set: 1.1]
95793
+ */
95794
+ hideDiagramBoundary?: boolean;
94921
95795
  }
94922
95796
  /** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
94923
95797
  interface PageUpdateData {
94924
95798
  /**
94925
95799
  *
94926
- * Returns the instance of Microsoft Visio that is associated with an object.
95800
+ * Returns the view of the page.
94927
95801
  *
94928
95802
  * [Api set: 1.1]
94929
95803
  */
94930
- application?: Visio.Interfaces.ApplicationUpdateData;
95804
+ view?: Visio.Interfaces.PageViewUpdateData;
95805
+ }
95806
+ /** An interface for updating data on the PageView object, for use in `pageView.set({ ... })`. */
95807
+ interface PageViewUpdateData {
94931
95808
  /**
94932
- *
94933
- * Gets the document object that is assocaited with the page.
94934
- *
94935
- * [Api set: 1.1]
94936
- */
94937
- document?: Visio.Interfaces.DocumentUpdateData;
95809
+ *
95810
+ * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
95811
+ *
95812
+ * [Api set: 1.1]
95813
+ */
95814
+ zoom?: number;
94938
95815
  }
94939
95816
  /** An interface for updating data on the PageCollection object, for use in `pageCollection.set({ ... })`. */
94940
95817
  interface PageCollectionUpdateData {
94941
95818
  items?: Visio.Interfaces.PageData[];
94942
95819
  }
95820
+ /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
95821
+ interface ShapeCollectionUpdateData {
95822
+ items?: Visio.Interfaces.ShapeData[];
95823
+ }
94943
95824
  /** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
94944
95825
  interface ShapeUpdateData {
94945
95826
  /**
94946
95827
  *
94947
- * Returns the instance of Microsoft Visio that is associated with an object.
95828
+ * Returns the view of the shape.
94948
95829
  *
94949
95830
  * [Api set: 1.1]
94950
95831
  */
94951
- application?: Visio.Interfaces.ApplicationUpdateData;
95832
+ view?: Visio.Interfaces.ShapeViewUpdateData;
94952
95833
  /**
94953
- *
94954
- * Gets the document object that is assocaited with the shape.
94955
- *
94956
- * [Api set: 1.1]
94957
- */
94958
- document?: Visio.Interfaces.DocumentUpdateData;
95834
+ *
95835
+ * Returns true, if shape is selected. User can set true to select the shape explicitly.
95836
+ *
95837
+ * [Api set: 1.1]
95838
+ */
95839
+ select?: boolean;
94959
95840
  }
94960
- /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
94961
- interface ShapeCollectionUpdateData {
94962
- items?: Visio.Interfaces.ShapeData[];
95841
+ /** An interface for updating data on the ShapeView object, for use in `shapeView.set({ ... })`. */
95842
+ interface ShapeViewUpdateData {
95843
+ /**
95844
+ *
95845
+ * Represents the highlight around the shape.
95846
+ *
95847
+ * [Api set: 1.1]
95848
+ */
95849
+ highlight?: Visio.Highlight;
95850
+ }
95851
+ /** An interface for updating data on the ShapeDataItemCollection object, for use in `shapeDataItemCollection.set({ ... })`. */
95852
+ interface ShapeDataItemCollectionUpdateData {
95853
+ items?: Visio.Interfaces.ShapeDataItemData[];
95854
+ }
95855
+ /** An interface for updating data on the HyperlinkCollection object, for use in `hyperlinkCollection.set({ ... })`. */
95856
+ interface HyperlinkCollectionUpdateData {
95857
+ items?: Visio.Interfaces.HyperlinkData[];
95858
+ }
95859
+ /** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */
95860
+ interface CommentCollectionUpdateData {
95861
+ items?: Visio.Interfaces.CommentData[];
95862
+ }
95863
+ /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
95864
+ interface CommentUpdateData {
95865
+ /**
95866
+ *
95867
+ * A string that specifies the name of the author of the comment.
95868
+ *
95869
+ * [Api set: 1.1]
95870
+ */
95871
+ author?: string;
95872
+ /**
95873
+ *
95874
+ * A string that specifies the date when the comment was created.
95875
+ *
95876
+ * [Api set: 1.1]
95877
+ */
95878
+ date?: string;
95879
+ /**
95880
+ *
95881
+ * A string that contains the comment text.
95882
+ *
95883
+ * [Api set: 1.1]
95884
+ */
95885
+ text?: string;
94963
95886
  }
94964
95887
  /** An interface describing the data returned by calling `application.toJSON()`. */
94965
95888
  interface ApplicationData {
95889
+ /**
95890
+ *
95891
+ * Show or hide the iFrame application borders.
95892
+ *
95893
+ * [Api set: 1.1]
95894
+ */
95895
+ showBorders?: boolean;
95896
+ /**
95897
+ *
95898
+ * Show or hide the standard toolbars.
95899
+ *
95900
+ * [Api set: 1.1]
95901
+ */
95902
+ showToolbars?: boolean;
95903
+ }
95904
+ /** An interface describing the data returned by calling `document.toJSON()`. */
95905
+ interface DocumentData {
94966
95906
  /**
94967
95907
  *
94968
- * Returns the Active Document. Read-only.
95908
+ * Represents a Visio application instance that contains this document. Read-only.
94969
95909
  *
94970
95910
  * [Api set: 1.1]
94971
95911
  */
94972
- activeDocument?: Visio.Interfaces.DocumentData;
95912
+ application?: Visio.Interfaces.ApplicationData;
94973
95913
  /**
94974
95914
  *
94975
- * Returns the Active Page. Read-only.
95915
+ * Represents a collection of pages associated with the document. Read-only.
94976
95916
  *
94977
95917
  * [Api set: 1.1]
94978
95918
  */
94979
- activePage?: Visio.Interfaces.PageData;
95919
+ pages?: Visio.Interfaces.PageData[];
94980
95920
  /**
94981
95921
  *
94982
- * Returns the Documents collection for a Microsoft Visio instance. Read-only.
95922
+ * Returns the DocumentView object. Read-only.
94983
95923
  *
94984
95924
  * [Api set: 1.1]
94985
95925
  */
94986
- documents?: Visio.Interfaces.DocumentData[];
95926
+ view?: Visio.Interfaces.DocumentViewData;
95927
+ }
95928
+ /** An interface describing the data returned by calling `documentView.toJSON()`. */
95929
+ interface DocumentViewData {
95930
+ /**
95931
+ *
95932
+ * Disable Hyperlinks.
95933
+ *
95934
+ * [Api set: 1.1]
95935
+ */
95936
+ disableHyperlinks?: boolean;
95937
+ /**
95938
+ *
95939
+ * Disable Pan.
95940
+ *
95941
+ * [Api set: 1.1]
95942
+ */
95943
+ disablePan?: boolean;
94987
95944
  /**
94988
95945
  *
94989
- * Gets or sets if the application is visible.
95946
+ * Disable PanZoomWindow.
94990
95947
  *
94991
95948
  * [Api set: 1.1]
94992
95949
  */
94993
- isVisible?: boolean;
95950
+ disablePanZoomWindow?: boolean;
94994
95951
  /**
94995
95952
  *
94996
- * Specifies the name of the application. Read-only.
95953
+ * Disable Zoom.
95954
+ *
95955
+ * [Api set: 1.1]
95956
+ */
95957
+ disableZoom?: boolean;
95958
+ /**
95959
+ *
95960
+ * Hide Diagram Boundary.
95961
+ *
95962
+ * [Api set: 1.1]
95963
+ */
95964
+ hideDiagramBoundary?: boolean;
95965
+ }
95966
+ /** An interface describing the data returned by calling `page.toJSON()`. */
95967
+ interface PageData {
95968
+ /**
95969
+ *
95970
+ * All shapes in the Page, including subshapes. Read-only.
95971
+ *
95972
+ * [Api set: 1.1]
95973
+ */
95974
+ allShapes?: Visio.Interfaces.ShapeData[];
95975
+ /**
95976
+ *
95977
+ * Returns the Comments Collection. Read-only.
95978
+ *
95979
+ * [Api set: 1.1]
95980
+ */
95981
+ comments?: Visio.Interfaces.CommentData[];
95982
+ /**
95983
+ *
95984
+ * All top-level shapes in the Page.Read-only.
95985
+ *
95986
+ * [Api set: 1.1]
95987
+ */
95988
+ shapes?: Visio.Interfaces.ShapeData[];
95989
+ /**
95990
+ *
95991
+ * Returns the view of the page. Read-only.
95992
+ *
95993
+ * [Api set: 1.1]
95994
+ */
95995
+ view?: Visio.Interfaces.PageViewData;
95996
+ /**
95997
+ *
95998
+ * Returns the height of the page. Read-only.
95999
+ *
96000
+ * [Api set: 1.1]
96001
+ */
96002
+ height?: number;
96003
+ /**
96004
+ *
96005
+ * Index of the Page. Read-only.
96006
+ *
96007
+ * [Api set: 1.1]
96008
+ */
96009
+ index?: number;
96010
+ /**
96011
+ *
96012
+ * Whether the page is a background page or not. Read-only.
96013
+ *
96014
+ * [Api set: 1.1]
96015
+ */
96016
+ isBackground?: boolean;
96017
+ /**
96018
+ *
96019
+ * Page name. Read-only.
94997
96020
  *
94998
96021
  * [Api set: 1.1]
94999
96022
  */
95000
96023
  name?: string;
95001
96024
  /**
95002
96025
  *
95003
- * Gets or sets the user name of the application.
96026
+ * Returns the width of the page. Read-only.
95004
96027
  *
95005
96028
  * [Api set: 1.1]
95006
96029
  */
95007
- userName?: string;
96030
+ width?: number;
95008
96031
  }
95009
- /** An interface describing the data returned by calling `document.toJSON()`. */
95010
- interface DocumentData {
96032
+ /** An interface describing the data returned by calling `pageView.toJSON()`. */
96033
+ interface PageViewData {
96034
+ /**
96035
+ *
96036
+ * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
96037
+ *
96038
+ * [Api set: 1.1]
96039
+ */
96040
+ zoom?: number;
96041
+ }
96042
+ /** An interface describing the data returned by calling `pageCollection.toJSON()`. */
96043
+ interface PageCollectionData {
96044
+ items?: Visio.Interfaces.PageData[];
96045
+ }
96046
+ /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
96047
+ interface ShapeCollectionData {
96048
+ items?: Visio.Interfaces.ShapeData[];
96049
+ }
96050
+ /** An interface describing the data returned by calling `shape.toJSON()`. */
96051
+ interface ShapeData {
95011
96052
  /**
95012
96053
  *
95013
- * Represents a Visio application instance that contains this document. Read-only.
96054
+ * Returns the Comments Collection. Read-only.
95014
96055
  *
95015
96056
  * [Api set: 1.1]
95016
96057
  */
95017
- application?: Visio.Interfaces.ApplicationData;
96058
+ comments?: Visio.Interfaces.CommentData[];
95018
96059
  /**
95019
96060
  *
95020
- * Represents a collection of pages associated with the document. Read-only.
96061
+ * Returns the Hyperlinks collection for a Shape object. Read-only.
95021
96062
  *
95022
96063
  * [Api set: 1.1]
95023
96064
  */
95024
- pages?: Visio.Interfaces.PageData[];
96065
+ hyperlinks?: Visio.Interfaces.HyperlinkData[];
96066
+ /**
96067
+ *
96068
+ * Returns the Shape's Data Section. Read-only.
96069
+ *
96070
+ * [Api set: 1.1]
96071
+ */
96072
+ shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
96073
+ /**
96074
+ *
96075
+ * Gets SubShape Collection. Read-only.
96076
+ *
96077
+ * [Api set: 1.1]
96078
+ */
96079
+ subShapes?: Visio.Interfaces.ShapeData[];
96080
+ /**
96081
+ *
96082
+ * Returns the view of the shape. Read-only.
96083
+ *
96084
+ * [Api set: 1.1]
96085
+ */
96086
+ view?: Visio.Interfaces.ShapeViewData;
96087
+ /**
96088
+ *
96089
+ * Shape's identifier. Read-only.
96090
+ *
96091
+ * [Api set: 1.1]
96092
+ */
96093
+ id?: number;
96094
+ /**
96095
+ *
96096
+ * Shape's name. Read-only.
96097
+ *
96098
+ * [Api set: 1.1]
96099
+ */
96100
+ name?: string;
96101
+ /**
96102
+ *
96103
+ * Returns true, if shape is selected. User can set true to select the shape explicitly.
96104
+ *
96105
+ * [Api set: 1.1]
96106
+ */
96107
+ select?: boolean;
96108
+ /**
96109
+ *
96110
+ * Shape's text. Read-only.
96111
+ *
96112
+ * [Api set: 1.1]
96113
+ */
96114
+ text?: string;
96115
+ }
96116
+ /** An interface describing the data returned by calling `shapeView.toJSON()`. */
96117
+ interface ShapeViewData {
95025
96118
  /**
95026
96119
  *
95027
- * Gets or sets the description of the document.
96120
+ * Represents the highlight around the shape.
96121
+ *
96122
+ * [Api set: 1.1]
96123
+ */
96124
+ highlight?: Visio.Highlight;
96125
+ }
96126
+ /** An interface describing the data returned by calling `shapeDataItemCollection.toJSON()`. */
96127
+ interface ShapeDataItemCollectionData {
96128
+ items?: Visio.Interfaces.ShapeDataItemData[];
96129
+ }
96130
+ /** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
96131
+ interface ShapeDataItemData {
96132
+ /**
96133
+ *
96134
+ * A string that specifies the format of the shape data item. Read-only.
96135
+ *
96136
+ * [Api set: 1.1]
96137
+ */
96138
+ format?: string;
96139
+ /**
96140
+ *
96141
+ * A string that specifies the formatted value of the shape data item. Read-only.
96142
+ *
96143
+ * [Api set: 1.1]
96144
+ */
96145
+ formattedValue?: string;
96146
+ /**
96147
+ *
96148
+ * A string that specifies the label of the shape data item. Read-only.
96149
+ *
96150
+ * [Api set: 1.1]
96151
+ */
96152
+ label?: string;
96153
+ /**
96154
+ *
96155
+ * A string that specifies the value of the shape data item. Read-only.
96156
+ *
96157
+ * [Api set: 1.1]
96158
+ */
96159
+ value?: string;
96160
+ }
96161
+ /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
96162
+ interface HyperlinkCollectionData {
96163
+ items?: Visio.Interfaces.HyperlinkData[];
96164
+ }
96165
+ /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
96166
+ interface HyperlinkData {
96167
+ /**
96168
+ *
96169
+ * Gets the address of the Hyperlink object. Read-only.
96170
+ *
96171
+ * [Api set: 1.1]
96172
+ */
96173
+ address?: string;
96174
+ /**
96175
+ *
96176
+ * Gets the description of a hyperlink. Read-only.
95028
96177
  *
95029
96178
  * [Api set: 1.1]
95030
96179
  */
95031
96180
  description?: string;
95032
96181
  /**
95033
96182
  *
95034
- * Returns the name of the document, including the drive and path. Read-only.
96183
+ * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
96184
+ *
96185
+ * [Api set: 1.1]
96186
+ */
96187
+ extraInfo?: string;
96188
+ /**
96189
+ *
96190
+ * Gets the sub-address of the Hyperlink object. Read-only.
96191
+ *
96192
+ * [Api set: 1.1]
96193
+ */
96194
+ subAddress?: string;
96195
+ }
96196
+ /** An interface describing the data returned by calling `commentCollection.toJSON()`. */
96197
+ interface CommentCollectionData {
96198
+ items?: Visio.Interfaces.CommentData[];
96199
+ }
96200
+ /** An interface describing the data returned by calling `comment.toJSON()`. */
96201
+ interface CommentData {
96202
+ /**
96203
+ *
96204
+ * A string that specifies the name of the author of the comment.
95035
96205
  *
95036
96206
  * [Api set: 1.1]
95037
96207
  */
95038
- fullName?: string;
96208
+ author?: string;
96209
+ /**
96210
+ *
96211
+ * A string that specifies the date when the comment was created.
96212
+ *
96213
+ * [Api set: 1.1]
96214
+ */
96215
+ date?: string;
96216
+ /**
96217
+ *
96218
+ * A string that contains the comment text.
96219
+ *
96220
+ * [Api set: 1.1]
96221
+ */
96222
+ text?: string;
96223
+ }
96224
+ /** An interface describing the data returned by calling `selection.toJSON()`. */
96225
+ interface SelectionData {
96226
+ /**
96227
+ *
96228
+ * Gets the Shapes of the Selection. Read-only.
96229
+ *
96230
+ * [Api set: 1.1]
96231
+ */
96232
+ shapes?: Visio.Interfaces.ShapeData[];
96233
+ }
96234
+ /**
96235
+ *
96236
+ * Represents the Application.
96237
+ *
96238
+ * [Api set: 1.1]
96239
+ */
96240
+ interface ApplicationLoadOptions {
96241
+ /**
96242
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96243
+ */
96244
+ $all?: boolean;
96245
+ /**
96246
+ *
96247
+ * Show or hide the iFrame application borders.
96248
+ *
96249
+ * [Api set: 1.1]
96250
+ */
96251
+ showBorders?: boolean;
96252
+ /**
96253
+ *
96254
+ * Show or hide the standard toolbars.
96255
+ *
96256
+ * [Api set: 1.1]
96257
+ */
96258
+ showToolbars?: boolean;
96259
+ }
96260
+ /**
96261
+ *
96262
+ * Represents the Document class.
96263
+ *
96264
+ * [Api set: 1.1]
96265
+ */
96266
+ interface DocumentLoadOptions {
96267
+ /**
96268
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96269
+ */
96270
+ $all?: boolean;
96271
+ /**
96272
+ *
96273
+ * Represents a Visio application instance that contains this document.
96274
+ *
96275
+ * [Api set: 1.1]
96276
+ */
96277
+ application?: Visio.Interfaces.ApplicationLoadOptions;
96278
+ /**
96279
+ *
96280
+ * Returns the DocumentView object.
96281
+ *
96282
+ * [Api set: 1.1]
96283
+ */
96284
+ view?: Visio.Interfaces.DocumentViewLoadOptions;
96285
+ }
96286
+ /**
96287
+ *
96288
+ * Represents the DocumentView class.
96289
+ *
96290
+ * [Api set: 1.1]
96291
+ */
96292
+ interface DocumentViewLoadOptions {
95039
96293
  /**
95040
- *
95041
- * Returns the ID of the document. Read-only
95042
- *
95043
- * [Api set: 1.1]
96294
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95044
96295
  */
95045
- id?: string;
96296
+ $all?: boolean;
95046
96297
  /**
95047
96298
  *
95048
- * Returns the ordinal position of a Document object in the Documents Collection. Read-only.
96299
+ * Disable Hyperlinks.
95049
96300
  *
95050
96301
  * [Api set: 1.1]
95051
96302
  */
95052
- index?: number;
96303
+ disableHyperlinks?: boolean;
95053
96304
  /**
95054
96305
  *
95055
- * Returns the name of the document.
96306
+ * Disable Pan.
95056
96307
  *
95057
96308
  * [Api set: 1.1]
95058
96309
  */
95059
- name?: string;
95060
- }
95061
- /** An interface describing the data returned by calling `documentCollection.toJSON()`. */
95062
- interface DocumentCollectionData {
95063
- items?: Visio.Interfaces.DocumentData[];
95064
- }
95065
- /** An interface describing the data returned by calling `page.toJSON()`. */
95066
- interface PageData {
95067
- /**
95068
- *
95069
- * Returns the instance of Microsoft Visio that is associated with an object. Read-only.
95070
- *
95071
- * [Api set: 1.1]
95072
- */
95073
- application?: Visio.Interfaces.ApplicationData;
95074
- /**
95075
- *
95076
- * Gets the document object that is assocaited with the page. Read-only.
95077
- *
95078
- * [Api set: 1.1]
95079
- */
95080
- document?: Visio.Interfaces.DocumentData;
95081
- /**
95082
- *
95083
- * Shapes at root level, in the page. Read-only.
95084
- *
95085
- * [Api set: 1.1]
95086
- */
95087
- shapes?: Visio.Interfaces.ShapeData[];
96310
+ disablePan?: boolean;
95088
96311
  /**
95089
96312
  *
95090
- * Returns the ID of the page. Read-only
96313
+ * Disable PanZoomWindow.
95091
96314
  *
95092
96315
  * [Api set: 1.1]
95093
96316
  */
95094
- id?: number;
96317
+ disablePanZoomWindow?: boolean;
95095
96318
  /**
95096
96319
  *
95097
- * Index of the Page.
96320
+ * Disable Zoom.
95098
96321
  *
95099
96322
  * [Api set: 1.1]
95100
96323
  */
95101
- index?: number;
96324
+ disableZoom?: boolean;
95102
96325
  /**
95103
96326
  *
95104
- * Page name. Read-only.
96327
+ * Hide Diagram Boundary.
95105
96328
  *
95106
96329
  * [Api set: 1.1]
95107
96330
  */
95108
- name?: string;
95109
- }
95110
- /** An interface describing the data returned by calling `pageCollection.toJSON()`. */
95111
- interface PageCollectionData {
95112
- items?: Visio.Interfaces.PageData[];
96331
+ hideDiagramBoundary?: boolean;
95113
96332
  }
95114
- /** An interface describing the data returned by calling `shape.toJSON()`. */
95115
- interface ShapeData {
96333
+ /**
96334
+ *
96335
+ * Represents the Page class.
96336
+ *
96337
+ * [Api set: 1.1]
96338
+ */
96339
+ interface PageLoadOptions {
95116
96340
  /**
95117
- *
95118
- * Returns the instance of Microsoft Visio that is associated with an object. Read-only.
95119
- *
95120
- * [Api set: 1.1]
95121
- */
95122
- application?: Visio.Interfaces.ApplicationData;
96341
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96342
+ */
96343
+ $all?: boolean;
95123
96344
  /**
95124
96345
  *
95125
- * Gets the document object that is assocaited with the shape. Read-only.
96346
+ * Returns the view of the page.
95126
96347
  *
95127
96348
  * [Api set: 1.1]
95128
96349
  */
95129
- document?: Visio.Interfaces.DocumentData;
96350
+ view?: Visio.Interfaces.PageViewLoadOptions;
95130
96351
  /**
95131
96352
  *
95132
- * Shape's Identifier.
96353
+ * Returns the height of the page. Read-only.
95133
96354
  *
95134
96355
  * [Api set: 1.1]
95135
96356
  */
95136
- id?: number;
96357
+ height?: boolean;
95137
96358
  /**
95138
96359
  *
95139
- * Indicates whether the shape is a callout shape. Read-only.
96360
+ * Index of the Page. Read-only.
95140
96361
  *
95141
96362
  * [Api set: 1.1]
95142
96363
  */
95143
- isCallout?: boolean;
96364
+ index?: boolean;
95144
96365
  /**
95145
96366
  *
95146
- * Specifes whether a shape is a data graphic callout. Read-only.
96367
+ * Whether the page is a background page or not. Read-only.
95147
96368
  *
95148
96369
  * [Api set: 1.1]
95149
96370
  */
95150
- isDataGraphicCallout?: boolean;
96371
+ isBackground?: boolean;
95151
96372
  /**
95152
96373
  *
95153
- * Indicates whether a shape is currently open for interactive text editing. Read-only.
96374
+ * Page name. Read-only.
95154
96375
  *
95155
96376
  * [Api set: 1.1]
95156
96377
  */
95157
- isOpenForTextEdit?: boolean;
96378
+ name?: boolean;
95158
96379
  /**
95159
96380
  *
95160
- * Shape's name.
96381
+ * Returns the width of the page. Read-only.
95161
96382
  *
95162
96383
  * [Api set: 1.1]
95163
96384
  */
95164
- name?: string;
96385
+ width?: boolean;
96386
+ }
96387
+ /**
96388
+ *
96389
+ * Represents the PageView class.
96390
+ *
96391
+ * [Api set: 1.1]
96392
+ */
96393
+ interface PageViewLoadOptions {
95165
96394
  /**
95166
- *
95167
- * Returns the type of the object. Read-only.(Shape_Type will give OACR Warning :61721)
95168
- *
95169
- * [Api set: 1.1]
96395
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95170
96396
  */
95171
- objType?: number;
96397
+ $all?: boolean;
95172
96398
  /**
95173
96399
  *
95174
- * Shape's Text.
96400
+ * Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
95175
96401
  *
95176
96402
  * [Api set: 1.1]
95177
96403
  */
95178
- text?: string;
95179
- }
95180
- /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
95181
- interface ShapeCollectionData {
95182
- items?: Visio.Interfaces.ShapeData[];
96404
+ zoom?: boolean;
95183
96405
  }
95184
96406
  /**
96407
+ *
96408
+ * Represents a collection of Page objects that are part of the document.
96409
+ *
95185
96410
  * [Api set: 1.1]
95186
96411
  */
95187
- interface ApplicationLoadOptions {
96412
+ interface PageCollectionLoadOptions {
95188
96413
  /**
95189
96414
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95190
96415
  */
95191
96416
  $all?: boolean;
95192
96417
  /**
95193
96418
  *
95194
- * Returns the Active Document.
96419
+ * For EACH ITEM in the collection: Returns the view of the page.
95195
96420
  *
95196
96421
  * [Api set: 1.1]
95197
96422
  */
95198
- activeDocument?: Visio.Interfaces.DocumentLoadOptions;
96423
+ view?: Visio.Interfaces.PageViewLoadOptions;
95199
96424
  /**
95200
- *
95201
- * Returns the Active Page.
95202
- *
95203
- * [Api set: 1.1]
95204
- */
95205
- activePage?: Visio.Interfaces.PageLoadOptions;
96425
+ *
96426
+ * For EACH ITEM in the collection: Returns the height of the page. Read-only.
96427
+ *
96428
+ * [Api set: 1.1]
96429
+ */
96430
+ height?: boolean;
96431
+ /**
96432
+ *
96433
+ * For EACH ITEM in the collection: Index of the Page. Read-only.
96434
+ *
96435
+ * [Api set: 1.1]
96436
+ */
96437
+ index?: boolean;
95206
96438
  /**
95207
96439
  *
95208
- * Gets or sets if the application is visible.
96440
+ * For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
95209
96441
  *
95210
96442
  * [Api set: 1.1]
95211
96443
  */
95212
- isVisible?: boolean;
96444
+ isBackground?: boolean;
95213
96445
  /**
95214
96446
  *
95215
- * Specifies the name of the application. Read-only.
96447
+ * For EACH ITEM in the collection: Page name. Read-only.
95216
96448
  *
95217
96449
  * [Api set: 1.1]
95218
96450
  */
95219
96451
  name?: boolean;
95220
96452
  /**
95221
96453
  *
95222
- * Gets or sets the user name of the application.
96454
+ * For EACH ITEM in the collection: Returns the width of the page. Read-only.
95223
96455
  *
95224
96456
  * [Api set: 1.1]
95225
96457
  */
95226
- userName?: boolean;
96458
+ width?: boolean;
95227
96459
  }
95228
96460
  /**
96461
+ *
96462
+ * Represents the Shape Collection.
96463
+ *
95229
96464
  * [Api set: 1.1]
95230
96465
  */
95231
- interface DocumentLoadOptions {
96466
+ interface ShapeCollectionLoadOptions {
95232
96467
  /**
95233
96468
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95234
96469
  */
95235
96470
  $all?: boolean;
95236
96471
  /**
95237
96472
  *
95238
- * Represents a Visio application instance that contains this document.
96473
+ * For EACH ITEM in the collection: Returns the view of the shape.
95239
96474
  *
95240
96475
  * [Api set: 1.1]
95241
96476
  */
95242
- application?: Visio.Interfaces.ApplicationLoadOptions;
96477
+ view?: Visio.Interfaces.ShapeViewLoadOptions;
95243
96478
  /**
95244
96479
  *
95245
- * Gets or sets the description of the document.
96480
+ * For EACH ITEM in the collection: Shape's identifier. Read-only.
95246
96481
  *
95247
96482
  * [Api set: 1.1]
95248
96483
  */
95249
- description?: boolean;
96484
+ id?: boolean;
95250
96485
  /**
95251
96486
  *
95252
- * Returns the name of the document, including the drive and path. Read-only.
96487
+ * For EACH ITEM in the collection: Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
95253
96488
  *
95254
96489
  * [Api set: 1.1]
95255
96490
  */
95256
- fullName?: boolean;
96491
+ isBoundToData?: boolean;
95257
96492
  /**
95258
96493
  *
95259
- * Returns the ID of the document. Read-only
96494
+ * For EACH ITEM in the collection: Shape's name. Read-only.
95260
96495
  *
95261
96496
  * [Api set: 1.1]
95262
96497
  */
95263
- id?: boolean;
96498
+ name?: boolean;
95264
96499
  /**
95265
96500
  *
95266
- * Returns the ordinal position of a Document object in the Documents Collection. Read-only.
96501
+ * For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
95267
96502
  *
95268
96503
  * [Api set: 1.1]
95269
96504
  */
95270
- index?: boolean;
96505
+ select?: boolean;
95271
96506
  /**
95272
96507
  *
95273
- * Returns the name of the document.
96508
+ * For EACH ITEM in the collection: Shape's text. Read-only.
95274
96509
  *
95275
96510
  * [Api set: 1.1]
95276
96511
  */
95277
- name?: boolean;
96512
+ text?: boolean;
95278
96513
  }
95279
96514
  /**
96515
+ *
96516
+ * Represents the Shape class.
96517
+ *
95280
96518
  * [Api set: 1.1]
95281
96519
  */
95282
- interface DocumentCollectionLoadOptions {
96520
+ interface ShapeLoadOptions {
95283
96521
  /**
95284
96522
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95285
96523
  */
95286
96524
  $all?: boolean;
95287
96525
  /**
95288
96526
  *
95289
- * For EACH ITEM in the collection: Represents a Visio application instance that contains this document.
96527
+ * Returns the view of the shape.
95290
96528
  *
95291
96529
  * [Api set: 1.1]
95292
96530
  */
95293
- application?: Visio.Interfaces.ApplicationLoadOptions;
96531
+ view?: Visio.Interfaces.ShapeViewLoadOptions;
95294
96532
  /**
95295
96533
  *
95296
- * For EACH ITEM in the collection: Gets or sets the description of the document.
96534
+ * Shape's identifier. Read-only.
95297
96535
  *
95298
96536
  * [Api set: 1.1]
95299
96537
  */
95300
- description?: boolean;
96538
+ id?: boolean;
95301
96539
  /**
95302
96540
  *
95303
- * For EACH ITEM in the collection: Returns the name of the document, including the drive and path. Read-only.
96541
+ * Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
95304
96542
  *
95305
96543
  * [Api set: 1.1]
95306
96544
  */
95307
- fullName?: boolean;
96545
+ isBoundToData?: boolean;
95308
96546
  /**
95309
96547
  *
95310
- * For EACH ITEM in the collection: Returns the ID of the document. Read-only
96548
+ * Shape's name. Read-only.
95311
96549
  *
95312
96550
  * [Api set: 1.1]
95313
96551
  */
95314
- id?: boolean;
96552
+ name?: boolean;
95315
96553
  /**
95316
96554
  *
95317
- * For EACH ITEM in the collection: Returns the ordinal position of a Document object in the Documents Collection. Read-only.
96555
+ * Returns true, if shape is selected. User can set true to select the shape explicitly.
95318
96556
  *
95319
96557
  * [Api set: 1.1]
95320
96558
  */
95321
- index?: boolean;
96559
+ select?: boolean;
95322
96560
  /**
95323
96561
  *
95324
- * For EACH ITEM in the collection: Returns the name of the document.
96562
+ * Shape's text. Read-only.
95325
96563
  *
95326
96564
  * [Api set: 1.1]
95327
96565
  */
95328
- name?: boolean;
96566
+ text?: boolean;
95329
96567
  }
95330
96568
  /**
96569
+ *
96570
+ * Represents the ShapeView class.
96571
+ *
95331
96572
  * [Api set: 1.1]
95332
96573
  */
95333
- interface PageLoadOptions {
96574
+ interface ShapeViewLoadOptions {
95334
96575
  /**
95335
96576
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95336
96577
  */
95337
96578
  $all?: boolean;
95338
96579
  /**
95339
- *
95340
- * Returns the instance of Microsoft Visio that is associated with an object.
95341
- *
95342
- * [Api set: 1.1]
95343
- */
95344
- application?: Visio.Interfaces.ApplicationLoadOptions;
96580
+ *
96581
+ * Represents the highlight around the shape.
96582
+ *
96583
+ * [Api set: 1.1]
96584
+ */
96585
+ highlight?: boolean;
96586
+ }
96587
+ /**
96588
+ *
96589
+ * Represents the ShapeDataItemCollection for a given Shape.
96590
+ *
96591
+ * [Api set: 1.1]
96592
+ */
96593
+ interface ShapeDataItemCollectionLoadOptions {
95345
96594
  /**
95346
- *
95347
- * Gets the document object that is assocaited with the page.
95348
- *
95349
- * [Api set: 1.1]
95350
- */
95351
- document?: Visio.Interfaces.DocumentLoadOptions;
96595
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96596
+ */
96597
+ $all?: boolean;
95352
96598
  /**
95353
96599
  *
95354
- * Returns the ID of the page. Read-only
96600
+ * For EACH ITEM in the collection: A string that specifies the format of the shape data item. Read-only.
95355
96601
  *
95356
96602
  * [Api set: 1.1]
95357
96603
  */
95358
- id?: boolean;
96604
+ format?: boolean;
95359
96605
  /**
95360
96606
  *
95361
- * Index of the Page.
96607
+ * For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item. Read-only.
95362
96608
  *
95363
96609
  * [Api set: 1.1]
95364
96610
  */
95365
- index?: boolean;
96611
+ formattedValue?: boolean;
95366
96612
  /**
95367
96613
  *
95368
- * Page name. Read-only.
96614
+ * For EACH ITEM in the collection: A string that specifies the label of the shape data item. Read-only.
95369
96615
  *
95370
96616
  * [Api set: 1.1]
95371
96617
  */
95372
- name?: boolean;
96618
+ label?: boolean;
96619
+ /**
96620
+ *
96621
+ * For EACH ITEM in the collection: A string that specifies the value of the shape data item. Read-only.
96622
+ *
96623
+ * [Api set: 1.1]
96624
+ */
96625
+ value?: boolean;
95373
96626
  }
95374
96627
  /**
95375
96628
  *
95376
- * Represents a collection of Page objects that are part of the Document.
96629
+ * Represents the ShapeDataItem.
95377
96630
  *
95378
96631
  * [Api set: 1.1]
95379
96632
  */
95380
- interface PageCollectionLoadOptions {
96633
+ interface ShapeDataItemLoadOptions {
95381
96634
  /**
95382
96635
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95383
96636
  */
95384
96637
  $all?: boolean;
95385
96638
  /**
95386
- *
95387
- * For EACH ITEM in the collection: Returns the instance of Microsoft Visio that is associated with an object.
95388
- *
95389
- * [Api set: 1.1]
95390
- */
95391
- application?: Visio.Interfaces.ApplicationLoadOptions;
95392
- /**
95393
- *
95394
- * For EACH ITEM in the collection: Gets the document object that is assocaited with the page.
95395
- *
95396
- * [Api set: 1.1]
95397
- */
95398
- document?: Visio.Interfaces.DocumentLoadOptions;
96639
+ *
96640
+ * A string that specifies the format of the shape data item. Read-only.
96641
+ *
96642
+ * [Api set: 1.1]
96643
+ */
96644
+ format?: boolean;
95399
96645
  /**
95400
96646
  *
95401
- * For EACH ITEM in the collection: Returns the ID of the page. Read-only
96647
+ * A string that specifies the formatted value of the shape data item. Read-only.
95402
96648
  *
95403
96649
  * [Api set: 1.1]
95404
96650
  */
95405
- id?: boolean;
96651
+ formattedValue?: boolean;
95406
96652
  /**
95407
96653
  *
95408
- * For EACH ITEM in the collection: Index of the Page.
96654
+ * A string that specifies the label of the shape data item. Read-only.
95409
96655
  *
95410
96656
  * [Api set: 1.1]
95411
96657
  */
95412
- index?: boolean;
96658
+ label?: boolean;
95413
96659
  /**
95414
96660
  *
95415
- * For EACH ITEM in the collection: Page name. Read-only.
96661
+ * A string that specifies the value of the shape data item. Read-only.
95416
96662
  *
95417
96663
  * [Api set: 1.1]
95418
96664
  */
95419
- name?: boolean;
96665
+ value?: boolean;
95420
96666
  }
95421
96667
  /**
95422
96668
  *
95423
- * Represents the Shape class.
96669
+ * Represents the Hyperlink Collection.
95424
96670
  *
95425
96671
  * [Api set: 1.1]
95426
96672
  */
95427
- interface ShapeLoadOptions {
96673
+ interface HyperlinkCollectionLoadOptions {
95428
96674
  /**
95429
96675
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95430
96676
  */
95431
96677
  $all?: boolean;
95432
- /**
95433
- *
95434
- * Returns the instance of Microsoft Visio that is associated with an object.
95435
- *
95436
- * [Api set: 1.1]
95437
- */
95438
- application?: Visio.Interfaces.ApplicationLoadOptions;
95439
- /**
95440
- *
95441
- * Gets the document object that is assocaited with the shape.
95442
- *
95443
- * [Api set: 1.1]
95444
- */
95445
- document?: Visio.Interfaces.DocumentLoadOptions;
95446
96678
  /**
95447
96679
  *
95448
- * Shape's Identifier.
96680
+ * For EACH ITEM in the collection: Gets the address of the Hyperlink object. Read-only.
95449
96681
  *
95450
96682
  * [Api set: 1.1]
95451
96683
  */
95452
- id?: boolean;
96684
+ address?: boolean;
95453
96685
  /**
95454
96686
  *
95455
- * Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
96687
+ * For EACH ITEM in the collection: Gets the description of a hyperlink. Read-only.
95456
96688
  *
95457
96689
  * [Api set: 1.1]
95458
96690
  */
95459
- isBoundToData?: boolean;
96691
+ description?: boolean;
95460
96692
  /**
95461
96693
  *
95462
- * Indicates whether the shape is a callout shape. Read-only.
96694
+ * For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
95463
96695
  *
95464
96696
  * [Api set: 1.1]
95465
96697
  */
95466
- isCallout?: boolean;
96698
+ extraInfo?: boolean;
95467
96699
  /**
95468
96700
  *
95469
- * Specifes whether a shape is a data graphic callout. Read-only.
96701
+ * For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object. Read-only.
95470
96702
  *
95471
96703
  * [Api set: 1.1]
95472
96704
  */
95473
- isDataGraphicCallout?: boolean;
96705
+ subAddress?: boolean;
96706
+ }
96707
+ /**
96708
+ *
96709
+ * Represents the Hyperlink.
96710
+ *
96711
+ * [Api set: 1.1]
96712
+ */
96713
+ interface HyperlinkLoadOptions {
96714
+ /**
96715
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
96716
+ */
96717
+ $all?: boolean;
95474
96718
  /**
95475
96719
  *
95476
- * Indicates whether a shape is currently open for interactive text editing. Read-only.
96720
+ * Gets the address of the Hyperlink object. Read-only.
95477
96721
  *
95478
96722
  * [Api set: 1.1]
95479
96723
  */
95480
- isOpenForTextEdit?: boolean;
96724
+ address?: boolean;
95481
96725
  /**
95482
96726
  *
95483
- * Shape's name.
96727
+ * Gets the description of a hyperlink. Read-only.
95484
96728
  *
95485
96729
  * [Api set: 1.1]
95486
96730
  */
95487
- name?: boolean;
96731
+ description?: boolean;
95488
96732
  /**
95489
96733
  *
95490
- * Returns the type of the object. Read-only.(Shape_Type will give OACR Warning :61721)
96734
+ * Gets the extra URL request information used to resolve the hyperlink's URL. Read-only.
95491
96735
  *
95492
96736
  * [Api set: 1.1]
95493
96737
  */
95494
- objType?: boolean;
96738
+ extraInfo?: boolean;
95495
96739
  /**
95496
96740
  *
95497
- * Shape's Text.
96741
+ * Gets the sub-address of the Hyperlink object. Read-only.
95498
96742
  *
95499
96743
  * [Api set: 1.1]
95500
96744
  */
95501
- text?: boolean;
96745
+ subAddress?: boolean;
95502
96746
  }
95503
96747
  /**
95504
96748
  *
95505
- * Represents the Shape Collection.
96749
+ * Represents the CommentCollection for a given Shape.
95506
96750
  *
95507
96751
  * [Api set: 1.1]
95508
96752
  */
95509
- interface ShapeCollectionLoadOptions {
96753
+ interface CommentCollectionLoadOptions {
95510
96754
  /**
95511
96755
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95512
96756
  */
95513
96757
  $all?: boolean;
95514
- /**
95515
- *
95516
- * For EACH ITEM in the collection: Returns the instance of Microsoft Visio that is associated with an object.
95517
- *
95518
- * [Api set: 1.1]
95519
- */
95520
- application?: Visio.Interfaces.ApplicationLoadOptions;
95521
- /**
95522
- *
95523
- * For EACH ITEM in the collection: Gets the document object that is assocaited with the shape.
95524
- *
95525
- * [Api set: 1.1]
95526
- */
95527
- document?: Visio.Interfaces.DocumentLoadOptions;
95528
96758
  /**
95529
96759
  *
95530
- * For EACH ITEM in the collection: Shape's Identifier.
96760
+ * For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
95531
96761
  *
95532
96762
  * [Api set: 1.1]
95533
96763
  */
95534
- id?: boolean;
95535
- /**
95536
- *
95537
- * For EACH ITEM in the collection: Returns true if the shape is bound to data and is part of Data Visualizer diagram. Read-only.
95538
- *
95539
- * [Api set: 1.1]
95540
- */
95541
- isBoundToData?: boolean;
96764
+ author?: boolean;
95542
96765
  /**
95543
96766
  *
95544
- * For EACH ITEM in the collection: Indicates whether the shape is a callout shape. Read-only.
96767
+ * For EACH ITEM in the collection: A string that specifies the date when the comment was created.
95545
96768
  *
95546
96769
  * [Api set: 1.1]
95547
96770
  */
95548
- isCallout?: boolean;
96771
+ date?: boolean;
95549
96772
  /**
95550
96773
  *
95551
- * For EACH ITEM in the collection: Specifes whether a shape is a data graphic callout. Read-only.
96774
+ * For EACH ITEM in the collection: A string that contains the comment text.
95552
96775
  *
95553
96776
  * [Api set: 1.1]
95554
96777
  */
95555
- isDataGraphicCallout?: boolean;
96778
+ text?: boolean;
96779
+ }
96780
+ /**
96781
+ *
96782
+ * Represents the Comment.
96783
+ *
96784
+ * [Api set: 1.1]
96785
+ */
96786
+ interface CommentLoadOptions {
95556
96787
  /**
95557
- *
95558
- * For EACH ITEM in the collection: Indicates whether a shape is currently open for interactive text editing. Read-only.
95559
- *
95560
- * [Api set: 1.1]
96788
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
95561
96789
  */
95562
- isOpenForTextEdit?: boolean;
96790
+ $all?: boolean;
95563
96791
  /**
95564
96792
  *
95565
- * For EACH ITEM in the collection: Shape's name.
96793
+ * A string that specifies the name of the author of the comment.
95566
96794
  *
95567
96795
  * [Api set: 1.1]
95568
96796
  */
95569
- name?: boolean;
96797
+ author?: boolean;
95570
96798
  /**
95571
96799
  *
95572
- * For EACH ITEM in the collection: Returns the type of the object. Read-only.(Shape_Type will give OACR Warning :61721)
96800
+ * A string that specifies the date when the comment was created.
95573
96801
  *
95574
96802
  * [Api set: 1.1]
95575
96803
  */
95576
- objType?: boolean;
96804
+ date?: boolean;
95577
96805
  /**
95578
96806
  *
95579
- * For EACH ITEM in the collection: Shape's Text.
96807
+ * A string that contains the comment text.
95580
96808
  *
95581
96809
  * [Api set: 1.1]
95582
96810
  */