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