@types/office-js 1.0.375 → 1.0.377
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 +621 -735
- office-js/package.json +3 -3
office-js/index.d.ts
CHANGED
|
@@ -351,11 +351,11 @@ declare namespace Office {
|
|
|
351
351
|
*/
|
|
352
352
|
enum VisibilityMode {
|
|
353
353
|
/**
|
|
354
|
-
* UI is
|
|
354
|
+
* UI is hidden.
|
|
355
355
|
*/
|
|
356
356
|
hidden = 'Hidden',
|
|
357
357
|
/**
|
|
358
|
-
* Displayed as
|
|
358
|
+
* Displayed as a task pane.
|
|
359
359
|
*/
|
|
360
360
|
taskpane = 'Taskpane',
|
|
361
361
|
}
|
|
@@ -442,6 +442,9 @@ declare namespace Office {
|
|
|
442
442
|
PC,
|
|
443
443
|
/**
|
|
444
444
|
* The platform is Office on the web (in a browser).
|
|
445
|
+
*
|
|
446
|
+
* **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
447
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
|
|
445
448
|
*/
|
|
446
449
|
OfficeOnline,
|
|
447
450
|
/**
|
|
@@ -954,11 +957,16 @@ declare namespace Office {
|
|
|
954
957
|
* Provides the platform on which the add-in is running.
|
|
955
958
|
*
|
|
956
959
|
* @remarks
|
|
957
|
-
* **Important**:
|
|
960
|
+
* **Important**:
|
|
961
|
+
*
|
|
962
|
+
* - In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
|
|
958
963
|
* `Office.context.diagnostics` property to get the platform starting with requirement set 1.5. For all
|
|
959
964
|
* Mailbox requirement sets, you can use the
|
|
960
965
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
|
|
961
966
|
* property to get similar information.
|
|
967
|
+
*
|
|
968
|
+
* - In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
969
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
|
|
962
970
|
*/
|
|
963
971
|
platform: PlatformType;
|
|
964
972
|
/**
|
|
@@ -1668,6 +1676,10 @@ declare namespace Office {
|
|
|
1668
1676
|
host: Office.HostType;
|
|
1669
1677
|
/**
|
|
1670
1678
|
* Gets the platform on which the add-in is running.
|
|
1679
|
+
*
|
|
1680
|
+
* @remarks
|
|
1681
|
+
* **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
|
|
1682
|
+
* {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
|
|
1671
1683
|
*/
|
|
1672
1684
|
platform: Office.PlatformType;
|
|
1673
1685
|
/**
|
|
@@ -109723,234 +109735,228 @@ declare namespace OneNote {
|
|
|
109723
109735
|
|
|
109724
109736
|
declare namespace Visio {
|
|
109725
109737
|
/**
|
|
109726
|
-
*
|
|
109727
109738
|
* Provides information about the shape that raised the ShapeMouseEnter event.
|
|
109728
109739
|
*
|
|
109740
|
+
* @remarks
|
|
109729
109741
|
* [Api set: 1.1]
|
|
109730
109742
|
*/
|
|
109731
109743
|
interface ShapeMouseEnterEventArgs {
|
|
109732
109744
|
/**
|
|
109733
|
-
*
|
|
109734
109745
|
* Gets the name of the page which has the shape object that raised the ShapeMouseEnter event.
|
|
109735
109746
|
*
|
|
109747
|
+
* @remarks
|
|
109736
109748
|
* [Api set: 1.1]
|
|
109737
109749
|
*/
|
|
109738
109750
|
pageName: string;
|
|
109739
109751
|
/**
|
|
109740
|
-
*
|
|
109741
109752
|
* Gets the name of the shape object that raised the ShapeMouseEnter event.
|
|
109742
109753
|
*
|
|
109754
|
+
* @remarks
|
|
109743
109755
|
* [Api set: 1.1]
|
|
109744
109756
|
*/
|
|
109745
109757
|
shapeName: string;
|
|
109746
109758
|
}
|
|
109747
109759
|
/**
|
|
109748
|
-
*
|
|
109749
109760
|
* Provides information about the shape that raised the ShapeMouseLeave event.
|
|
109750
109761
|
*
|
|
109762
|
+
* @remarks
|
|
109751
109763
|
* [Api set: 1.1]
|
|
109752
109764
|
*/
|
|
109753
109765
|
interface ShapeMouseLeaveEventArgs {
|
|
109754
109766
|
/**
|
|
109755
|
-
*
|
|
109756
109767
|
* Gets the name of the page which has the shape object that raised the ShapeMouseLeave event.
|
|
109757
109768
|
*
|
|
109769
|
+
* @remarks
|
|
109758
109770
|
* [Api set: 1.1]
|
|
109759
109771
|
*/
|
|
109760
109772
|
pageName: string;
|
|
109761
109773
|
/**
|
|
109762
|
-
*
|
|
109763
109774
|
* Gets the name of the shape object that raised the ShapeMouseLeave event.
|
|
109764
109775
|
*
|
|
109776
|
+
* @remarks
|
|
109765
109777
|
* [Api set: 1.1]
|
|
109766
109778
|
*/
|
|
109767
109779
|
shapeName: string;
|
|
109768
109780
|
}
|
|
109769
109781
|
/**
|
|
109770
|
-
*
|
|
109771
109782
|
* Provides information about the page that raised the PageLoadComplete event.
|
|
109772
109783
|
*
|
|
109784
|
+
* @remarks
|
|
109773
109785
|
* [Api set: 1.1]
|
|
109774
109786
|
*/
|
|
109775
109787
|
interface PageLoadCompleteEventArgs {
|
|
109776
109788
|
/**
|
|
109777
|
-
*
|
|
109778
109789
|
* Gets the name of the page that raised the PageLoad event.
|
|
109779
109790
|
*
|
|
109791
|
+
* @remarks
|
|
109780
109792
|
* [Api set: 1.1]
|
|
109781
109793
|
*/
|
|
109782
109794
|
pageName: string;
|
|
109783
109795
|
/**
|
|
109784
|
-
*
|
|
109785
109796
|
* Gets the success or failure of the PageLoadComplete event.
|
|
109786
109797
|
*
|
|
109798
|
+
* @remarks
|
|
109787
109799
|
* [Api set: 1.1]
|
|
109788
109800
|
*/
|
|
109789
109801
|
success: boolean;
|
|
109790
109802
|
}
|
|
109791
109803
|
/**
|
|
109792
|
-
*
|
|
109793
109804
|
* Provides information about the document that raised the DataRefreshComplete event.
|
|
109794
109805
|
*
|
|
109806
|
+
* @remarks
|
|
109795
109807
|
* [Api set: 1.1]
|
|
109796
109808
|
*/
|
|
109797
109809
|
interface DataRefreshCompleteEventArgs {
|
|
109798
109810
|
/**
|
|
109799
|
-
*
|
|
109800
109811
|
* Gets the document object that raised the DataRefreshComplete event.
|
|
109801
109812
|
*
|
|
109813
|
+
* @remarks
|
|
109802
109814
|
* [Api set: 1.1]
|
|
109803
109815
|
*/
|
|
109804
109816
|
document: Visio.Document;
|
|
109805
109817
|
/**
|
|
109806
|
-
*
|
|
109807
109818
|
* Gets the success or failure of the DataRefreshComplete event.
|
|
109808
109819
|
*
|
|
109820
|
+
* @remarks
|
|
109809
109821
|
* [Api set: 1.1]
|
|
109810
109822
|
*/
|
|
109811
109823
|
success: boolean;
|
|
109812
109824
|
}
|
|
109813
109825
|
/**
|
|
109814
|
-
*
|
|
109815
109826
|
* Provides information about the shape collection that raised the SelectionChanged event.
|
|
109816
109827
|
*
|
|
109828
|
+
* @remarks
|
|
109817
109829
|
* [Api set: 1.1]
|
|
109818
109830
|
*/
|
|
109819
109831
|
interface SelectionChangedEventArgs {
|
|
109820
109832
|
/**
|
|
109821
|
-
*
|
|
109822
109833
|
* Gets the name of the page which has the ShapeCollection object that raised the SelectionChanged event.
|
|
109823
109834
|
*
|
|
109835
|
+
* @remarks
|
|
109824
109836
|
* [Api set: 1.1]
|
|
109825
109837
|
*/
|
|
109826
109838
|
pageName: string;
|
|
109827
109839
|
/**
|
|
109828
|
-
*
|
|
109829
109840
|
* Gets the array of shape names that raised the SelectionChanged event.
|
|
109830
109841
|
*
|
|
109842
|
+
* @remarks
|
|
109831
109843
|
* [Api set: 1.1]
|
|
109832
109844
|
*/
|
|
109833
109845
|
shapeNames: string[];
|
|
109834
109846
|
}
|
|
109835
109847
|
/**
|
|
109836
|
-
*
|
|
109837
109848
|
* Provides information about the success or failure of the DocumentLoadComplete event.
|
|
109838
109849
|
*
|
|
109850
|
+
* @remarks
|
|
109839
109851
|
* [Api set: 1.1]
|
|
109840
109852
|
*/
|
|
109841
109853
|
interface DocumentLoadCompleteEventArgs {
|
|
109842
109854
|
/**
|
|
109843
|
-
*
|
|
109844
109855
|
* Gets the success or failure of the DocumentLoadComplete event.
|
|
109845
109856
|
*
|
|
109857
|
+
* @remarks
|
|
109846
109858
|
* [Api set: 1.1]
|
|
109847
109859
|
*/
|
|
109848
109860
|
success: boolean;
|
|
109849
109861
|
}
|
|
109850
109862
|
/**
|
|
109851
|
-
*
|
|
109852
109863
|
* Provides information about the page that raised the PageRenderComplete event.
|
|
109853
109864
|
*
|
|
109865
|
+
* @remarks
|
|
109854
109866
|
* [Api set: 1.1]
|
|
109855
109867
|
*/
|
|
109856
109868
|
interface PageRenderCompleteEventArgs {
|
|
109857
109869
|
/**
|
|
109858
|
-
*
|
|
109859
109870
|
* Gets the name of the page that raised the PageLoad event.
|
|
109860
109871
|
*
|
|
109872
|
+
* @remarks
|
|
109861
109873
|
* [Api set: 1.1]
|
|
109862
109874
|
*/
|
|
109863
109875
|
pageName: string;
|
|
109864
109876
|
/**
|
|
109865
|
-
*
|
|
109866
109877
|
* Gets the success/failure of the PageRender event.
|
|
109867
109878
|
*
|
|
109879
|
+
* @remarks
|
|
109868
109880
|
* [Api set: 1.1]
|
|
109869
109881
|
*/
|
|
109870
109882
|
success: boolean;
|
|
109871
109883
|
}
|
|
109872
109884
|
/**
|
|
109885
|
+
* Provides information about DocumentError event.
|
|
109873
109886
|
*
|
|
109874
|
-
*
|
|
109875
|
-
*
|
|
109887
|
+
* @remarks
|
|
109876
109888
|
* [Api set: 1.1]
|
|
109877
109889
|
*/
|
|
109878
109890
|
interface DocumentErrorEventArgs {
|
|
109879
109891
|
/**
|
|
109892
|
+
* Visio Error code.
|
|
109880
109893
|
*
|
|
109881
|
-
*
|
|
109882
|
-
*
|
|
109894
|
+
* @remarks
|
|
109883
109895
|
* [Api set: 1.1]
|
|
109884
109896
|
*/
|
|
109885
109897
|
errorCode: number;
|
|
109886
109898
|
/**
|
|
109899
|
+
* Message about error that occurred.
|
|
109887
109900
|
*
|
|
109888
|
-
*
|
|
109889
|
-
*
|
|
109901
|
+
* @remarks
|
|
109890
109902
|
* [Api set: 1.1]
|
|
109891
109903
|
*/
|
|
109892
109904
|
errorMessage: string;
|
|
109893
109905
|
/**
|
|
109894
|
-
*
|
|
109895
109906
|
* Tells if the error is critical or not. If critical the session cannot continue.
|
|
109896
109907
|
*
|
|
109908
|
+
* @remarks
|
|
109897
109909
|
* [Api set: 1.1]
|
|
109898
109910
|
*/
|
|
109899
109911
|
isCritical: boolean;
|
|
109900
109912
|
}
|
|
109901
109913
|
/**
|
|
109902
|
-
*
|
|
109903
109914
|
* Provides information about the TaskPaneStateChanged event.
|
|
109904
109915
|
*
|
|
109916
|
+
* @remarks
|
|
109905
109917
|
* [Api set: 1.1]
|
|
109906
109918
|
*/
|
|
109907
109919
|
interface TaskPaneStateChangedEventArgs {
|
|
109908
109920
|
/**
|
|
109921
|
+
* Current state of the task pane.
|
|
109909
109922
|
*
|
|
109910
|
-
*
|
|
109911
|
-
*
|
|
109923
|
+
* @remarks
|
|
109912
109924
|
* [Api set: 1.1]
|
|
109913
109925
|
*/
|
|
109914
109926
|
isVisible: boolean;
|
|
109915
109927
|
/**
|
|
109916
|
-
*
|
|
109917
109928
|
* Type of the TaskPane.
|
|
109918
109929
|
*
|
|
109930
|
+
* @remarks
|
|
109919
109931
|
* [Api set: 1.1]
|
|
109920
109932
|
*/
|
|
109921
109933
|
paneType: Visio.TaskPaneType | "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings";
|
|
109922
109934
|
}
|
|
109923
109935
|
/**
|
|
109924
|
-
*
|
|
109925
109936
|
* Represents the Application.
|
|
109926
109937
|
*
|
|
109938
|
+
* @remarks
|
|
109927
109939
|
* [Api set: 1.1]
|
|
109928
109940
|
*/
|
|
109929
109941
|
class Application extends OfficeExtension.ClientObject {
|
|
109930
109942
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
109931
109943
|
context: RequestContext;
|
|
109932
109944
|
/**
|
|
109945
|
+
* Shows or hides the iframe application borders.
|
|
109933
109946
|
*
|
|
109934
|
-
*
|
|
109935
|
-
*
|
|
109947
|
+
* @remarks
|
|
109936
109948
|
* [Api set: 1.1]
|
|
109937
109949
|
*/
|
|
109938
109950
|
showBorders: boolean;
|
|
109939
109951
|
/**
|
|
109952
|
+
* Shows or hides the standard toolbars.
|
|
109940
109953
|
*
|
|
109941
|
-
*
|
|
109942
|
-
*
|
|
109954
|
+
* @remarks
|
|
109943
109955
|
* [Api set: 1.1]
|
|
109944
109956
|
*/
|
|
109945
109957
|
showToolbars: boolean;
|
|
109946
|
-
/**
|
|
109947
|
-
*
|
|
109948
|
-
* @remarks
|
|
109949
|
-
*
|
|
109950
|
-
* This method has the following additional signature:
|
|
109951
|
-
*
|
|
109952
|
-
* `set(properties: Visio.Application): void`
|
|
109953
|
-
*
|
|
109958
|
+
/**
|
|
109959
|
+
* 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.
|
|
109954
109960
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
109955
109961
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
109956
109962
|
*/
|
|
@@ -109958,23 +109964,23 @@ declare namespace Visio {
|
|
|
109958
109964
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
109959
109965
|
set(properties: Visio.Application): void;
|
|
109960
109966
|
/**
|
|
109961
|
-
*
|
|
109962
109967
|
* Sets the visibility of a specific toolbar in the application.
|
|
109963
109968
|
*
|
|
109969
|
+
* @remarks
|
|
109964
109970
|
* [Api set: 1.1]
|
|
109965
109971
|
*
|
|
109966
|
-
* @param id The type of the Toolbar
|
|
109967
|
-
* @param show Whether the toolbar is
|
|
109972
|
+
* @param id The type of the Toolbar.
|
|
109973
|
+
* @param show Whether the toolbar is visible or not.
|
|
109968
109974
|
*/
|
|
109969
109975
|
showToolbar(id: Visio.ToolBarType, show: boolean): void;
|
|
109970
109976
|
/**
|
|
109971
|
-
*
|
|
109972
109977
|
* Sets the visibility of a specific toolbar in the application.
|
|
109973
109978
|
*
|
|
109979
|
+
* @remarks
|
|
109974
109980
|
* [Api set: 1.1]
|
|
109975
109981
|
*
|
|
109976
|
-
* @param id The type of the Toolbar
|
|
109977
|
-
* @param show Whether the toolbar is
|
|
109982
|
+
* @param id The type of the Toolbar.
|
|
109983
|
+
* @param show Whether the toolbar is visible or not.
|
|
109978
109984
|
*/
|
|
109979
109985
|
showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;
|
|
109980
109986
|
/**
|
|
@@ -110009,43 +110015,37 @@ declare namespace Visio {
|
|
|
110009
110015
|
setMockData(data: Visio.Interfaces.ApplicationData): void;
|
|
110010
110016
|
}
|
|
110011
110017
|
/**
|
|
110012
|
-
*
|
|
110013
110018
|
* Represents the Document class.
|
|
110014
110019
|
*
|
|
110020
|
+
* @remarks
|
|
110015
110021
|
* [Api set: 1.1]
|
|
110016
110022
|
*/
|
|
110017
110023
|
class Document extends OfficeExtension.ClientObject {
|
|
110018
110024
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110019
110025
|
context: RequestContext;
|
|
110020
110026
|
/**
|
|
110027
|
+
* Represents a Visio application instance that contains this document.
|
|
110021
110028
|
*
|
|
110022
|
-
*
|
|
110023
|
-
*
|
|
110029
|
+
* @remarks
|
|
110024
110030
|
* [Api set: 1.1]
|
|
110025
110031
|
*/
|
|
110026
110032
|
readonly application: Visio.Application;
|
|
110027
110033
|
/**
|
|
110034
|
+
* Represents a collection of pages associated with the document.
|
|
110028
110035
|
*
|
|
110029
|
-
*
|
|
110030
|
-
*
|
|
110036
|
+
* @remarks
|
|
110031
110037
|
* [Api set: 1.1]
|
|
110032
110038
|
*/
|
|
110033
110039
|
readonly pages: Visio.PageCollection;
|
|
110034
110040
|
/**
|
|
110041
|
+
* Returns the DocumentView object.
|
|
110035
110042
|
*
|
|
110036
|
-
*
|
|
110037
|
-
*
|
|
110043
|
+
* @remarks
|
|
110038
110044
|
* [Api set: 1.1]
|
|
110039
110045
|
*/
|
|
110040
110046
|
readonly view: Visio.DocumentView;
|
|
110041
|
-
/**
|
|
110042
|
-
*
|
|
110043
|
-
* @remarks
|
|
110044
|
-
*
|
|
110045
|
-
* This method has the following additional signature:
|
|
110046
|
-
*
|
|
110047
|
-
* `set(properties: Visio.Document): void`
|
|
110048
|
-
*
|
|
110047
|
+
/**
|
|
110048
|
+
* 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.
|
|
110049
110049
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110050
110050
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110051
110051
|
*/
|
|
@@ -110053,49 +110053,49 @@ declare namespace Visio {
|
|
|
110053
110053
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110054
110054
|
set(properties: Visio.Document): void;
|
|
110055
110055
|
/**
|
|
110056
|
-
*
|
|
110057
110056
|
* Returns the Active Page of the document.
|
|
110058
110057
|
*
|
|
110058
|
+
* @remarks
|
|
110059
110059
|
* [Api set: 1.1]
|
|
110060
110060
|
*/
|
|
110061
110061
|
getActivePage(): Visio.Page;
|
|
110062
110062
|
/**
|
|
110063
|
-
*
|
|
110064
110063
|
* Set the Active Page of the document.
|
|
110065
110064
|
*
|
|
110065
|
+
* @remarks
|
|
110066
110066
|
* [Api set: 1.1]
|
|
110067
110067
|
*
|
|
110068
110068
|
* @param PageName Name of the page
|
|
110069
110069
|
*/
|
|
110070
110070
|
setActivePage(PageName: string): void;
|
|
110071
110071
|
/**
|
|
110072
|
+
* Shows or hides a TaskPane.
|
|
110073
|
+
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.
|
|
110072
110074
|
*
|
|
110073
|
-
*
|
|
110074
|
-
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.
|
|
110075
|
-
*
|
|
110075
|
+
* @remarks
|
|
110076
110076
|
* [Api set: 1.1]
|
|
110077
110077
|
*
|
|
110078
110078
|
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
110079
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the
|
|
110080
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified
|
|
110079
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
|
|
110080
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
|
|
110081
110081
|
*/
|
|
110082
110082
|
showTaskPane(taskPaneType: Visio.TaskPaneType, initialProps?: any, show?: boolean): void;
|
|
110083
110083
|
/**
|
|
110084
|
+
* Shows or hides a TaskPane.
|
|
110085
|
+
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.
|
|
110084
110086
|
*
|
|
110085
|
-
*
|
|
110086
|
-
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.
|
|
110087
|
-
*
|
|
110087
|
+
* @remarks
|
|
110088
110088
|
* [Api set: 1.1]
|
|
110089
110089
|
*
|
|
110090
110090
|
* @param taskPaneType Type of the 1st Party TaskPane. It can take values from enum TaskPaneType
|
|
110091
|
-
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the
|
|
110092
|
-
* @param show Optional Parameter. If it is set to false, it will hide the specified
|
|
110091
|
+
* @param initialProps Optional Parameter. This is a generic data structure which would be filled with initial data required to initialize the content of the task pane.
|
|
110092
|
+
* @param show Optional Parameter. If it is set to false, it will hide the specified task pane.
|
|
110093
110093
|
*/
|
|
110094
110094
|
showTaskPane(taskPaneType: "None" | "DataVisualizerProcessMappings" | "DataVisualizerOrgChartMappings", initialProps?: any, show?: boolean): void;
|
|
110095
110095
|
/**
|
|
110096
|
-
*
|
|
110097
110096
|
* Triggers the refresh of the data in the Diagram, for all pages.
|
|
110098
110097
|
*
|
|
110098
|
+
* @remarks
|
|
110099
110099
|
* [Api set: 1.1]
|
|
110100
110100
|
*/
|
|
110101
110101
|
startDataRefresh(): void;
|
|
@@ -110121,72 +110121,72 @@ declare namespace Visio {
|
|
|
110121
110121
|
expand?: string;
|
|
110122
110122
|
}): Visio.Document;
|
|
110123
110123
|
/**
|
|
110124
|
-
*
|
|
110125
110124
|
* Occurs when the data is refreshed in the diagram.
|
|
110126
110125
|
*
|
|
110126
|
+
* @remarks
|
|
110127
110127
|
* [Api set: 1.1]
|
|
110128
110128
|
*
|
|
110129
110129
|
* @eventproperty
|
|
110130
110130
|
*/
|
|
110131
110131
|
readonly onDataRefreshComplete: OfficeExtension.EventHandlers<Visio.DataRefreshCompleteEventArgs>;
|
|
110132
110132
|
/**
|
|
110133
|
+
* Occurs when there is an expected or unexpected error occurred in the session.
|
|
110133
110134
|
*
|
|
110134
|
-
*
|
|
110135
|
-
*
|
|
110135
|
+
* @remarks
|
|
110136
110136
|
* [Api set: 1.1]
|
|
110137
110137
|
*
|
|
110138
110138
|
* @eventproperty
|
|
110139
110139
|
*/
|
|
110140
110140
|
readonly onDocumentError: OfficeExtension.EventHandlers<Visio.DocumentErrorEventArgs>;
|
|
110141
110141
|
/**
|
|
110142
|
-
*
|
|
110143
110142
|
* Occurs when the Document is loaded, refreshed, or changed.
|
|
110144
110143
|
*
|
|
110144
|
+
* @remarks
|
|
110145
110145
|
* [Api set: 1.1]
|
|
110146
110146
|
*
|
|
110147
110147
|
* @eventproperty
|
|
110148
110148
|
*/
|
|
110149
110149
|
readonly onDocumentLoadComplete: OfficeExtension.EventHandlers<Visio.DocumentLoadCompleteEventArgs>;
|
|
110150
110150
|
/**
|
|
110151
|
-
*
|
|
110152
110151
|
* Occurs when the page is finished loading.
|
|
110153
110152
|
*
|
|
110153
|
+
* @remarks
|
|
110154
110154
|
* [Api set: 1.1]
|
|
110155
110155
|
*
|
|
110156
110156
|
* @eventproperty
|
|
110157
110157
|
*/
|
|
110158
110158
|
readonly onPageLoadComplete: OfficeExtension.EventHandlers<Visio.PageLoadCompleteEventArgs>;
|
|
110159
110159
|
/**
|
|
110160
|
-
*
|
|
110161
110160
|
* Occurs when the current selection of shapes changes.
|
|
110162
110161
|
*
|
|
110162
|
+
* @remarks
|
|
110163
110163
|
* [Api set: 1.1]
|
|
110164
110164
|
*
|
|
110165
110165
|
* @eventproperty
|
|
110166
110166
|
*/
|
|
110167
110167
|
readonly onSelectionChanged: OfficeExtension.EventHandlers<Visio.SelectionChangedEventArgs>;
|
|
110168
110168
|
/**
|
|
110169
|
-
*
|
|
110170
110169
|
* Occurs when the user moves the mouse pointer into the bounding box of a shape.
|
|
110171
110170
|
*
|
|
110171
|
+
* @remarks
|
|
110172
110172
|
* [Api set: 1.1]
|
|
110173
110173
|
*
|
|
110174
110174
|
* @eventproperty
|
|
110175
110175
|
*/
|
|
110176
110176
|
readonly onShapeMouseEnter: OfficeExtension.EventHandlers<Visio.ShapeMouseEnterEventArgs>;
|
|
110177
110177
|
/**
|
|
110178
|
-
*
|
|
110179
110178
|
* Occurs when the user moves the mouse out of the bounding box of a shape.
|
|
110180
110179
|
*
|
|
110180
|
+
* @remarks
|
|
110181
110181
|
* [Api set: 1.1]
|
|
110182
110182
|
*
|
|
110183
110183
|
* @eventproperty
|
|
110184
110184
|
*/
|
|
110185
110185
|
readonly onShapeMouseLeave: OfficeExtension.EventHandlers<Visio.ShapeMouseLeaveEventArgs>;
|
|
110186
110186
|
/**
|
|
110187
|
+
* Occurs whenever a task pane state is changed.
|
|
110187
110188
|
*
|
|
110188
|
-
*
|
|
110189
|
-
*
|
|
110189
|
+
* @remarks
|
|
110190
110190
|
* [Api set: 1.1]
|
|
110191
110191
|
*
|
|
110192
110192
|
* @eventproperty
|
|
@@ -110203,57 +110203,51 @@ declare namespace Visio {
|
|
|
110203
110203
|
setMockData(data: Visio.Interfaces.DocumentData): void;
|
|
110204
110204
|
}
|
|
110205
110205
|
/**
|
|
110206
|
-
*
|
|
110207
110206
|
* Represents the DocumentView class.
|
|
110208
110207
|
*
|
|
110208
|
+
* @remarks
|
|
110209
110209
|
* [Api set: 1.1]
|
|
110210
110210
|
*/
|
|
110211
110211
|
class DocumentView extends OfficeExtension.ClientObject {
|
|
110212
110212
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110213
110213
|
context: RequestContext;
|
|
110214
110214
|
/**
|
|
110215
|
-
*
|
|
110216
110215
|
* Disable Hyperlinks.
|
|
110217
110216
|
*
|
|
110217
|
+
* @remarks
|
|
110218
110218
|
* [Api set: 1.1]
|
|
110219
110219
|
*/
|
|
110220
110220
|
disableHyperlinks: boolean;
|
|
110221
110221
|
/**
|
|
110222
|
-
*
|
|
110223
110222
|
* Disable Pan.
|
|
110224
110223
|
*
|
|
110224
|
+
* @remarks
|
|
110225
110225
|
* [Api set: 1.1]
|
|
110226
110226
|
*/
|
|
110227
110227
|
disablePan: boolean;
|
|
110228
110228
|
/**
|
|
110229
|
-
*
|
|
110230
110229
|
* Disable PanZoomWindow.
|
|
110231
110230
|
*
|
|
110231
|
+
* @remarks
|
|
110232
110232
|
* [Api set: 1.1]
|
|
110233
110233
|
*/
|
|
110234
110234
|
disablePanZoomWindow: boolean;
|
|
110235
110235
|
/**
|
|
110236
|
-
*
|
|
110237
110236
|
* Disable Zoom.
|
|
110238
110237
|
*
|
|
110238
|
+
* @remarks
|
|
110239
110239
|
* [Api set: 1.1]
|
|
110240
110240
|
*/
|
|
110241
110241
|
disableZoom: boolean;
|
|
110242
110242
|
/**
|
|
110243
|
-
*
|
|
110244
110243
|
* Hide Diagram Boundary.
|
|
110245
110244
|
*
|
|
110245
|
+
* @remarks
|
|
110246
110246
|
* [Api set: 1.1]
|
|
110247
110247
|
*/
|
|
110248
110248
|
hideDiagramBoundary: boolean;
|
|
110249
|
-
/**
|
|
110250
|
-
*
|
|
110251
|
-
* @remarks
|
|
110252
|
-
*
|
|
110253
|
-
* This method has the following additional signature:
|
|
110254
|
-
*
|
|
110255
|
-
* `set(properties: Visio.DocumentView): void`
|
|
110256
|
-
*
|
|
110249
|
+
/**
|
|
110250
|
+
* 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.
|
|
110257
110251
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110258
110252
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110259
110253
|
*/
|
|
@@ -110292,85 +110286,79 @@ declare namespace Visio {
|
|
|
110292
110286
|
setMockData(data: Visio.Interfaces.DocumentViewData): void;
|
|
110293
110287
|
}
|
|
110294
110288
|
/**
|
|
110295
|
-
*
|
|
110296
110289
|
* Represents the Page class.
|
|
110297
110290
|
*
|
|
110291
|
+
* @remarks
|
|
110298
110292
|
* [Api set: 1.1]
|
|
110299
110293
|
*/
|
|
110300
110294
|
class Page extends OfficeExtension.ClientObject {
|
|
110301
110295
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110302
110296
|
context: RequestContext;
|
|
110303
110297
|
/**
|
|
110298
|
+
* All shapes in the Page, including subshapes.
|
|
110304
110299
|
*
|
|
110305
|
-
*
|
|
110306
|
-
*
|
|
110300
|
+
* @remarks
|
|
110307
110301
|
* [Api set: 1.1]
|
|
110308
110302
|
*/
|
|
110309
110303
|
readonly allShapes: Visio.ShapeCollection;
|
|
110310
110304
|
/**
|
|
110305
|
+
* Returns the Comments Collection.
|
|
110311
110306
|
*
|
|
110312
|
-
*
|
|
110313
|
-
*
|
|
110307
|
+
* @remarks
|
|
110314
110308
|
* [Api set: 1.1]
|
|
110315
110309
|
*/
|
|
110316
110310
|
readonly comments: Visio.CommentCollection;
|
|
110317
110311
|
/**
|
|
110312
|
+
* All top-level shapes in the Page.
|
|
110318
110313
|
*
|
|
110319
|
-
*
|
|
110320
|
-
*
|
|
110314
|
+
* @remarks
|
|
110321
110315
|
* [Api set: 1.1]
|
|
110322
110316
|
*/
|
|
110323
110317
|
readonly shapes: Visio.ShapeCollection;
|
|
110324
110318
|
/**
|
|
110319
|
+
* Returns the view of the page.
|
|
110325
110320
|
*
|
|
110326
|
-
*
|
|
110327
|
-
*
|
|
110321
|
+
* @remarks
|
|
110328
110322
|
* [Api set: 1.1]
|
|
110329
110323
|
*/
|
|
110330
110324
|
readonly view: Visio.PageView;
|
|
110331
110325
|
/**
|
|
110326
|
+
* Returns the height of the page.
|
|
110332
110327
|
*
|
|
110333
|
-
*
|
|
110334
|
-
*
|
|
110328
|
+
* @remarks
|
|
110335
110329
|
* [Api set: 1.1]
|
|
110336
110330
|
*/
|
|
110337
110331
|
readonly height: number;
|
|
110338
110332
|
/**
|
|
110333
|
+
* Index of the Page.
|
|
110339
110334
|
*
|
|
110340
|
-
*
|
|
110341
|
-
*
|
|
110335
|
+
* @remarks
|
|
110342
110336
|
* [Api set: 1.1]
|
|
110343
110337
|
*/
|
|
110344
110338
|
readonly index: number;
|
|
110345
110339
|
/**
|
|
110340
|
+
* Whether the page is a background page or not.
|
|
110346
110341
|
*
|
|
110347
|
-
*
|
|
110348
|
-
*
|
|
110342
|
+
* @remarks
|
|
110349
110343
|
* [Api set: 1.1]
|
|
110350
110344
|
*/
|
|
110351
110345
|
readonly isBackground: boolean;
|
|
110352
110346
|
/**
|
|
110347
|
+
* Page name.
|
|
110353
110348
|
*
|
|
110354
|
-
*
|
|
110355
|
-
*
|
|
110349
|
+
* @remarks
|
|
110356
110350
|
* [Api set: 1.1]
|
|
110357
110351
|
*/
|
|
110358
110352
|
readonly name: string;
|
|
110359
110353
|
/**
|
|
110354
|
+
* Returns the width of the page.
|
|
110360
110355
|
*
|
|
110361
|
-
*
|
|
110362
|
-
*
|
|
110356
|
+
* @remarks
|
|
110363
110357
|
* [Api set: 1.1]
|
|
110364
110358
|
*/
|
|
110365
110359
|
readonly width: number;
|
|
110366
|
-
/**
|
|
110367
|
-
*
|
|
110368
|
-
* @remarks
|
|
110369
|
-
*
|
|
110370
|
-
* This method has the following additional signature:
|
|
110371
|
-
*
|
|
110372
|
-
* `set(properties: Visio.Page): void`
|
|
110373
|
-
*
|
|
110360
|
+
/**
|
|
110361
|
+
* 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.
|
|
110374
110362
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110375
110363
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110376
110364
|
*/
|
|
@@ -110378,9 +110366,9 @@ declare namespace Visio {
|
|
|
110378
110366
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110379
110367
|
set(properties: Visio.Page): void;
|
|
110380
110368
|
/**
|
|
110369
|
+
* Sets the page as Active Page of the document.
|
|
110381
110370
|
*
|
|
110382
|
-
*
|
|
110383
|
-
*
|
|
110371
|
+
* @remarks
|
|
110384
110372
|
* [Api set: 1.1]
|
|
110385
110373
|
*/
|
|
110386
110374
|
activate(): void;
|
|
@@ -110416,29 +110404,23 @@ declare namespace Visio {
|
|
|
110416
110404
|
setMockData(data: Visio.Interfaces.PageData): void;
|
|
110417
110405
|
}
|
|
110418
110406
|
/**
|
|
110419
|
-
*
|
|
110420
110407
|
* Represents the PageView class.
|
|
110421
110408
|
*
|
|
110409
|
+
* @remarks
|
|
110422
110410
|
* [Api set: 1.1]
|
|
110423
110411
|
*/
|
|
110424
110412
|
class PageView extends OfficeExtension.ClientObject {
|
|
110425
110413
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110426
110414
|
context: RequestContext;
|
|
110427
110415
|
/**
|
|
110428
|
-
*
|
|
110429
110416
|
* Get and set Page's Zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
110430
110417
|
*
|
|
110418
|
+
* @remarks
|
|
110431
110419
|
* [Api set: 1.1]
|
|
110432
110420
|
*/
|
|
110433
110421
|
zoom: number;
|
|
110434
|
-
/**
|
|
110435
|
-
*
|
|
110436
|
-
* @remarks
|
|
110437
|
-
*
|
|
110438
|
-
* This method has the following additional signature:
|
|
110439
|
-
*
|
|
110440
|
-
* `set(properties: Visio.PageView): void`
|
|
110441
|
-
*
|
|
110422
|
+
/**
|
|
110423
|
+
* 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.
|
|
110442
110424
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110443
110425
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110444
110426
|
*/
|
|
@@ -110446,48 +110428,48 @@ declare namespace Visio {
|
|
|
110446
110428
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110447
110429
|
set(properties: Visio.PageView): void;
|
|
110448
110430
|
/**
|
|
110449
|
-
*
|
|
110450
110431
|
* Pans the Visio drawing to place the specified shape in the center of the view.
|
|
110451
110432
|
*
|
|
110433
|
+
* @remarks
|
|
110452
110434
|
* [Api set: 1.1]
|
|
110453
110435
|
*
|
|
110454
110436
|
* @param ShapeId ShapeId to be seen in the center.
|
|
110455
110437
|
*/
|
|
110456
110438
|
centerViewportOnShape(ShapeId: number): void;
|
|
110457
110439
|
/**
|
|
110458
|
-
*
|
|
110459
110440
|
* Fit Page to current window.
|
|
110460
110441
|
*
|
|
110442
|
+
* @remarks
|
|
110461
110443
|
* [Api set: 1.1]
|
|
110462
110444
|
*/
|
|
110463
110445
|
fitToWindow(): void;
|
|
110464
110446
|
/**
|
|
110465
|
-
*
|
|
110466
110447
|
* Returns the position object that specifies the position of the page in the view.
|
|
110467
110448
|
*
|
|
110449
|
+
* @remarks
|
|
110468
110450
|
* [Api set: 1.1]
|
|
110469
110451
|
*/
|
|
110470
110452
|
getPosition(): OfficeExtension.ClientResult<Visio.Position>;
|
|
110471
110453
|
/**
|
|
110472
|
-
*
|
|
110473
110454
|
* Represents the Selection in the page.
|
|
110474
110455
|
*
|
|
110456
|
+
* @remarks
|
|
110475
110457
|
* [Api set: 1.1]
|
|
110476
110458
|
*/
|
|
110477
110459
|
getSelection(): Visio.Selection;
|
|
110478
110460
|
/**
|
|
110479
|
-
*
|
|
110480
110461
|
* To check if the shape is in view of the page or not.
|
|
110481
110462
|
*
|
|
110463
|
+
* @remarks
|
|
110482
110464
|
* [Api set: 1.1]
|
|
110483
110465
|
*
|
|
110484
110466
|
* @param Shape Shape to be checked.
|
|
110485
110467
|
*/
|
|
110486
110468
|
isShapeInViewport(Shape: Visio.Shape): OfficeExtension.ClientResult<boolean>;
|
|
110487
110469
|
/**
|
|
110488
|
-
*
|
|
110489
110470
|
* Sets the position of the page in the view.
|
|
110490
110471
|
*
|
|
110472
|
+
* @remarks
|
|
110491
110473
|
* [Api set: 1.1]
|
|
110492
110474
|
*
|
|
110493
110475
|
* @param Position Position object that specifies the new position of the page in the view.
|
|
@@ -110525,9 +110507,9 @@ declare namespace Visio {
|
|
|
110525
110507
|
setMockData(data: Visio.Interfaces.PageViewData): void;
|
|
110526
110508
|
}
|
|
110527
110509
|
/**
|
|
110528
|
-
*
|
|
110529
110510
|
* Represents a collection of Page objects that are part of the document.
|
|
110530
110511
|
*
|
|
110512
|
+
* @remarks
|
|
110531
110513
|
* [Api set: 1.1]
|
|
110532
110514
|
*/
|
|
110533
110515
|
class PageCollection extends OfficeExtension.ClientObject {
|
|
@@ -110536,16 +110518,16 @@ declare namespace Visio {
|
|
|
110536
110518
|
/** Gets the loaded child items in this collection. */
|
|
110537
110519
|
readonly items: Visio.Page[];
|
|
110538
110520
|
/**
|
|
110539
|
-
*
|
|
110540
110521
|
* Gets the number of pages in the collection.
|
|
110541
110522
|
*
|
|
110523
|
+
* @remarks
|
|
110542
110524
|
* [Api set: 1.1]
|
|
110543
110525
|
*/
|
|
110544
110526
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
110545
110527
|
/**
|
|
110546
|
-
*
|
|
110547
110528
|
* Gets a page using its key (name or Id).
|
|
110548
110529
|
*
|
|
110530
|
+
* @remarks
|
|
110549
110531
|
* [Api set: 1.1]
|
|
110550
110532
|
*
|
|
110551
110533
|
* @param key Key is the name or Id of the page to be retrieved.
|
|
@@ -110580,9 +110562,9 @@ declare namespace Visio {
|
|
|
110580
110562
|
setMockData(data: Visio.Interfaces.PageCollectionData): void;
|
|
110581
110563
|
}
|
|
110582
110564
|
/**
|
|
110583
|
-
*
|
|
110584
110565
|
* Represents the Shape Collection.
|
|
110585
110566
|
*
|
|
110567
|
+
* @remarks
|
|
110586
110568
|
* [Api set: 1.1]
|
|
110587
110569
|
*/
|
|
110588
110570
|
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
@@ -110591,16 +110573,16 @@ declare namespace Visio {
|
|
|
110591
110573
|
/** Gets the loaded child items in this collection. */
|
|
110592
110574
|
readonly items: Visio.Shape[];
|
|
110593
110575
|
/**
|
|
110594
|
-
*
|
|
110595
110576
|
* Gets the number of Shapes in the collection.
|
|
110596
110577
|
*
|
|
110578
|
+
* @remarks
|
|
110597
110579
|
* [Api set: 1.1]
|
|
110598
110580
|
*/
|
|
110599
110581
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
110600
110582
|
/**
|
|
110601
|
-
*
|
|
110602
110583
|
* Gets a Shape using its key (name or Index).
|
|
110603
110584
|
*
|
|
110585
|
+
* @remarks
|
|
110604
110586
|
* [Api set: 1.1]
|
|
110605
110587
|
*
|
|
110606
110588
|
* @param key Key is the Name or Index of the shape to be retrieved.
|
|
@@ -110635,85 +110617,79 @@ declare namespace Visio {
|
|
|
110635
110617
|
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
|
|
110636
110618
|
}
|
|
110637
110619
|
/**
|
|
110638
|
-
*
|
|
110639
110620
|
* Represents the Shape class.
|
|
110640
110621
|
*
|
|
110622
|
+
* @remarks
|
|
110641
110623
|
* [Api set: 1.1]
|
|
110642
110624
|
*/
|
|
110643
110625
|
class Shape extends OfficeExtension.ClientObject {
|
|
110644
110626
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110645
110627
|
context: RequestContext;
|
|
110646
110628
|
/**
|
|
110629
|
+
* Returns the Comments Collection.
|
|
110647
110630
|
*
|
|
110648
|
-
*
|
|
110649
|
-
*
|
|
110631
|
+
* @remarks
|
|
110650
110632
|
* [Api set: 1.1]
|
|
110651
110633
|
*/
|
|
110652
110634
|
readonly comments: Visio.CommentCollection;
|
|
110653
110635
|
/**
|
|
110636
|
+
* Returns the Hyperlinks collection for a Shape object.
|
|
110654
110637
|
*
|
|
110655
|
-
*
|
|
110656
|
-
*
|
|
110638
|
+
* @remarks
|
|
110657
110639
|
* [Api set: 1.1]
|
|
110658
110640
|
*/
|
|
110659
110641
|
readonly hyperlinks: Visio.HyperlinkCollection;
|
|
110660
110642
|
/**
|
|
110643
|
+
* Returns the Shape's Data Section.
|
|
110661
110644
|
*
|
|
110662
|
-
*
|
|
110663
|
-
*
|
|
110645
|
+
* @remarks
|
|
110664
110646
|
* [Api set: 1.1]
|
|
110665
110647
|
*/
|
|
110666
110648
|
readonly shapeDataItems: Visio.ShapeDataItemCollection;
|
|
110667
110649
|
/**
|
|
110650
|
+
* Gets SubShape Collection.
|
|
110668
110651
|
*
|
|
110669
|
-
*
|
|
110670
|
-
*
|
|
110652
|
+
* @remarks
|
|
110671
110653
|
* [Api set: 1.1]
|
|
110672
110654
|
*/
|
|
110673
110655
|
readonly subShapes: Visio.ShapeCollection;
|
|
110674
110656
|
/**
|
|
110657
|
+
* Returns the view of the shape.
|
|
110675
110658
|
*
|
|
110676
|
-
*
|
|
110677
|
-
*
|
|
110659
|
+
* @remarks
|
|
110678
110660
|
* [Api set: 1.1]
|
|
110679
110661
|
*/
|
|
110680
110662
|
readonly view: Visio.ShapeView;
|
|
110681
110663
|
/**
|
|
110664
|
+
* Shape's identifier.
|
|
110682
110665
|
*
|
|
110683
|
-
*
|
|
110684
|
-
*
|
|
110666
|
+
* @remarks
|
|
110685
110667
|
* [Api set: 1.1]
|
|
110686
110668
|
*/
|
|
110687
110669
|
readonly id: number;
|
|
110688
110670
|
/**
|
|
110671
|
+
* Shape's name.
|
|
110689
110672
|
*
|
|
110690
|
-
*
|
|
110691
|
-
*
|
|
110673
|
+
* @remarks
|
|
110692
110674
|
* [Api set: 1.1]
|
|
110693
110675
|
*/
|
|
110694
110676
|
readonly name: string;
|
|
110695
110677
|
/**
|
|
110696
|
-
*
|
|
110697
110678
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
110698
110679
|
*
|
|
110680
|
+
* @remarks
|
|
110699
110681
|
* [Api set: 1.1]
|
|
110700
110682
|
*/
|
|
110701
110683
|
select: boolean;
|
|
110702
110684
|
/**
|
|
110685
|
+
* Shape's text.
|
|
110703
110686
|
*
|
|
110704
|
-
*
|
|
110705
|
-
*
|
|
110687
|
+
* @remarks
|
|
110706
110688
|
* [Api set: 1.1]
|
|
110707
110689
|
*/
|
|
110708
110690
|
readonly text: string;
|
|
110709
|
-
/**
|
|
110710
|
-
*
|
|
110711
|
-
* @remarks
|
|
110712
|
-
*
|
|
110713
|
-
* This method has the following additional signature:
|
|
110714
|
-
*
|
|
110715
|
-
* `set(properties: Visio.Shape): void`
|
|
110716
|
-
*
|
|
110691
|
+
/**
|
|
110692
|
+
* 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.
|
|
110717
110693
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110718
110694
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110719
110695
|
*/
|
|
@@ -110721,12 +110697,19 @@ declare namespace Visio {
|
|
|
110721
110697
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110722
110698
|
set(properties: Visio.Shape): void;
|
|
110723
110699
|
/**
|
|
110724
|
-
*
|
|
110725
110700
|
* Returns the BoundingBox object that specifies bounding box of the shape.
|
|
110726
110701
|
*
|
|
110702
|
+
* @remarks
|
|
110727
110703
|
* [Api set: 1.1]
|
|
110728
110704
|
*/
|
|
110729
110705
|
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
|
|
110706
|
+
/**
|
|
110707
|
+
* Returns the AbsoluteBoundingBox object that specifies absolute bounding box of the shape.
|
|
110708
|
+
*
|
|
110709
|
+
* @remarks
|
|
110710
|
+
* [Api set: 1.1]
|
|
110711
|
+
*/
|
|
110712
|
+
getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;
|
|
110730
110713
|
/**
|
|
110731
110714
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110732
110715
|
*
|
|
@@ -110759,29 +110742,23 @@ declare namespace Visio {
|
|
|
110759
110742
|
setMockData(data: Visio.Interfaces.ShapeData): void;
|
|
110760
110743
|
}
|
|
110761
110744
|
/**
|
|
110762
|
-
*
|
|
110763
110745
|
* Represents the ShapeView class.
|
|
110764
110746
|
*
|
|
110747
|
+
* @remarks
|
|
110765
110748
|
* [Api set: 1.1]
|
|
110766
110749
|
*/
|
|
110767
110750
|
class ShapeView extends OfficeExtension.ClientObject {
|
|
110768
110751
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110769
110752
|
context: RequestContext;
|
|
110770
110753
|
/**
|
|
110771
|
-
*
|
|
110772
110754
|
* Represents the highlight around the shape.
|
|
110773
110755
|
*
|
|
110756
|
+
* @remarks
|
|
110774
110757
|
* [Api set: 1.1]
|
|
110775
110758
|
*/
|
|
110776
110759
|
highlight: Visio.Highlight;
|
|
110777
|
-
/**
|
|
110778
|
-
*
|
|
110779
|
-
* @remarks
|
|
110780
|
-
*
|
|
110781
|
-
* This method has the following additional signature:
|
|
110782
|
-
*
|
|
110783
|
-
* `set(properties: Visio.ShapeView): void`
|
|
110784
|
-
*
|
|
110760
|
+
/**
|
|
110761
|
+
* 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.
|
|
110785
110762
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
110786
110763
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
110787
110764
|
*/
|
|
@@ -110789,9 +110766,9 @@ declare namespace Visio {
|
|
|
110789
110766
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
110790
110767
|
set(properties: Visio.ShapeView): void;
|
|
110791
110768
|
/**
|
|
110792
|
-
*
|
|
110793
110769
|
* Adds an overlay on top of the shape.
|
|
110794
110770
|
*
|
|
110771
|
+
* @remarks
|
|
110795
110772
|
* [Api set: 1.1]
|
|
110796
110773
|
*
|
|
110797
110774
|
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
@@ -110803,9 +110780,9 @@ declare namespace Visio {
|
|
|
110803
110780
|
*/
|
|
110804
110781
|
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
110805
110782
|
/**
|
|
110806
|
-
*
|
|
110807
110783
|
* Adds an overlay on top of the shape.
|
|
110808
110784
|
*
|
|
110785
|
+
* @remarks
|
|
110809
110786
|
* [Api set: 1.1]
|
|
110810
110787
|
*
|
|
110811
110788
|
* @param OverlayType An Overlay Type. Can be 'Text', 'Image' or 'Html'.
|
|
@@ -110817,22 +110794,31 @@ declare namespace Visio {
|
|
|
110817
110794
|
*/
|
|
110818
110795
|
addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;
|
|
110819
110796
|
/**
|
|
110820
|
-
*
|
|
110821
110797
|
* Removes particular overlay or all overlays on the Shape.
|
|
110822
110798
|
*
|
|
110799
|
+
* @remarks
|
|
110823
110800
|
* [Api set: 1.1]
|
|
110824
110801
|
*
|
|
110825
110802
|
* @param OverlayId An Overlay Id. Removes the specific overlay id from the shape.
|
|
110826
110803
|
*/
|
|
110827
110804
|
removeOverlay(OverlayId: number): void;
|
|
110828
110805
|
/**
|
|
110806
|
+
* The purpose of SetText API is to update the text inside a Visio Shape in run time. The updated text retains the existing formatting properties of the shape's text.
|
|
110807
|
+
*
|
|
110808
|
+
* @remarks
|
|
110809
|
+
* [Api set: 1.1]
|
|
110829
110810
|
*
|
|
110811
|
+
* @param Text Text parameter is the updated text to display on the shape.
|
|
110812
|
+
*/
|
|
110813
|
+
setText(Text: string): void;
|
|
110814
|
+
/**
|
|
110830
110815
|
* Shows particular overlay on the Shape.
|
|
110831
110816
|
*
|
|
110817
|
+
* @remarks
|
|
110832
110818
|
* [Api set: 1.1]
|
|
110833
110819
|
*
|
|
110834
|
-
* @param overlayId overlay
|
|
110835
|
-
* @param show to show
|
|
110820
|
+
* @param overlayId The overlay ID in context.
|
|
110821
|
+
* @param show Whether to show the overlay.
|
|
110836
110822
|
*/
|
|
110837
110823
|
showOverlay(overlayId: number, show: boolean): void;
|
|
110838
110824
|
/**
|
|
@@ -110867,89 +110853,89 @@ declare namespace Visio {
|
|
|
110867
110853
|
setMockData(data: Visio.Interfaces.ShapeViewData): void;
|
|
110868
110854
|
}
|
|
110869
110855
|
/**
|
|
110870
|
-
*
|
|
110871
110856
|
* Represents the Position of the object in the view.
|
|
110872
110857
|
*
|
|
110858
|
+
* @remarks
|
|
110873
110859
|
* [Api set: 1.1]
|
|
110874
110860
|
*/
|
|
110875
110861
|
interface Position {
|
|
110876
110862
|
/**
|
|
110877
|
-
*
|
|
110878
110863
|
* 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.
|
|
110879
110864
|
*
|
|
110865
|
+
* @remarks
|
|
110880
110866
|
* [Api set: 1.1]
|
|
110881
110867
|
*/
|
|
110882
110868
|
x: number;
|
|
110883
110869
|
/**
|
|
110884
|
-
*
|
|
110885
110870
|
* 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.
|
|
110886
110871
|
*
|
|
110872
|
+
* @remarks
|
|
110887
110873
|
* [Api set: 1.1]
|
|
110888
110874
|
*/
|
|
110889
110875
|
y: number;
|
|
110890
110876
|
}
|
|
110891
110877
|
/**
|
|
110892
|
-
*
|
|
110893
110878
|
* Represents the BoundingBox of the shape.
|
|
110894
110879
|
*
|
|
110880
|
+
* @remarks
|
|
110895
110881
|
* [Api set: 1.1]
|
|
110896
110882
|
*/
|
|
110897
110883
|
interface BoundingBox {
|
|
110898
110884
|
/**
|
|
110899
|
-
*
|
|
110900
110885
|
* The distance between the top and bottom edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
110901
110886
|
*
|
|
110887
|
+
* @remarks
|
|
110902
110888
|
* [Api set: 1.1]
|
|
110903
110889
|
*/
|
|
110904
110890
|
height: number;
|
|
110905
110891
|
/**
|
|
110906
|
-
*
|
|
110907
110892
|
* The distance between the left and right edges of the bounding box of the shape, excluding any data graphics associated with the shape.
|
|
110908
110893
|
*
|
|
110894
|
+
* @remarks
|
|
110909
110895
|
* [Api set: 1.1]
|
|
110910
110896
|
*/
|
|
110911
110897
|
width: number;
|
|
110912
110898
|
/**
|
|
110913
|
-
*
|
|
110914
110899
|
* An integer that specifies the x-coordinate of the bounding box.
|
|
110915
110900
|
*
|
|
110901
|
+
* @remarks
|
|
110916
110902
|
* [Api set: 1.1]
|
|
110917
110903
|
*/
|
|
110918
110904
|
x: number;
|
|
110919
110905
|
/**
|
|
110920
|
-
*
|
|
110921
110906
|
* An integer that specifies the y-coordinate of the bounding box.
|
|
110922
110907
|
*
|
|
110908
|
+
* @remarks
|
|
110923
110909
|
* [Api set: 1.1]
|
|
110924
110910
|
*/
|
|
110925
110911
|
y: number;
|
|
110926
110912
|
}
|
|
110927
110913
|
/**
|
|
110928
|
-
*
|
|
110929
110914
|
* Represents the highlight data added to the shape.
|
|
110930
110915
|
*
|
|
110916
|
+
* @remarks
|
|
110931
110917
|
* [Api set: 1.1]
|
|
110932
110918
|
*/
|
|
110933
110919
|
interface Highlight {
|
|
110934
110920
|
/**
|
|
110935
|
-
*
|
|
110936
110921
|
* 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).
|
|
110937
110922
|
*
|
|
110923
|
+
* @remarks
|
|
110938
110924
|
* [Api set: 1.1]
|
|
110939
110925
|
*/
|
|
110940
110926
|
color: string;
|
|
110941
110927
|
/**
|
|
110942
|
-
*
|
|
110943
110928
|
* A positive integer that specifies the width of the highlight's stroke in pixels.
|
|
110944
110929
|
*
|
|
110930
|
+
* @remarks
|
|
110945
110931
|
* [Api set: 1.1]
|
|
110946
110932
|
*/
|
|
110947
110933
|
width: number;
|
|
110948
110934
|
}
|
|
110949
110935
|
/**
|
|
110950
|
-
*
|
|
110951
110936
|
* Represents the ShapeDataItemCollection for a given Shape.
|
|
110952
110937
|
*
|
|
110938
|
+
* @remarks
|
|
110953
110939
|
* [Api set: 1.1]
|
|
110954
110940
|
*/
|
|
110955
110941
|
class ShapeDataItemCollection extends OfficeExtension.ClientObject {
|
|
@@ -110958,16 +110944,16 @@ declare namespace Visio {
|
|
|
110958
110944
|
/** Gets the loaded child items in this collection. */
|
|
110959
110945
|
readonly items: Visio.ShapeDataItem[];
|
|
110960
110946
|
/**
|
|
110961
|
-
*
|
|
110962
110947
|
* Gets the number of Shape Data Items.
|
|
110963
110948
|
*
|
|
110949
|
+
* @remarks
|
|
110964
110950
|
* [Api set: 1.1]
|
|
110965
110951
|
*/
|
|
110966
110952
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
110967
110953
|
/**
|
|
110968
|
-
*
|
|
110969
110954
|
* Gets the ShapeDataItem using its name.
|
|
110970
110955
|
*
|
|
110956
|
+
* @remarks
|
|
110971
110957
|
* [Api set: 1.1]
|
|
110972
110958
|
*
|
|
110973
110959
|
* @param key Key is the name of the ShapeDataItem to be retrieved.
|
|
@@ -111002,39 +110988,39 @@ declare namespace Visio {
|
|
|
111002
110988
|
setMockData(data: Visio.Interfaces.ShapeDataItemCollectionData): void;
|
|
111003
110989
|
}
|
|
111004
110990
|
/**
|
|
111005
|
-
*
|
|
111006
110991
|
* Represents the ShapeDataItem.
|
|
111007
110992
|
*
|
|
110993
|
+
* @remarks
|
|
111008
110994
|
* [Api set: 1.1]
|
|
111009
110995
|
*/
|
|
111010
110996
|
class ShapeDataItem extends OfficeExtension.ClientObject {
|
|
111011
110997
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111012
110998
|
context: RequestContext;
|
|
111013
110999
|
/**
|
|
111000
|
+
* A string that specifies the format of the shape data item.
|
|
111014
111001
|
*
|
|
111015
|
-
*
|
|
111016
|
-
*
|
|
111002
|
+
* @remarks
|
|
111017
111003
|
* [Api set: 1.1]
|
|
111018
111004
|
*/
|
|
111019
111005
|
readonly format: string;
|
|
111020
111006
|
/**
|
|
111007
|
+
* A string that specifies the formatted value of the shape data item.
|
|
111021
111008
|
*
|
|
111022
|
-
*
|
|
111023
|
-
*
|
|
111009
|
+
* @remarks
|
|
111024
111010
|
* [Api set: 1.1]
|
|
111025
111011
|
*/
|
|
111026
111012
|
readonly formattedValue: string;
|
|
111027
111013
|
/**
|
|
111014
|
+
* A string that specifies the label of the shape data item.
|
|
111028
111015
|
*
|
|
111029
|
-
*
|
|
111030
|
-
*
|
|
111016
|
+
* @remarks
|
|
111031
111017
|
* [Api set: 1.1]
|
|
111032
111018
|
*/
|
|
111033
111019
|
readonly label: string;
|
|
111034
111020
|
/**
|
|
111021
|
+
* A string that specifies the value of the shape data item.
|
|
111035
111022
|
*
|
|
111036
|
-
*
|
|
111037
|
-
*
|
|
111023
|
+
* @remarks
|
|
111038
111024
|
* [Api set: 1.1]
|
|
111039
111025
|
*/
|
|
111040
111026
|
readonly value: string;
|
|
@@ -111070,9 +111056,9 @@ declare namespace Visio {
|
|
|
111070
111056
|
setMockData(data: Visio.Interfaces.ShapeDataItemData): void;
|
|
111071
111057
|
}
|
|
111072
111058
|
/**
|
|
111073
|
-
*
|
|
111074
111059
|
* Represents the Hyperlink Collection.
|
|
111075
111060
|
*
|
|
111061
|
+
* @remarks
|
|
111076
111062
|
* [Api set: 1.1]
|
|
111077
111063
|
*/
|
|
111078
111064
|
class HyperlinkCollection extends OfficeExtension.ClientObject {
|
|
@@ -111081,16 +111067,16 @@ declare namespace Visio {
|
|
|
111081
111067
|
/** Gets the loaded child items in this collection. */
|
|
111082
111068
|
readonly items: Visio.Hyperlink[];
|
|
111083
111069
|
/**
|
|
111084
|
-
*
|
|
111085
111070
|
* Gets the number of hyperlinks.
|
|
111086
111071
|
*
|
|
111072
|
+
* @remarks
|
|
111087
111073
|
* [Api set: 1.1]
|
|
111088
111074
|
*/
|
|
111089
111075
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
111090
111076
|
/**
|
|
111091
|
-
*
|
|
111092
111077
|
* Gets a Hyperlink using its key (name or Id).
|
|
111093
111078
|
*
|
|
111079
|
+
* @remarks
|
|
111094
111080
|
* [Api set: 1.1]
|
|
111095
111081
|
*
|
|
111096
111082
|
* @param Key Key is the name or index of the Hyperlink to be retrieved.
|
|
@@ -111125,39 +111111,39 @@ declare namespace Visio {
|
|
|
111125
111111
|
setMockData(data: Visio.Interfaces.HyperlinkCollectionData): void;
|
|
111126
111112
|
}
|
|
111127
111113
|
/**
|
|
111128
|
-
*
|
|
111129
111114
|
* Represents the Hyperlink.
|
|
111130
111115
|
*
|
|
111116
|
+
* @remarks
|
|
111131
111117
|
* [Api set: 1.1]
|
|
111132
111118
|
*/
|
|
111133
111119
|
class Hyperlink extends OfficeExtension.ClientObject {
|
|
111134
111120
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111135
111121
|
context: RequestContext;
|
|
111136
111122
|
/**
|
|
111123
|
+
* Gets the address of the Hyperlink object.
|
|
111137
111124
|
*
|
|
111138
|
-
*
|
|
111139
|
-
*
|
|
111125
|
+
* @remarks
|
|
111140
111126
|
* [Api set: 1.1]
|
|
111141
111127
|
*/
|
|
111142
111128
|
readonly address: string;
|
|
111143
111129
|
/**
|
|
111130
|
+
* Gets the description of a hyperlink.
|
|
111144
111131
|
*
|
|
111145
|
-
*
|
|
111146
|
-
*
|
|
111132
|
+
* @remarks
|
|
111147
111133
|
* [Api set: 1.1]
|
|
111148
111134
|
*/
|
|
111149
111135
|
readonly description: string;
|
|
111150
111136
|
/**
|
|
111137
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
111151
111138
|
*
|
|
111152
|
-
*
|
|
111153
|
-
*
|
|
111139
|
+
* @remarks
|
|
111154
111140
|
* [Api set: 1.1]
|
|
111155
111141
|
*/
|
|
111156
111142
|
readonly extraInfo: string;
|
|
111157
111143
|
/**
|
|
111144
|
+
* Gets the sub-address of the Hyperlink object.
|
|
111158
111145
|
*
|
|
111159
|
-
*
|
|
111160
|
-
*
|
|
111146
|
+
* @remarks
|
|
111161
111147
|
* [Api set: 1.1]
|
|
111162
111148
|
*/
|
|
111163
111149
|
readonly subAddress: string;
|
|
@@ -111193,9 +111179,9 @@ declare namespace Visio {
|
|
|
111193
111179
|
setMockData(data: Visio.Interfaces.HyperlinkData): void;
|
|
111194
111180
|
}
|
|
111195
111181
|
/**
|
|
111196
|
-
*
|
|
111197
111182
|
* Represents the CommentCollection for a given Shape.
|
|
111198
111183
|
*
|
|
111184
|
+
* @remarks
|
|
111199
111185
|
* [Api set: 1.1]
|
|
111200
111186
|
*/
|
|
111201
111187
|
class CommentCollection extends OfficeExtension.ClientObject {
|
|
@@ -111204,16 +111190,16 @@ declare namespace Visio {
|
|
|
111204
111190
|
/** Gets the loaded child items in this collection. */
|
|
111205
111191
|
readonly items: Visio.Comment[];
|
|
111206
111192
|
/**
|
|
111207
|
-
*
|
|
111208
111193
|
* Gets the number of Comments.
|
|
111209
111194
|
*
|
|
111195
|
+
* @remarks
|
|
111210
111196
|
* [Api set: 1.1]
|
|
111211
111197
|
*/
|
|
111212
111198
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
111213
111199
|
/**
|
|
111214
|
-
*
|
|
111215
111200
|
* Gets the Comment using its name.
|
|
111216
111201
|
*
|
|
111202
|
+
* @remarks
|
|
111217
111203
|
* [Api set: 1.1]
|
|
111218
111204
|
*
|
|
111219
111205
|
* @param key Key is the name of the Comment to be retrieved.
|
|
@@ -111248,43 +111234,37 @@ declare namespace Visio {
|
|
|
111248
111234
|
setMockData(data: Visio.Interfaces.CommentCollectionData): void;
|
|
111249
111235
|
}
|
|
111250
111236
|
/**
|
|
111251
|
-
*
|
|
111252
111237
|
* Represents the Comment.
|
|
111253
111238
|
*
|
|
111239
|
+
* @remarks
|
|
111254
111240
|
* [Api set: 1.1]
|
|
111255
111241
|
*/
|
|
111256
111242
|
class Comment extends OfficeExtension.ClientObject {
|
|
111257
111243
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111258
111244
|
context: RequestContext;
|
|
111259
111245
|
/**
|
|
111260
|
-
*
|
|
111261
111246
|
* A string that specifies the name of the author of the comment.
|
|
111262
111247
|
*
|
|
111248
|
+
* @remarks
|
|
111263
111249
|
* [Api set: 1.1]
|
|
111264
111250
|
*/
|
|
111265
111251
|
author: string;
|
|
111266
111252
|
/**
|
|
111267
|
-
*
|
|
111268
111253
|
* A string that specifies the date when the comment was created.
|
|
111269
111254
|
*
|
|
111255
|
+
* @remarks
|
|
111270
111256
|
* [Api set: 1.1]
|
|
111271
111257
|
*/
|
|
111272
111258
|
date: string;
|
|
111273
111259
|
/**
|
|
111274
|
-
*
|
|
111275
111260
|
* A string that contains the comment text.
|
|
111276
111261
|
*
|
|
111262
|
+
* @remarks
|
|
111277
111263
|
* [Api set: 1.1]
|
|
111278
111264
|
*/
|
|
111279
111265
|
text: string;
|
|
111280
|
-
/**
|
|
111281
|
-
*
|
|
111282
|
-
* @remarks
|
|
111283
|
-
*
|
|
111284
|
-
* This method has the following additional signature:
|
|
111285
|
-
*
|
|
111286
|
-
* `set(properties: Visio.Comment): void`
|
|
111287
|
-
*
|
|
111266
|
+
/**
|
|
111267
|
+
* 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.
|
|
111288
111268
|
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
111289
111269
|
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
111290
111270
|
*/
|
|
@@ -111323,18 +111303,18 @@ declare namespace Visio {
|
|
|
111323
111303
|
setMockData(data: Visio.Interfaces.CommentData): void;
|
|
111324
111304
|
}
|
|
111325
111305
|
/**
|
|
111326
|
-
*
|
|
111327
111306
|
* Represents the Selection in the page.
|
|
111328
111307
|
*
|
|
111308
|
+
* @remarks
|
|
111329
111309
|
* [Api set: 1.1]
|
|
111330
111310
|
*/
|
|
111331
111311
|
class Selection extends OfficeExtension.ClientObject {
|
|
111332
111312
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
111333
111313
|
context: RequestContext;
|
|
111334
111314
|
/**
|
|
111315
|
+
* Gets the Shapes of the Selection.
|
|
111335
111316
|
*
|
|
111336
|
-
*
|
|
111337
|
-
*
|
|
111317
|
+
* @remarks
|
|
111338
111318
|
* [Api set: 1.1]
|
|
111339
111319
|
*/
|
|
111340
111320
|
readonly shapes: Visio.ShapeCollection;
|
|
@@ -111360,575 +111340,502 @@ declare namespace Visio {
|
|
|
111360
111340
|
toJSON(): Visio.Interfaces.SelectionData;
|
|
111361
111341
|
}
|
|
111362
111342
|
/**
|
|
111363
|
-
*
|
|
111364
|
-
* Shape binding informations required for data visualizer diagram
|
|
111365
|
-
*
|
|
111366
|
-
* [Api set: 1.1]
|
|
111367
|
-
*/
|
|
111368
|
-
interface ShapeBinding {
|
|
111369
|
-
/**
|
|
111370
|
-
*
|
|
111371
|
-
* Column for alternative text for shape.
|
|
111372
|
-
*
|
|
111373
|
-
* [Api set: 1.1]
|
|
111374
|
-
*/
|
|
111375
|
-
alternativeTextColumnName: string;
|
|
111376
|
-
/**
|
|
111377
|
-
*
|
|
111378
|
-
* Column for Shape label.
|
|
111379
|
-
*
|
|
111380
|
-
* [Api set: 1.1]
|
|
111381
|
-
*/
|
|
111382
|
-
labelColumnName: string;
|
|
111383
|
-
/**
|
|
111384
|
-
*
|
|
111385
|
-
* Unique Id column.
|
|
111386
|
-
*
|
|
111387
|
-
* [Api set: 1.1]
|
|
111388
|
-
*/
|
|
111389
|
-
uniqueIDColumnName: string;
|
|
111390
|
-
}
|
|
111391
|
-
/**
|
|
111392
|
-
*
|
|
111393
|
-
* Connector bindings for data visualizer diagram.
|
|
111394
|
-
*
|
|
111395
|
-
* [Api set: 1.1]
|
|
111396
|
-
*/
|
|
111397
|
-
interface ConnectorBinding {
|
|
111398
|
-
/**
|
|
111399
|
-
*
|
|
111400
|
-
* If true then connectors are added in sequence according to the uniqueId column.
|
|
111401
|
-
*
|
|
111402
|
-
* [Api set: 1.1]
|
|
111403
|
-
*/
|
|
111404
|
-
connectSequentially: boolean;
|
|
111405
|
-
/**
|
|
111406
|
-
*
|
|
111407
|
-
* Delimiter for TargetColumn. It should not have more then one character.
|
|
111408
|
-
*
|
|
111409
|
-
* [Api set: 1.1]
|
|
111410
|
-
*/
|
|
111411
|
-
delimiter: string;
|
|
111412
|
-
/**
|
|
111413
|
-
*
|
|
111414
|
-
* Direction of connector to use in diagram.
|
|
111415
|
-
*
|
|
111416
|
-
* [Api set: 1.1]
|
|
111417
|
-
*/
|
|
111418
|
-
direction: Visio.ConnectorDirection | "FromTarget" | "ToTarget";
|
|
111419
|
-
/**
|
|
111420
|
-
*
|
|
111421
|
-
* Column for ConnectorLabel (shape text of connector).
|
|
111422
|
-
*
|
|
111423
|
-
* [Api set: 1.1]
|
|
111424
|
-
*/
|
|
111425
|
-
labelColumnName: string;
|
|
111426
|
-
/**
|
|
111427
|
-
*
|
|
111428
|
-
* Column for proving connected target shape.
|
|
111429
|
-
*
|
|
111430
|
-
* [Api set: 1.1]
|
|
111431
|
-
*/
|
|
111432
|
-
targetColumnName: string;
|
|
111433
|
-
}
|
|
111434
|
-
/**
|
|
111435
|
-
*
|
|
111436
111343
|
* Represents the Horizontal Alignment of the Overlay relative to the shape.
|
|
111437
111344
|
*
|
|
111345
|
+
* @remarks
|
|
111438
111346
|
* [Api set: 1.1]
|
|
111439
111347
|
*/
|
|
111440
111348
|
enum OverlayHorizontalAlignment {
|
|
111441
111349
|
/**
|
|
111442
|
-
*
|
|
111443
|
-
*
|
|
111444
|
-
*
|
|
111350
|
+
* @remarks
|
|
111351
|
+
* [Api set: 1.1]
|
|
111445
111352
|
*/
|
|
111446
111353
|
left = "Left",
|
|
111447
111354
|
/**
|
|
111448
|
-
*
|
|
111449
|
-
*
|
|
111450
|
-
*
|
|
111355
|
+
* @remarks
|
|
111356
|
+
* [Api set: 1.1]
|
|
111451
111357
|
*/
|
|
111452
111358
|
center = "Center",
|
|
111453
111359
|
/**
|
|
111454
|
-
*
|
|
111455
|
-
*
|
|
111456
|
-
*
|
|
111360
|
+
* @remarks
|
|
111361
|
+
* [Api set: 1.1]
|
|
111457
111362
|
*/
|
|
111458
111363
|
right = "Right",
|
|
111459
111364
|
}
|
|
111460
111365
|
/**
|
|
111461
|
-
*
|
|
111462
111366
|
* Represents the Vertical Alignment of the Overlay relative to the shape.
|
|
111463
111367
|
*
|
|
111368
|
+
* @remarks
|
|
111464
111369
|
* [Api set: 1.1]
|
|
111465
111370
|
*/
|
|
111466
111371
|
enum OverlayVerticalAlignment {
|
|
111467
111372
|
/**
|
|
111468
|
-
*
|
|
111469
|
-
*
|
|
111470
|
-
*
|
|
111373
|
+
* @remarks
|
|
111374
|
+
* [Api set: 1.1]
|
|
111471
111375
|
*/
|
|
111472
111376
|
top = "Top",
|
|
111473
111377
|
/**
|
|
111474
|
-
*
|
|
111475
|
-
*
|
|
111476
|
-
*
|
|
111378
|
+
* @remarks
|
|
111379
|
+
* [Api set: 1.1]
|
|
111477
111380
|
*/
|
|
111478
111381
|
middle = "Middle",
|
|
111479
111382
|
/**
|
|
111480
|
-
*
|
|
111481
|
-
*
|
|
111482
|
-
*
|
|
111383
|
+
* @remarks
|
|
111384
|
+
* [Api set: 1.1]
|
|
111483
111385
|
*/
|
|
111484
111386
|
bottom = "Bottom",
|
|
111485
111387
|
}
|
|
111486
111388
|
/**
|
|
111487
|
-
*
|
|
111488
111389
|
* Represents the type of the overlay.
|
|
111489
111390
|
*
|
|
111391
|
+
* @remarks
|
|
111490
111392
|
* [Api set: 1.1]
|
|
111491
111393
|
*/
|
|
111492
111394
|
enum OverlayType {
|
|
111493
111395
|
/**
|
|
111494
|
-
*
|
|
111495
|
-
*
|
|
111496
|
-
*
|
|
111396
|
+
* @remarks
|
|
111397
|
+
* [Api set: 1.1]
|
|
111497
111398
|
*/
|
|
111498
111399
|
text = "Text",
|
|
111499
111400
|
/**
|
|
111500
|
-
*
|
|
111501
|
-
*
|
|
111502
|
-
*
|
|
111401
|
+
* @remarks
|
|
111402
|
+
* [Api set: 1.1]
|
|
111503
111403
|
*/
|
|
111504
111404
|
image = "Image",
|
|
111505
111405
|
/**
|
|
111506
|
-
*
|
|
111507
|
-
*
|
|
111508
|
-
*
|
|
111406
|
+
* @remarks
|
|
111407
|
+
* [Api set: 1.1]
|
|
111509
111408
|
*/
|
|
111510
111409
|
html = "Html",
|
|
111511
111410
|
}
|
|
111512
111411
|
/**
|
|
111412
|
+
* Toolbar IDs of the app.
|
|
111513
111413
|
*
|
|
111514
|
-
*
|
|
111515
|
-
*
|
|
111414
|
+
* @remarks
|
|
111516
111415
|
* [Api set: 1.1]
|
|
111517
111416
|
*/
|
|
111518
111417
|
enum ToolBarType {
|
|
111519
111418
|
/**
|
|
111520
|
-
*
|
|
111521
|
-
*
|
|
111522
|
-
*
|
|
111419
|
+
* The command toolbar type.
|
|
111420
|
+
* @remarks
|
|
111421
|
+
* [Api set: 1.1]
|
|
111523
111422
|
*/
|
|
111524
111423
|
commandBar = "CommandBar",
|
|
111525
111424
|
/**
|
|
111526
|
-
*
|
|
111527
|
-
*
|
|
111528
|
-
*
|
|
111425
|
+
* The page navigation toolbar type.
|
|
111426
|
+
* @remarks
|
|
111427
|
+
* [Api set: 1.1]
|
|
111529
111428
|
*/
|
|
111530
111429
|
pageNavigationBar = "PageNavigationBar",
|
|
111531
111430
|
/**
|
|
111532
|
-
*
|
|
111533
|
-
*
|
|
111534
|
-
*
|
|
111431
|
+
* The status toolbar type.
|
|
111432
|
+
* @remarks
|
|
111433
|
+
* [Api set: 1.1]
|
|
111535
111434
|
*/
|
|
111536
111435
|
statusBar = "StatusBar",
|
|
111537
111436
|
}
|
|
111538
111437
|
/**
|
|
111539
|
-
*
|
|
111540
111438
|
* Result of Data Visualizer Diagram operations.
|
|
111541
111439
|
*
|
|
111440
|
+
* @remarks
|
|
111542
111441
|
* [Api set: 1.1]
|
|
111543
111442
|
*/
|
|
111544
111443
|
enum DataVisualizerDiagramResultType {
|
|
111545
111444
|
/**
|
|
111546
|
-
*
|
|
111547
|
-
*
|
|
111548
|
-
*
|
|
111445
|
+
* Operation is successful.
|
|
111446
|
+
* @remarks
|
|
111447
|
+
* [Api set: 1.1]
|
|
111549
111448
|
*/
|
|
111550
111449
|
success = "Success",
|
|
111551
111450
|
/**
|
|
111552
|
-
*
|
|
111553
111451
|
* Unexpected error during operation.
|
|
111554
|
-
*
|
|
111452
|
+
* @remarks
|
|
111453
|
+
* [Api set: 1.1]
|
|
111555
111454
|
*/
|
|
111556
111455
|
unexpected = "Unexpected",
|
|
111557
111456
|
/**
|
|
111558
|
-
*
|
|
111559
111457
|
* Validation error in operation.
|
|
111560
|
-
*
|
|
111458
|
+
* @remarks
|
|
111459
|
+
* [Api set: 1.1]
|
|
111561
111460
|
*/
|
|
111562
111461
|
validationError = "ValidationError",
|
|
111563
111462
|
/**
|
|
111564
|
-
*
|
|
111565
111463
|
* Conflict error in operation.
|
|
111566
|
-
*
|
|
111464
|
+
* @remarks
|
|
111465
|
+
* [Api set: 1.1]
|
|
111567
111466
|
*/
|
|
111568
111467
|
conflictError = "ConflictError",
|
|
111569
111468
|
}
|
|
111570
111469
|
/**
|
|
111571
|
-
*
|
|
111572
111470
|
* Type of the Data Visualizer Diagram operation
|
|
111573
111471
|
*
|
|
111472
|
+
* @remarks
|
|
111574
111473
|
* [Api set: 1.1]
|
|
111575
111474
|
*/
|
|
111576
111475
|
enum DataVisualizerDiagramOperationType {
|
|
111577
111476
|
/**
|
|
111578
|
-
*
|
|
111579
|
-
*
|
|
111580
|
-
*
|
|
111477
|
+
* Unknown operation type.
|
|
111478
|
+
* @remarks
|
|
111479
|
+
* [Api set: 1.1]
|
|
111581
111480
|
*/
|
|
111582
111481
|
unknown = "Unknown",
|
|
111583
111482
|
/**
|
|
111584
|
-
*
|
|
111585
111483
|
* Creation operation.
|
|
111586
|
-
*
|
|
111484
|
+
* @remarks
|
|
111485
|
+
* [Api set: 1.1]
|
|
111587
111486
|
*/
|
|
111588
111487
|
create = "Create",
|
|
111589
111488
|
/**
|
|
111590
|
-
*
|
|
111591
111489
|
* Update Mappings operation.
|
|
111592
|
-
*
|
|
111490
|
+
* @remarks
|
|
111491
|
+
* [Api set: 1.1]
|
|
111593
111492
|
*/
|
|
111594
111493
|
updateMappings = "UpdateMappings",
|
|
111595
111494
|
/**
|
|
111596
|
-
*
|
|
111597
111495
|
* Update data associated with diagram.
|
|
111598
|
-
*
|
|
111496
|
+
* @remarks
|
|
111497
|
+
* [Api set: 1.1]
|
|
111599
111498
|
*/
|
|
111600
111499
|
updateData = "UpdateData",
|
|
111601
111500
|
/**
|
|
111602
|
-
*
|
|
111603
111501
|
* Update both data and mappings.
|
|
111604
|
-
*
|
|
111502
|
+
* @remarks
|
|
111503
|
+
* [Api set: 1.1]
|
|
111605
111504
|
*/
|
|
111606
111505
|
update = "Update",
|
|
111607
111506
|
/**
|
|
111608
|
-
*
|
|
111609
111507
|
* Delete the diagram content.
|
|
111610
|
-
*
|
|
111508
|
+
* @remarks
|
|
111509
|
+
* [Api set: 1.1]
|
|
111611
111510
|
*/
|
|
111612
111511
|
delete = "Delete",
|
|
111613
111512
|
}
|
|
111614
111513
|
/**
|
|
111514
|
+
* DiagramType for Data Visualizer diagrams.
|
|
111615
111515
|
*
|
|
111616
|
-
*
|
|
111617
|
-
*
|
|
111516
|
+
* @remarks
|
|
111618
111517
|
* [Api set: 1.1]
|
|
111619
111518
|
*/
|
|
111620
111519
|
enum DataVisualizerDiagramType {
|
|
111621
111520
|
/**
|
|
111622
|
-
*
|
|
111623
|
-
*
|
|
111624
|
-
*
|
|
111521
|
+
* @remarks
|
|
111522
|
+
* [Api set: 1.1]
|
|
111625
111523
|
*/
|
|
111626
111524
|
unknown = "Unknown",
|
|
111627
111525
|
/**
|
|
111628
|
-
*
|
|
111629
|
-
*
|
|
111630
|
-
*
|
|
111526
|
+
* @remarks
|
|
111527
|
+
* [Api set: 1.1]
|
|
111631
111528
|
*/
|
|
111632
111529
|
basicFlowchart = "BasicFlowchart",
|
|
111633
111530
|
/**
|
|
111634
|
-
*
|
|
111635
|
-
*
|
|
111636
|
-
*
|
|
111531
|
+
* @remarks
|
|
111532
|
+
* [Api set: 1.1]
|
|
111637
111533
|
*/
|
|
111638
111534
|
crossFunctionalFlowchart_Horizontal = "CrossFunctionalFlowchart_Horizontal",
|
|
111639
111535
|
/**
|
|
111640
|
-
*
|
|
111641
|
-
*
|
|
111642
|
-
*
|
|
111536
|
+
* @remarks
|
|
111537
|
+
* [Api set: 1.1]
|
|
111643
111538
|
*/
|
|
111644
111539
|
crossFunctionalFlowchart_Vertical = "CrossFunctionalFlowchart_Vertical",
|
|
111645
111540
|
/**
|
|
111646
|
-
*
|
|
111647
|
-
*
|
|
111648
|
-
*
|
|
111541
|
+
* @remarks
|
|
111542
|
+
* [Api set: 1.1]
|
|
111649
111543
|
*/
|
|
111650
111544
|
audit = "Audit",
|
|
111651
111545
|
/**
|
|
111652
|
-
*
|
|
111653
|
-
*
|
|
111654
|
-
*
|
|
111546
|
+
* @remarks
|
|
111547
|
+
* [Api set: 1.1]
|
|
111655
111548
|
*/
|
|
111656
111549
|
orgChart = "OrgChart",
|
|
111657
111550
|
/**
|
|
111658
|
-
*
|
|
111659
|
-
*
|
|
111660
|
-
*
|
|
111551
|
+
* @remarks
|
|
111552
|
+
* [Api set: 1.1]
|
|
111661
111553
|
*/
|
|
111662
111554
|
network = "Network",
|
|
111663
111555
|
}
|
|
111664
111556
|
/**
|
|
111665
|
-
*
|
|
111666
111557
|
* Represents the type of column values.
|
|
111667
111558
|
*
|
|
111559
|
+
* @remarks
|
|
111668
111560
|
* [Api set: 1.1]
|
|
111669
111561
|
*/
|
|
111670
111562
|
enum ColumnType {
|
|
111671
111563
|
/**
|
|
111672
|
-
*
|
|
111673
|
-
*
|
|
111674
|
-
*
|
|
111564
|
+
* @remarks
|
|
111565
|
+
* [Api set: 1.1]
|
|
111675
111566
|
*/
|
|
111676
111567
|
unknown = "Unknown",
|
|
111677
111568
|
/**
|
|
111678
|
-
*
|
|
111679
|
-
*
|
|
111680
|
-
*
|
|
111569
|
+
* @remarks
|
|
111570
|
+
* [Api set: 1.1]
|
|
111681
111571
|
*/
|
|
111682
111572
|
string = "String",
|
|
111683
111573
|
/**
|
|
111684
|
-
*
|
|
111685
|
-
*
|
|
111686
|
-
*
|
|
111574
|
+
* @remarks
|
|
111575
|
+
* [Api set: 1.1]
|
|
111687
111576
|
*/
|
|
111688
111577
|
number = "Number",
|
|
111689
111578
|
/**
|
|
111690
|
-
*
|
|
111691
|
-
*
|
|
111692
|
-
*
|
|
111579
|
+
* @remarks
|
|
111580
|
+
* [Api set: 1.1]
|
|
111693
111581
|
*/
|
|
111694
111582
|
date = "Date",
|
|
111695
111583
|
/**
|
|
111696
|
-
*
|
|
111697
|
-
*
|
|
111698
|
-
*
|
|
111584
|
+
* @remarks
|
|
111585
|
+
* [Api set: 1.1]
|
|
111699
111586
|
*/
|
|
111700
111587
|
currency = "Currency",
|
|
111701
111588
|
}
|
|
111702
111589
|
/**
|
|
111703
|
-
*
|
|
111704
111590
|
* Represents the type of source for the data connection.
|
|
111705
111591
|
*
|
|
111592
|
+
* @remarks
|
|
111706
111593
|
* [Api set: 1.1]
|
|
111707
111594
|
*/
|
|
111708
111595
|
enum DataSourceType {
|
|
111709
111596
|
/**
|
|
111710
|
-
*
|
|
111711
|
-
*
|
|
111712
|
-
*
|
|
111597
|
+
* Unknown Data Source.
|
|
111598
|
+
* @remarks
|
|
111599
|
+
* [Api set: 1.1]
|
|
111713
111600
|
*/
|
|
111714
111601
|
unknown = "Unknown",
|
|
111715
111602
|
/**
|
|
111716
|
-
*
|
|
111717
|
-
*
|
|
111718
|
-
*
|
|
111603
|
+
* Microsoft Excel workbook.
|
|
111604
|
+
* @remarks
|
|
111605
|
+
* [Api set: 1.1]
|
|
111719
111606
|
*/
|
|
111720
111607
|
excel = "Excel",
|
|
111721
111608
|
}
|
|
111722
111609
|
/**
|
|
111723
|
-
*
|
|
111724
111610
|
* Represents the orientation of the Cross Functional Flowchart diagram.
|
|
111725
111611
|
*
|
|
111612
|
+
* @remarks
|
|
111726
111613
|
* [Api set: 1.1]
|
|
111727
111614
|
*/
|
|
111728
111615
|
enum CrossFunctionalFlowchartOrientation {
|
|
111729
111616
|
/**
|
|
111730
|
-
*
|
|
111731
111617
|
* Horizontal Cross Functional Flowchart.
|
|
111732
|
-
*
|
|
111618
|
+
* @remarks
|
|
111619
|
+
* [Api set: 1.1]
|
|
111733
111620
|
*/
|
|
111734
111621
|
horizontal = "Horizontal",
|
|
111735
111622
|
/**
|
|
111736
|
-
*
|
|
111737
111623
|
* Vertical Cross Functional Flowchart.
|
|
111738
|
-
*
|
|
111624
|
+
* @remarks
|
|
111625
|
+
* [Api set: 1.1]
|
|
111739
111626
|
*/
|
|
111740
111627
|
vertical = "Vertical",
|
|
111741
111628
|
}
|
|
111742
111629
|
/**
|
|
111743
|
-
*
|
|
111744
111630
|
* Represents the type of layout.
|
|
111745
111631
|
*
|
|
111632
|
+
* @remarks
|
|
111746
111633
|
* [Api set: 1.1]
|
|
111747
111634
|
*/
|
|
111748
111635
|
enum LayoutVariant {
|
|
111749
111636
|
/**
|
|
111750
|
-
*
|
|
111751
|
-
*
|
|
111752
|
-
*
|
|
111637
|
+
* Invalid layout.
|
|
111638
|
+
* @remarks
|
|
111639
|
+
* [Api set: 1.1]
|
|
111753
111640
|
*/
|
|
111754
111641
|
unknown = "Unknown",
|
|
111755
111642
|
/**
|
|
111756
|
-
*
|
|
111757
|
-
*
|
|
111758
|
-
*
|
|
111643
|
+
* Use the Page default layout.
|
|
111644
|
+
* @remarks
|
|
111645
|
+
* [Api set: 1.1]
|
|
111759
111646
|
*/
|
|
111760
111647
|
pageDefault = "PageDefault",
|
|
111761
111648
|
/**
|
|
111762
|
-
*
|
|
111763
|
-
*
|
|
111764
|
-
*
|
|
111649
|
+
* Use Flowchart with TopToBottom orientation.
|
|
111650
|
+
* @remarks
|
|
111651
|
+
* [Api set: 1.1]
|
|
111765
111652
|
*/
|
|
111766
111653
|
flowchart_TopToBottom = "Flowchart_TopToBottom",
|
|
111767
111654
|
/**
|
|
111768
|
-
*
|
|
111769
|
-
*
|
|
111770
|
-
*
|
|
111655
|
+
* Use Flowchart with BottomToTop orientation.
|
|
111656
|
+
* @remarks
|
|
111657
|
+
* [Api set: 1.1]
|
|
111771
111658
|
*/
|
|
111772
111659
|
flowchart_BottomToTop = "Flowchart_BottomToTop",
|
|
111773
111660
|
/**
|
|
111774
|
-
*
|
|
111775
|
-
*
|
|
111776
|
-
*
|
|
111661
|
+
* Use Flowchart with LeftToRight orientation.
|
|
111662
|
+
* @remarks
|
|
111663
|
+
* [Api set: 1.1]
|
|
111777
111664
|
*/
|
|
111778
111665
|
flowchart_LeftToRight = "Flowchart_LeftToRight",
|
|
111779
111666
|
/**
|
|
111780
|
-
*
|
|
111781
|
-
*
|
|
111782
|
-
*
|
|
111667
|
+
* Use Flowchart with RightToLeft orientation.
|
|
111668
|
+
* @remarks
|
|
111669
|
+
* [Api set: 1.1]
|
|
111783
111670
|
*/
|
|
111784
111671
|
flowchart_RightToLeft = "Flowchart_RightToLeft",
|
|
111785
111672
|
/**
|
|
111786
|
-
*
|
|
111787
|
-
*
|
|
111788
|
-
*
|
|
111673
|
+
* Use WideTree with DownThenRight orientation.
|
|
111674
|
+
* @remarks
|
|
111675
|
+
* [Api set: 1.1]
|
|
111789
111676
|
*/
|
|
111790
111677
|
wideTree_DownThenRight = "WideTree_DownThenRight",
|
|
111791
111678
|
/**
|
|
111792
|
-
*
|
|
111793
|
-
*
|
|
111794
|
-
*
|
|
111679
|
+
* Use WideTree with DownThenLeft orientation.
|
|
111680
|
+
* @remarks
|
|
111681
|
+
* [Api set: 1.1]
|
|
111795
111682
|
*/
|
|
111796
111683
|
wideTree_DownThenLeft = "WideTree_DownThenLeft",
|
|
111797
111684
|
/**
|
|
111798
|
-
*
|
|
111799
|
-
*
|
|
111800
|
-
*
|
|
111685
|
+
* Use WideTree with RightThenDown orientation.
|
|
111686
|
+
* @remarks
|
|
111687
|
+
* [Api set: 1.1]
|
|
111801
111688
|
*/
|
|
111802
111689
|
wideTree_RightThenDown = "WideTree_RightThenDown",
|
|
111803
111690
|
/**
|
|
111804
|
-
*
|
|
111805
|
-
*
|
|
111806
|
-
*
|
|
111691
|
+
* Use WideTree with LeftThenDown orientation.
|
|
111692
|
+
* @remarks
|
|
111693
|
+
* [Api set: 1.1]
|
|
111807
111694
|
*/
|
|
111808
111695
|
wideTree_LeftThenDown = "WideTree_LeftThenDown",
|
|
111809
111696
|
}
|
|
111810
111697
|
/**
|
|
111811
|
-
*
|
|
111812
111698
|
* Represents the types of data validation error.
|
|
111813
111699
|
*
|
|
111700
|
+
* @remarks
|
|
111814
111701
|
* [Api set: 1.1]
|
|
111815
111702
|
*/
|
|
111816
111703
|
enum DataValidationErrorType {
|
|
111817
111704
|
/**
|
|
111818
|
-
*
|
|
111819
|
-
*
|
|
111820
|
-
*
|
|
111705
|
+
* No error.
|
|
111706
|
+
* @remarks
|
|
111707
|
+
* [Api set: 1.1]
|
|
111821
111708
|
*/
|
|
111822
111709
|
none = "None",
|
|
111823
111710
|
/**
|
|
111824
|
-
*
|
|
111825
111711
|
* Data does not have one of the mapped column.
|
|
111826
|
-
*
|
|
111712
|
+
* @remarks
|
|
111713
|
+
* [Api set: 1.1]
|
|
111827
111714
|
*/
|
|
111828
111715
|
columnNotMapped = "ColumnNotMapped",
|
|
111829
111716
|
/**
|
|
111830
|
-
*
|
|
111831
111717
|
* UniqueId column has error.
|
|
111832
|
-
*
|
|
111718
|
+
* @remarks
|
|
111719
|
+
* [Api set: 1.1]
|
|
111833
111720
|
*/
|
|
111834
111721
|
uniqueIdColumnError = "UniqueIdColumnError",
|
|
111835
111722
|
/**
|
|
111836
|
-
*
|
|
111837
111723
|
* Swim-lane column is empty.
|
|
111838
|
-
*
|
|
111724
|
+
* @remarks
|
|
111725
|
+
* [Api set: 1.1]
|
|
111839
111726
|
*/
|
|
111840
111727
|
swimlaneColumnError = "SwimlaneColumnError",
|
|
111841
111728
|
/**
|
|
111842
|
-
*
|
|
111843
111729
|
* Delimiter can not have more then one character.
|
|
111844
|
-
*
|
|
111730
|
+
* @remarks
|
|
111731
|
+
* [Api set: 1.1]
|
|
111845
111732
|
*/
|
|
111846
111733
|
delimiterError = "DelimiterError",
|
|
111847
111734
|
/**
|
|
111848
|
-
*
|
|
111849
|
-
*
|
|
111850
|
-
*
|
|
111735
|
+
* Connector column has error.
|
|
111736
|
+
* @remarks
|
|
111737
|
+
* [Api set: 1.1]
|
|
111851
111738
|
*/
|
|
111852
111739
|
connectorColumnError = "ConnectorColumnError",
|
|
111853
111740
|
/**
|
|
111854
|
-
*
|
|
111855
111741
|
* Connector column is already mapped
|
|
111856
|
-
|
|
111857
|
-
*
|
|
111742
|
+
to another setting.
|
|
111743
|
+
* @remarks
|
|
111744
|
+
* [Api set: 1.1]
|
|
111858
111745
|
*/
|
|
111859
111746
|
connectorColumnMappedElsewhere = "ConnectorColumnMappedElsewhere",
|
|
111860
111747
|
/**
|
|
111861
|
-
*
|
|
111862
111748
|
* Connector label column already mapped
|
|
111863
|
-
|
|
111864
|
-
*
|
|
111749
|
+
to other setting.
|
|
111750
|
+
* @remarks
|
|
111751
|
+
* [Api set: 1.1]
|
|
111865
111752
|
*/
|
|
111866
111753
|
connectorLabelColumnMappedElsewhere = "ConnectorLabelColumnMappedElsewhere",
|
|
111867
111754
|
/**
|
|
111868
|
-
*
|
|
111869
111755
|
* Connector column and connector label column are
|
|
111870
|
-
|
|
111871
|
-
*
|
|
111756
|
+
already mapped to other setting.
|
|
111757
|
+
* @remarks
|
|
111758
|
+
* [Api set: 1.1]
|
|
111872
111759
|
*/
|
|
111873
111760
|
connectorColumnAndConnectorLabelMappedElsewhere = "ConnectorColumnAndConnectorLabelMappedElsewhere",
|
|
111874
111761
|
}
|
|
111875
111762
|
/**
|
|
111876
|
-
*
|
|
111877
111763
|
* Direction of connector in DataVisualizer diagram.
|
|
111878
111764
|
*
|
|
111765
|
+
* @remarks
|
|
111879
111766
|
* [Api set: 1.1]
|
|
111880
111767
|
*/
|
|
111881
111768
|
enum ConnectorDirection {
|
|
111882
111769
|
/**
|
|
111883
|
-
*
|
|
111884
111770
|
* Direction will be from target to source shape.
|
|
111885
|
-
*
|
|
111771
|
+
* @remarks
|
|
111772
|
+
* [Api set: 1.1]
|
|
111886
111773
|
*/
|
|
111887
111774
|
fromTarget = "FromTarget",
|
|
111888
111775
|
/**
|
|
111889
|
-
*
|
|
111890
111776
|
* Direction will be from source to target shape.
|
|
111891
|
-
*
|
|
111777
|
+
* @remarks
|
|
111778
|
+
* [Api set: 1.1]
|
|
111892
111779
|
*/
|
|
111893
111780
|
toTarget = "ToTarget",
|
|
111894
111781
|
}
|
|
111895
111782
|
/**
|
|
111783
|
+
* TaskPaneType represents the types of the First Party TaskPanes that are supported by Host through APIs. Used in case of Show TaskPane API, TaskPane State Changed, or similar events.
|
|
111896
111784
|
*
|
|
111897
|
-
*
|
|
111898
|
-
*
|
|
111785
|
+
* @remarks
|
|
111899
111786
|
* [Api set: 1.1]
|
|
111900
111787
|
*/
|
|
111901
111788
|
enum TaskPaneType {
|
|
111902
111789
|
/**
|
|
111903
|
-
*
|
|
111904
|
-
*
|
|
111905
|
-
*
|
|
111790
|
+
* No task pane.
|
|
111791
|
+
* @remarks
|
|
111792
|
+
* [Api set: 1.1]
|
|
111906
111793
|
*/
|
|
111907
111794
|
none = "None",
|
|
111908
111795
|
/**
|
|
111909
|
-
*
|
|
111910
|
-
*
|
|
111911
|
-
*
|
|
111796
|
+
* Data Visualizer Process Mapping pane.
|
|
111797
|
+
* @remarks
|
|
111798
|
+
* [Api set: 1.1]
|
|
111912
111799
|
*/
|
|
111913
111800
|
dataVisualizerProcessMappings = "DataVisualizerProcessMappings",
|
|
111914
111801
|
/**
|
|
111915
|
-
*
|
|
111916
|
-
*
|
|
111917
|
-
*
|
|
111802
|
+
* Data Visualizer Organization Mapping pane.
|
|
111803
|
+
* @remarks
|
|
111804
|
+
* [Api set: 1.1]
|
|
111918
111805
|
*/
|
|
111919
111806
|
dataVisualizerOrgChartMappings = "DataVisualizerOrgChartMappings",
|
|
111920
111807
|
}
|
|
111921
111808
|
/**
|
|
111809
|
+
* MessageType represents the type of message when event is fired from Host.
|
|
111922
111810
|
*
|
|
111923
|
-
*
|
|
111811
|
+
* @remarks
|
|
111812
|
+
* [Api set: 1.1]
|
|
111813
|
+
*/
|
|
111814
|
+
enum MessageType {
|
|
111815
|
+
/**
|
|
111816
|
+
* No message.
|
|
111817
|
+
* @remarks
|
|
111818
|
+
* [Api set: 1.1]
|
|
111819
|
+
*/
|
|
111820
|
+
none = 0,
|
|
111821
|
+
/**
|
|
111822
|
+
* DataVisualizer diagram operation complete Event Message.
|
|
111823
|
+
* @remarks
|
|
111824
|
+
* [Api set: 1.1]
|
|
111825
|
+
*/
|
|
111826
|
+
dataVisualizerDiagramOperationCompletedEvent = 1,
|
|
111827
|
+
}
|
|
111828
|
+
/**
|
|
111829
|
+
* EventType represents the type of the events Host supports.
|
|
111924
111830
|
*
|
|
111831
|
+
* @remarks
|
|
111925
111832
|
* [Api set: 1.1]
|
|
111926
111833
|
*/
|
|
111927
111834
|
enum EventType {
|
|
111928
111835
|
/**
|
|
111929
|
-
*
|
|
111930
|
-
*
|
|
111931
|
-
*
|
|
111836
|
+
* DataVisualizer diagram operation complete Event.
|
|
111837
|
+
* @remarks
|
|
111838
|
+
* [Api set: 1.1]
|
|
111932
111839
|
*/
|
|
111933
111840
|
dataVisualizerDiagramOperationCompleted = "DataVisualizerDiagramOperationCompleted",
|
|
111934
111841
|
}
|
|
@@ -111957,16 +111864,16 @@ declare namespace Visio {
|
|
|
111957
111864
|
/** An interface for updating data on the Application object, for use in `application.set({ ... })`. */
|
|
111958
111865
|
interface ApplicationUpdateData {
|
|
111959
111866
|
/**
|
|
111867
|
+
* Shows or hides the iframe application borders.
|
|
111960
111868
|
*
|
|
111961
|
-
*
|
|
111962
|
-
*
|
|
111869
|
+
* @remarks
|
|
111963
111870
|
* [Api set: 1.1]
|
|
111964
111871
|
*/
|
|
111965
111872
|
showBorders?: boolean;
|
|
111966
111873
|
/**
|
|
111874
|
+
* Shows or hides the standard toolbars.
|
|
111967
111875
|
*
|
|
111968
|
-
*
|
|
111969
|
-
*
|
|
111876
|
+
* @remarks
|
|
111970
111877
|
* [Api set: 1.1]
|
|
111971
111878
|
*/
|
|
111972
111879
|
showToolbars?: boolean;
|
|
@@ -111974,16 +111881,16 @@ declare namespace Visio {
|
|
|
111974
111881
|
/** An interface for updating data on the Document object, for use in `document.set({ ... })`. */
|
|
111975
111882
|
interface DocumentUpdateData {
|
|
111976
111883
|
/**
|
|
111977
|
-
*
|
|
111978
111884
|
* Represents a Visio application instance that contains this document.
|
|
111979
111885
|
*
|
|
111886
|
+
* @remarks
|
|
111980
111887
|
* [Api set: 1.1]
|
|
111981
111888
|
*/
|
|
111982
111889
|
application?: Visio.Interfaces.ApplicationUpdateData;
|
|
111983
111890
|
/**
|
|
111984
|
-
*
|
|
111985
111891
|
* Returns the DocumentView object.
|
|
111986
111892
|
*
|
|
111893
|
+
* @remarks
|
|
111987
111894
|
* [Api set: 1.1]
|
|
111988
111895
|
*/
|
|
111989
111896
|
view?: Visio.Interfaces.DocumentViewUpdateData;
|
|
@@ -111991,37 +111898,37 @@ declare namespace Visio {
|
|
|
111991
111898
|
/** An interface for updating data on the DocumentView object, for use in `documentView.set({ ... })`. */
|
|
111992
111899
|
interface DocumentViewUpdateData {
|
|
111993
111900
|
/**
|
|
111994
|
-
*
|
|
111995
111901
|
* Disable Hyperlinks.
|
|
111996
111902
|
*
|
|
111903
|
+
* @remarks
|
|
111997
111904
|
* [Api set: 1.1]
|
|
111998
111905
|
*/
|
|
111999
111906
|
disableHyperlinks?: boolean;
|
|
112000
111907
|
/**
|
|
112001
|
-
*
|
|
112002
111908
|
* Disable Pan.
|
|
112003
111909
|
*
|
|
111910
|
+
* @remarks
|
|
112004
111911
|
* [Api set: 1.1]
|
|
112005
111912
|
*/
|
|
112006
111913
|
disablePan?: boolean;
|
|
112007
111914
|
/**
|
|
112008
|
-
*
|
|
112009
111915
|
* Disable PanZoomWindow.
|
|
112010
111916
|
*
|
|
111917
|
+
* @remarks
|
|
112011
111918
|
* [Api set: 1.1]
|
|
112012
111919
|
*/
|
|
112013
111920
|
disablePanZoomWindow?: boolean;
|
|
112014
111921
|
/**
|
|
112015
|
-
*
|
|
112016
111922
|
* Disable Zoom.
|
|
112017
111923
|
*
|
|
111924
|
+
* @remarks
|
|
112018
111925
|
* [Api set: 1.1]
|
|
112019
111926
|
*/
|
|
112020
111927
|
disableZoom?: boolean;
|
|
112021
111928
|
/**
|
|
112022
|
-
*
|
|
112023
111929
|
* Hide Diagram Boundary.
|
|
112024
111930
|
*
|
|
111931
|
+
* @remarks
|
|
112025
111932
|
* [Api set: 1.1]
|
|
112026
111933
|
*/
|
|
112027
111934
|
hideDiagramBoundary?: boolean;
|
|
@@ -112029,9 +111936,9 @@ declare namespace Visio {
|
|
|
112029
111936
|
/** An interface for updating data on the Page object, for use in `page.set({ ... })`. */
|
|
112030
111937
|
interface PageUpdateData {
|
|
112031
111938
|
/**
|
|
112032
|
-
*
|
|
112033
111939
|
* Returns the view of the page.
|
|
112034
111940
|
*
|
|
111941
|
+
* @remarks
|
|
112035
111942
|
* [Api set: 1.1]
|
|
112036
111943
|
*/
|
|
112037
111944
|
view?: Visio.Interfaces.PageViewUpdateData;
|
|
@@ -112039,9 +111946,9 @@ declare namespace Visio {
|
|
|
112039
111946
|
/** An interface for updating data on the PageView object, for use in `pageView.set({ ... })`. */
|
|
112040
111947
|
interface PageViewUpdateData {
|
|
112041
111948
|
/**
|
|
111949
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112042
111950
|
*
|
|
112043
|
-
*
|
|
112044
|
-
*
|
|
111951
|
+
* @remarks
|
|
112045
111952
|
* [Api set: 1.1]
|
|
112046
111953
|
*/
|
|
112047
111954
|
zoom?: number;
|
|
@@ -112057,16 +111964,16 @@ declare namespace Visio {
|
|
|
112057
111964
|
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
112058
111965
|
interface ShapeUpdateData {
|
|
112059
111966
|
/**
|
|
112060
|
-
*
|
|
112061
111967
|
* Returns the view of the shape.
|
|
112062
111968
|
*
|
|
111969
|
+
* @remarks
|
|
112063
111970
|
* [Api set: 1.1]
|
|
112064
111971
|
*/
|
|
112065
111972
|
view?: Visio.Interfaces.ShapeViewUpdateData;
|
|
112066
111973
|
/**
|
|
112067
|
-
*
|
|
112068
111974
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112069
111975
|
*
|
|
111976
|
+
* @remarks
|
|
112070
111977
|
* [Api set: 1.1]
|
|
112071
111978
|
*/
|
|
112072
111979
|
select?: boolean;
|
|
@@ -112074,9 +111981,9 @@ declare namespace Visio {
|
|
|
112074
111981
|
/** An interface for updating data on the ShapeView object, for use in `shapeView.set({ ... })`. */
|
|
112075
111982
|
interface ShapeViewUpdateData {
|
|
112076
111983
|
/**
|
|
112077
|
-
*
|
|
112078
111984
|
* Represents the highlight around the shape.
|
|
112079
111985
|
*
|
|
111986
|
+
* @remarks
|
|
112080
111987
|
* [Api set: 1.1]
|
|
112081
111988
|
*/
|
|
112082
111989
|
highlight?: Visio.Highlight;
|
|
@@ -112096,23 +112003,23 @@ declare namespace Visio {
|
|
|
112096
112003
|
/** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
|
|
112097
112004
|
interface CommentUpdateData {
|
|
112098
112005
|
/**
|
|
112099
|
-
*
|
|
112100
112006
|
* A string that specifies the name of the author of the comment.
|
|
112101
112007
|
*
|
|
112008
|
+
* @remarks
|
|
112102
112009
|
* [Api set: 1.1]
|
|
112103
112010
|
*/
|
|
112104
112011
|
author?: string;
|
|
112105
112012
|
/**
|
|
112106
|
-
*
|
|
112107
112013
|
* A string that specifies the date when the comment was created.
|
|
112108
112014
|
*
|
|
112015
|
+
* @remarks
|
|
112109
112016
|
* [Api set: 1.1]
|
|
112110
112017
|
*/
|
|
112111
112018
|
date?: string;
|
|
112112
112019
|
/**
|
|
112113
|
-
*
|
|
112114
112020
|
* A string that contains the comment text.
|
|
112115
112021
|
*
|
|
112022
|
+
* @remarks
|
|
112116
112023
|
* [Api set: 1.1]
|
|
112117
112024
|
*/
|
|
112118
112025
|
text?: string;
|
|
@@ -112120,16 +112027,16 @@ declare namespace Visio {
|
|
|
112120
112027
|
/** An interface describing the data returned by calling `application.toJSON()`. */
|
|
112121
112028
|
interface ApplicationData {
|
|
112122
112029
|
/**
|
|
112030
|
+
* Shows or hides the iframe application borders.
|
|
112123
112031
|
*
|
|
112124
|
-
*
|
|
112125
|
-
*
|
|
112032
|
+
* @remarks
|
|
112126
112033
|
* [Api set: 1.1]
|
|
112127
112034
|
*/
|
|
112128
112035
|
showBorders?: boolean;
|
|
112129
112036
|
/**
|
|
112037
|
+
* Shows or hides the standard toolbars.
|
|
112130
112038
|
*
|
|
112131
|
-
*
|
|
112132
|
-
*
|
|
112039
|
+
* @remarks
|
|
112133
112040
|
* [Api set: 1.1]
|
|
112134
112041
|
*/
|
|
112135
112042
|
showToolbars?: boolean;
|
|
@@ -112137,23 +112044,23 @@ declare namespace Visio {
|
|
|
112137
112044
|
/** An interface describing the data returned by calling `document.toJSON()`. */
|
|
112138
112045
|
interface DocumentData {
|
|
112139
112046
|
/**
|
|
112047
|
+
* Represents a Visio application instance that contains this document.
|
|
112140
112048
|
*
|
|
112141
|
-
*
|
|
112142
|
-
*
|
|
112049
|
+
* @remarks
|
|
112143
112050
|
* [Api set: 1.1]
|
|
112144
112051
|
*/
|
|
112145
112052
|
application?: Visio.Interfaces.ApplicationData;
|
|
112146
112053
|
/**
|
|
112054
|
+
* Represents a collection of pages associated with the document.
|
|
112147
112055
|
*
|
|
112148
|
-
*
|
|
112149
|
-
*
|
|
112056
|
+
* @remarks
|
|
112150
112057
|
* [Api set: 1.1]
|
|
112151
112058
|
*/
|
|
112152
112059
|
pages?: Visio.Interfaces.PageData[];
|
|
112153
112060
|
/**
|
|
112061
|
+
* Returns the DocumentView object.
|
|
112154
112062
|
*
|
|
112155
|
-
*
|
|
112156
|
-
*
|
|
112063
|
+
* @remarks
|
|
112157
112064
|
* [Api set: 1.1]
|
|
112158
112065
|
*/
|
|
112159
112066
|
view?: Visio.Interfaces.DocumentViewData;
|
|
@@ -112161,37 +112068,37 @@ declare namespace Visio {
|
|
|
112161
112068
|
/** An interface describing the data returned by calling `documentView.toJSON()`. */
|
|
112162
112069
|
interface DocumentViewData {
|
|
112163
112070
|
/**
|
|
112164
|
-
*
|
|
112165
112071
|
* Disable Hyperlinks.
|
|
112166
112072
|
*
|
|
112073
|
+
* @remarks
|
|
112167
112074
|
* [Api set: 1.1]
|
|
112168
112075
|
*/
|
|
112169
112076
|
disableHyperlinks?: boolean;
|
|
112170
112077
|
/**
|
|
112171
|
-
*
|
|
112172
112078
|
* Disable Pan.
|
|
112173
112079
|
*
|
|
112080
|
+
* @remarks
|
|
112174
112081
|
* [Api set: 1.1]
|
|
112175
112082
|
*/
|
|
112176
112083
|
disablePan?: boolean;
|
|
112177
112084
|
/**
|
|
112178
|
-
*
|
|
112179
112085
|
* Disable PanZoomWindow.
|
|
112180
112086
|
*
|
|
112087
|
+
* @remarks
|
|
112181
112088
|
* [Api set: 1.1]
|
|
112182
112089
|
*/
|
|
112183
112090
|
disablePanZoomWindow?: boolean;
|
|
112184
112091
|
/**
|
|
112185
|
-
*
|
|
112186
112092
|
* Disable Zoom.
|
|
112187
112093
|
*
|
|
112094
|
+
* @remarks
|
|
112188
112095
|
* [Api set: 1.1]
|
|
112189
112096
|
*/
|
|
112190
112097
|
disableZoom?: boolean;
|
|
112191
112098
|
/**
|
|
112192
|
-
*
|
|
112193
112099
|
* Hide Diagram Boundary.
|
|
112194
112100
|
*
|
|
112101
|
+
* @remarks
|
|
112195
112102
|
* [Api set: 1.1]
|
|
112196
112103
|
*/
|
|
112197
112104
|
hideDiagramBoundary?: boolean;
|
|
@@ -112199,65 +112106,65 @@ declare namespace Visio {
|
|
|
112199
112106
|
/** An interface describing the data returned by calling `page.toJSON()`. */
|
|
112200
112107
|
interface PageData {
|
|
112201
112108
|
/**
|
|
112109
|
+
* All shapes in the Page, including subshapes.
|
|
112202
112110
|
*
|
|
112203
|
-
*
|
|
112204
|
-
*
|
|
112111
|
+
* @remarks
|
|
112205
112112
|
* [Api set: 1.1]
|
|
112206
112113
|
*/
|
|
112207
112114
|
allShapes?: Visio.Interfaces.ShapeData[];
|
|
112208
112115
|
/**
|
|
112116
|
+
* Returns the Comments Collection.
|
|
112209
112117
|
*
|
|
112210
|
-
*
|
|
112211
|
-
*
|
|
112118
|
+
* @remarks
|
|
112212
112119
|
* [Api set: 1.1]
|
|
112213
112120
|
*/
|
|
112214
112121
|
comments?: Visio.Interfaces.CommentData[];
|
|
112215
112122
|
/**
|
|
112123
|
+
* All top-level shapes in the Page.
|
|
112216
112124
|
*
|
|
112217
|
-
*
|
|
112218
|
-
*
|
|
112125
|
+
* @remarks
|
|
112219
112126
|
* [Api set: 1.1]
|
|
112220
112127
|
*/
|
|
112221
112128
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
112222
112129
|
/**
|
|
112130
|
+
* Returns the view of the page.
|
|
112223
112131
|
*
|
|
112224
|
-
*
|
|
112225
|
-
*
|
|
112132
|
+
* @remarks
|
|
112226
112133
|
* [Api set: 1.1]
|
|
112227
112134
|
*/
|
|
112228
112135
|
view?: Visio.Interfaces.PageViewData;
|
|
112229
112136
|
/**
|
|
112137
|
+
* Returns the height of the page.
|
|
112230
112138
|
*
|
|
112231
|
-
*
|
|
112232
|
-
*
|
|
112139
|
+
* @remarks
|
|
112233
112140
|
* [Api set: 1.1]
|
|
112234
112141
|
*/
|
|
112235
112142
|
height?: number;
|
|
112236
112143
|
/**
|
|
112144
|
+
* Index of the Page.
|
|
112237
112145
|
*
|
|
112238
|
-
*
|
|
112239
|
-
*
|
|
112146
|
+
* @remarks
|
|
112240
112147
|
* [Api set: 1.1]
|
|
112241
112148
|
*/
|
|
112242
112149
|
index?: number;
|
|
112243
112150
|
/**
|
|
112151
|
+
* Whether the page is a background page or not.
|
|
112244
112152
|
*
|
|
112245
|
-
*
|
|
112246
|
-
*
|
|
112153
|
+
* @remarks
|
|
112247
112154
|
* [Api set: 1.1]
|
|
112248
112155
|
*/
|
|
112249
112156
|
isBackground?: boolean;
|
|
112250
112157
|
/**
|
|
112158
|
+
* Page name.
|
|
112251
112159
|
*
|
|
112252
|
-
*
|
|
112253
|
-
*
|
|
112160
|
+
* @remarks
|
|
112254
112161
|
* [Api set: 1.1]
|
|
112255
112162
|
*/
|
|
112256
112163
|
name?: string;
|
|
112257
112164
|
/**
|
|
112165
|
+
* Returns the width of the page.
|
|
112258
112166
|
*
|
|
112259
|
-
*
|
|
112260
|
-
*
|
|
112167
|
+
* @remarks
|
|
112261
112168
|
* [Api set: 1.1]
|
|
112262
112169
|
*/
|
|
112263
112170
|
width?: number;
|
|
@@ -112265,9 +112172,9 @@ declare namespace Visio {
|
|
|
112265
112172
|
/** An interface describing the data returned by calling `pageView.toJSON()`. */
|
|
112266
112173
|
interface PageViewData {
|
|
112267
112174
|
/**
|
|
112175
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112268
112176
|
*
|
|
112269
|
-
*
|
|
112270
|
-
*
|
|
112177
|
+
* @remarks
|
|
112271
112178
|
* [Api set: 1.1]
|
|
112272
112179
|
*/
|
|
112273
112180
|
zoom?: number;
|
|
@@ -112283,65 +112190,65 @@ declare namespace Visio {
|
|
|
112283
112190
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
112284
112191
|
interface ShapeData {
|
|
112285
112192
|
/**
|
|
112193
|
+
* Returns the Comments Collection.
|
|
112286
112194
|
*
|
|
112287
|
-
*
|
|
112288
|
-
*
|
|
112195
|
+
* @remarks
|
|
112289
112196
|
* [Api set: 1.1]
|
|
112290
112197
|
*/
|
|
112291
112198
|
comments?: Visio.Interfaces.CommentData[];
|
|
112292
112199
|
/**
|
|
112200
|
+
* Returns the Hyperlinks collection for a Shape object.
|
|
112293
112201
|
*
|
|
112294
|
-
*
|
|
112295
|
-
*
|
|
112202
|
+
* @remarks
|
|
112296
112203
|
* [Api set: 1.1]
|
|
112297
112204
|
*/
|
|
112298
112205
|
hyperlinks?: Visio.Interfaces.HyperlinkData[];
|
|
112299
112206
|
/**
|
|
112207
|
+
* Returns the Shape's Data Section.
|
|
112300
112208
|
*
|
|
112301
|
-
*
|
|
112302
|
-
*
|
|
112209
|
+
* @remarks
|
|
112303
112210
|
* [Api set: 1.1]
|
|
112304
112211
|
*/
|
|
112305
112212
|
shapeDataItems?: Visio.Interfaces.ShapeDataItemData[];
|
|
112306
112213
|
/**
|
|
112214
|
+
* Gets SubShape Collection.
|
|
112307
112215
|
*
|
|
112308
|
-
*
|
|
112309
|
-
*
|
|
112216
|
+
* @remarks
|
|
112310
112217
|
* [Api set: 1.1]
|
|
112311
112218
|
*/
|
|
112312
112219
|
subShapes?: Visio.Interfaces.ShapeData[];
|
|
112313
112220
|
/**
|
|
112221
|
+
* Returns the view of the shape.
|
|
112314
112222
|
*
|
|
112315
|
-
*
|
|
112316
|
-
*
|
|
112223
|
+
* @remarks
|
|
112317
112224
|
* [Api set: 1.1]
|
|
112318
112225
|
*/
|
|
112319
112226
|
view?: Visio.Interfaces.ShapeViewData;
|
|
112320
112227
|
/**
|
|
112228
|
+
* Shape's identifier.
|
|
112321
112229
|
*
|
|
112322
|
-
*
|
|
112323
|
-
*
|
|
112230
|
+
* @remarks
|
|
112324
112231
|
* [Api set: 1.1]
|
|
112325
112232
|
*/
|
|
112326
112233
|
id?: number;
|
|
112327
112234
|
/**
|
|
112235
|
+
* Shape's name.
|
|
112328
112236
|
*
|
|
112329
|
-
*
|
|
112330
|
-
*
|
|
112237
|
+
* @remarks
|
|
112331
112238
|
* [Api set: 1.1]
|
|
112332
112239
|
*/
|
|
112333
112240
|
name?: string;
|
|
112334
112241
|
/**
|
|
112335
|
-
*
|
|
112336
112242
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112337
112243
|
*
|
|
112244
|
+
* @remarks
|
|
112338
112245
|
* [Api set: 1.1]
|
|
112339
112246
|
*/
|
|
112340
112247
|
select?: boolean;
|
|
112341
112248
|
/**
|
|
112249
|
+
* Shape's text.
|
|
112342
112250
|
*
|
|
112343
|
-
*
|
|
112344
|
-
*
|
|
112251
|
+
* @remarks
|
|
112345
112252
|
* [Api set: 1.1]
|
|
112346
112253
|
*/
|
|
112347
112254
|
text?: string;
|
|
@@ -112349,9 +112256,9 @@ declare namespace Visio {
|
|
|
112349
112256
|
/** An interface describing the data returned by calling `shapeView.toJSON()`. */
|
|
112350
112257
|
interface ShapeViewData {
|
|
112351
112258
|
/**
|
|
112352
|
-
*
|
|
112353
112259
|
* Represents the highlight around the shape.
|
|
112354
112260
|
*
|
|
112261
|
+
* @remarks
|
|
112355
112262
|
* [Api set: 1.1]
|
|
112356
112263
|
*/
|
|
112357
112264
|
highlight?: Visio.Highlight;
|
|
@@ -112363,30 +112270,30 @@ declare namespace Visio {
|
|
|
112363
112270
|
/** An interface describing the data returned by calling `shapeDataItem.toJSON()`. */
|
|
112364
112271
|
interface ShapeDataItemData {
|
|
112365
112272
|
/**
|
|
112273
|
+
* A string that specifies the format of the shape data item.
|
|
112366
112274
|
*
|
|
112367
|
-
*
|
|
112368
|
-
*
|
|
112275
|
+
* @remarks
|
|
112369
112276
|
* [Api set: 1.1]
|
|
112370
112277
|
*/
|
|
112371
112278
|
format?: string;
|
|
112372
112279
|
/**
|
|
112280
|
+
* A string that specifies the formatted value of the shape data item.
|
|
112373
112281
|
*
|
|
112374
|
-
*
|
|
112375
|
-
*
|
|
112282
|
+
* @remarks
|
|
112376
112283
|
* [Api set: 1.1]
|
|
112377
112284
|
*/
|
|
112378
112285
|
formattedValue?: string;
|
|
112379
112286
|
/**
|
|
112287
|
+
* A string that specifies the label of the shape data item.
|
|
112380
112288
|
*
|
|
112381
|
-
*
|
|
112382
|
-
*
|
|
112289
|
+
* @remarks
|
|
112383
112290
|
* [Api set: 1.1]
|
|
112384
112291
|
*/
|
|
112385
112292
|
label?: string;
|
|
112386
112293
|
/**
|
|
112294
|
+
* A string that specifies the value of the shape data item.
|
|
112387
112295
|
*
|
|
112388
|
-
*
|
|
112389
|
-
*
|
|
112296
|
+
* @remarks
|
|
112390
112297
|
* [Api set: 1.1]
|
|
112391
112298
|
*/
|
|
112392
112299
|
value?: string;
|
|
@@ -112398,30 +112305,30 @@ declare namespace Visio {
|
|
|
112398
112305
|
/** An interface describing the data returned by calling `hyperlink.toJSON()`. */
|
|
112399
112306
|
interface HyperlinkData {
|
|
112400
112307
|
/**
|
|
112308
|
+
* Gets the address of the Hyperlink object.
|
|
112401
112309
|
*
|
|
112402
|
-
*
|
|
112403
|
-
*
|
|
112310
|
+
* @remarks
|
|
112404
112311
|
* [Api set: 1.1]
|
|
112405
112312
|
*/
|
|
112406
112313
|
address?: string;
|
|
112407
112314
|
/**
|
|
112315
|
+
* Gets the description of a hyperlink.
|
|
112408
112316
|
*
|
|
112409
|
-
*
|
|
112410
|
-
*
|
|
112317
|
+
* @remarks
|
|
112411
112318
|
* [Api set: 1.1]
|
|
112412
112319
|
*/
|
|
112413
112320
|
description?: string;
|
|
112414
112321
|
/**
|
|
112322
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
112415
112323
|
*
|
|
112416
|
-
*
|
|
112417
|
-
*
|
|
112324
|
+
* @remarks
|
|
112418
112325
|
* [Api set: 1.1]
|
|
112419
112326
|
*/
|
|
112420
112327
|
extraInfo?: string;
|
|
112421
112328
|
/**
|
|
112329
|
+
* Gets the sub-address of the Hyperlink object.
|
|
112422
112330
|
*
|
|
112423
|
-
*
|
|
112424
|
-
*
|
|
112331
|
+
* @remarks
|
|
112425
112332
|
* [Api set: 1.1]
|
|
112426
112333
|
*/
|
|
112427
112334
|
subAddress?: string;
|
|
@@ -112433,23 +112340,23 @@ declare namespace Visio {
|
|
|
112433
112340
|
/** An interface describing the data returned by calling `comment.toJSON()`. */
|
|
112434
112341
|
interface CommentData {
|
|
112435
112342
|
/**
|
|
112436
|
-
*
|
|
112437
112343
|
* A string that specifies the name of the author of the comment.
|
|
112438
112344
|
*
|
|
112345
|
+
* @remarks
|
|
112439
112346
|
* [Api set: 1.1]
|
|
112440
112347
|
*/
|
|
112441
112348
|
author?: string;
|
|
112442
112349
|
/**
|
|
112443
|
-
*
|
|
112444
112350
|
* A string that specifies the date when the comment was created.
|
|
112445
112351
|
*
|
|
112352
|
+
* @remarks
|
|
112446
112353
|
* [Api set: 1.1]
|
|
112447
112354
|
*/
|
|
112448
112355
|
date?: string;
|
|
112449
112356
|
/**
|
|
112450
|
-
*
|
|
112451
112357
|
* A string that contains the comment text.
|
|
112452
112358
|
*
|
|
112359
|
+
* @remarks
|
|
112453
112360
|
* [Api set: 1.1]
|
|
112454
112361
|
*/
|
|
112455
112362
|
text?: string;
|
|
@@ -112457,17 +112364,17 @@ declare namespace Visio {
|
|
|
112457
112364
|
/** An interface describing the data returned by calling `selection.toJSON()`. */
|
|
112458
112365
|
interface SelectionData {
|
|
112459
112366
|
/**
|
|
112367
|
+
* Gets the Shapes of the Selection.
|
|
112460
112368
|
*
|
|
112461
|
-
*
|
|
112462
|
-
*
|
|
112369
|
+
* @remarks
|
|
112463
112370
|
* [Api set: 1.1]
|
|
112464
112371
|
*/
|
|
112465
112372
|
shapes?: Visio.Interfaces.ShapeData[];
|
|
112466
112373
|
}
|
|
112467
112374
|
/**
|
|
112468
|
-
*
|
|
112469
112375
|
* Represents the Application.
|
|
112470
112376
|
*
|
|
112377
|
+
* @remarks
|
|
112471
112378
|
* [Api set: 1.1]
|
|
112472
112379
|
*/
|
|
112473
112380
|
interface ApplicationLoadOptions {
|
|
@@ -112476,24 +112383,24 @@ declare namespace Visio {
|
|
|
112476
112383
|
*/
|
|
112477
112384
|
$all?: boolean;
|
|
112478
112385
|
/**
|
|
112386
|
+
* Shows or hides the iframe application borders.
|
|
112479
112387
|
*
|
|
112480
|
-
*
|
|
112481
|
-
*
|
|
112388
|
+
* @remarks
|
|
112482
112389
|
* [Api set: 1.1]
|
|
112483
112390
|
*/
|
|
112484
112391
|
showBorders?: boolean;
|
|
112485
112392
|
/**
|
|
112393
|
+
* Shows or hides the standard toolbars.
|
|
112486
112394
|
*
|
|
112487
|
-
*
|
|
112488
|
-
*
|
|
112395
|
+
* @remarks
|
|
112489
112396
|
* [Api set: 1.1]
|
|
112490
112397
|
*/
|
|
112491
112398
|
showToolbars?: boolean;
|
|
112492
112399
|
}
|
|
112493
112400
|
/**
|
|
112494
|
-
*
|
|
112495
112401
|
* Represents the Document class.
|
|
112496
112402
|
*
|
|
112403
|
+
* @remarks
|
|
112497
112404
|
* [Api set: 1.1]
|
|
112498
112405
|
*/
|
|
112499
112406
|
interface DocumentLoadOptions {
|
|
@@ -112502,24 +112409,24 @@ declare namespace Visio {
|
|
|
112502
112409
|
*/
|
|
112503
112410
|
$all?: boolean;
|
|
112504
112411
|
/**
|
|
112505
|
-
*
|
|
112506
112412
|
* Represents a Visio application instance that contains this document.
|
|
112507
112413
|
*
|
|
112414
|
+
* @remarks
|
|
112508
112415
|
* [Api set: 1.1]
|
|
112509
112416
|
*/
|
|
112510
112417
|
application?: Visio.Interfaces.ApplicationLoadOptions;
|
|
112511
112418
|
/**
|
|
112512
|
-
*
|
|
112513
112419
|
* Returns the DocumentView object.
|
|
112514
112420
|
*
|
|
112421
|
+
* @remarks
|
|
112515
112422
|
* [Api set: 1.1]
|
|
112516
112423
|
*/
|
|
112517
112424
|
view?: Visio.Interfaces.DocumentViewLoadOptions;
|
|
112518
112425
|
}
|
|
112519
112426
|
/**
|
|
112520
|
-
*
|
|
112521
112427
|
* Represents the DocumentView class.
|
|
112522
112428
|
*
|
|
112429
|
+
* @remarks
|
|
112523
112430
|
* [Api set: 1.1]
|
|
112524
112431
|
*/
|
|
112525
112432
|
interface DocumentViewLoadOptions {
|
|
@@ -112528,45 +112435,45 @@ declare namespace Visio {
|
|
|
112528
112435
|
*/
|
|
112529
112436
|
$all?: boolean;
|
|
112530
112437
|
/**
|
|
112531
|
-
*
|
|
112532
112438
|
* Disable Hyperlinks.
|
|
112533
112439
|
*
|
|
112440
|
+
* @remarks
|
|
112534
112441
|
* [Api set: 1.1]
|
|
112535
112442
|
*/
|
|
112536
112443
|
disableHyperlinks?: boolean;
|
|
112537
112444
|
/**
|
|
112538
|
-
*
|
|
112539
112445
|
* Disable Pan.
|
|
112540
112446
|
*
|
|
112447
|
+
* @remarks
|
|
112541
112448
|
* [Api set: 1.1]
|
|
112542
112449
|
*/
|
|
112543
112450
|
disablePan?: boolean;
|
|
112544
112451
|
/**
|
|
112545
|
-
*
|
|
112546
112452
|
* Disable PanZoomWindow.
|
|
112547
112453
|
*
|
|
112454
|
+
* @remarks
|
|
112548
112455
|
* [Api set: 1.1]
|
|
112549
112456
|
*/
|
|
112550
112457
|
disablePanZoomWindow?: boolean;
|
|
112551
112458
|
/**
|
|
112552
|
-
*
|
|
112553
112459
|
* Disable Zoom.
|
|
112554
112460
|
*
|
|
112461
|
+
* @remarks
|
|
112555
112462
|
* [Api set: 1.1]
|
|
112556
112463
|
*/
|
|
112557
112464
|
disableZoom?: boolean;
|
|
112558
112465
|
/**
|
|
112559
|
-
*
|
|
112560
112466
|
* Hide Diagram Boundary.
|
|
112561
112467
|
*
|
|
112468
|
+
* @remarks
|
|
112562
112469
|
* [Api set: 1.1]
|
|
112563
112470
|
*/
|
|
112564
112471
|
hideDiagramBoundary?: boolean;
|
|
112565
112472
|
}
|
|
112566
112473
|
/**
|
|
112567
|
-
*
|
|
112568
112474
|
* Represents the Page class.
|
|
112569
112475
|
*
|
|
112476
|
+
* @remarks
|
|
112570
112477
|
* [Api set: 1.1]
|
|
112571
112478
|
*/
|
|
112572
112479
|
interface PageLoadOptions {
|
|
@@ -112575,52 +112482,52 @@ declare namespace Visio {
|
|
|
112575
112482
|
*/
|
|
112576
112483
|
$all?: boolean;
|
|
112577
112484
|
/**
|
|
112578
|
-
*
|
|
112579
112485
|
* Returns the view of the page.
|
|
112580
112486
|
*
|
|
112487
|
+
* @remarks
|
|
112581
112488
|
* [Api set: 1.1]
|
|
112582
112489
|
*/
|
|
112583
112490
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
112584
112491
|
/**
|
|
112492
|
+
* Returns the height of the page.
|
|
112585
112493
|
*
|
|
112586
|
-
*
|
|
112587
|
-
*
|
|
112494
|
+
* @remarks
|
|
112588
112495
|
* [Api set: 1.1]
|
|
112589
112496
|
*/
|
|
112590
112497
|
height?: boolean;
|
|
112591
112498
|
/**
|
|
112499
|
+
* Index of the Page.
|
|
112592
112500
|
*
|
|
112593
|
-
*
|
|
112594
|
-
*
|
|
112501
|
+
* @remarks
|
|
112595
112502
|
* [Api set: 1.1]
|
|
112596
112503
|
*/
|
|
112597
112504
|
index?: boolean;
|
|
112598
112505
|
/**
|
|
112506
|
+
* Whether the page is a background page or not.
|
|
112599
112507
|
*
|
|
112600
|
-
*
|
|
112601
|
-
*
|
|
112508
|
+
* @remarks
|
|
112602
112509
|
* [Api set: 1.1]
|
|
112603
112510
|
*/
|
|
112604
112511
|
isBackground?: boolean;
|
|
112605
112512
|
/**
|
|
112513
|
+
* Page name.
|
|
112606
112514
|
*
|
|
112607
|
-
*
|
|
112608
|
-
*
|
|
112515
|
+
* @remarks
|
|
112609
112516
|
* [Api set: 1.1]
|
|
112610
112517
|
*/
|
|
112611
112518
|
name?: boolean;
|
|
112612
112519
|
/**
|
|
112520
|
+
* Returns the width of the page.
|
|
112613
112521
|
*
|
|
112614
|
-
*
|
|
112615
|
-
*
|
|
112522
|
+
* @remarks
|
|
112616
112523
|
* [Api set: 1.1]
|
|
112617
112524
|
*/
|
|
112618
112525
|
width?: boolean;
|
|
112619
112526
|
}
|
|
112620
112527
|
/**
|
|
112621
|
-
*
|
|
112622
112528
|
* Represents the PageView class.
|
|
112623
112529
|
*
|
|
112530
|
+
* @remarks
|
|
112624
112531
|
* [Api set: 1.1]
|
|
112625
112532
|
*/
|
|
112626
112533
|
interface PageViewLoadOptions {
|
|
@@ -112629,17 +112536,17 @@ declare namespace Visio {
|
|
|
112629
112536
|
*/
|
|
112630
112537
|
$all?: boolean;
|
|
112631
112538
|
/**
|
|
112539
|
+
* Gets and sets the page's zoom level. The value can be between 10 and 400 and denotes the percentage of zoom.
|
|
112632
112540
|
*
|
|
112633
|
-
*
|
|
112634
|
-
*
|
|
112541
|
+
* @remarks
|
|
112635
112542
|
* [Api set: 1.1]
|
|
112636
112543
|
*/
|
|
112637
112544
|
zoom?: boolean;
|
|
112638
112545
|
}
|
|
112639
112546
|
/**
|
|
112640
|
-
*
|
|
112641
112547
|
* Represents a collection of Page objects that are part of the document.
|
|
112642
112548
|
*
|
|
112549
|
+
* @remarks
|
|
112643
112550
|
* [Api set: 1.1]
|
|
112644
112551
|
*/
|
|
112645
112552
|
interface PageCollectionLoadOptions {
|
|
@@ -112648,52 +112555,52 @@ declare namespace Visio {
|
|
|
112648
112555
|
*/
|
|
112649
112556
|
$all?: boolean;
|
|
112650
112557
|
/**
|
|
112651
|
-
*
|
|
112652
112558
|
* For EACH ITEM in the collection: Returns the view of the page.
|
|
112653
112559
|
*
|
|
112560
|
+
* @remarks
|
|
112654
112561
|
* [Api set: 1.1]
|
|
112655
112562
|
*/
|
|
112656
112563
|
view?: Visio.Interfaces.PageViewLoadOptions;
|
|
112657
112564
|
/**
|
|
112565
|
+
* For EACH ITEM in the collection: Returns the height of the page.
|
|
112658
112566
|
*
|
|
112659
|
-
*
|
|
112660
|
-
*
|
|
112567
|
+
* @remarks
|
|
112661
112568
|
* [Api set: 1.1]
|
|
112662
112569
|
*/
|
|
112663
112570
|
height?: boolean;
|
|
112664
112571
|
/**
|
|
112572
|
+
* For EACH ITEM in the collection: Index of the Page.
|
|
112665
112573
|
*
|
|
112666
|
-
*
|
|
112667
|
-
*
|
|
112574
|
+
* @remarks
|
|
112668
112575
|
* [Api set: 1.1]
|
|
112669
112576
|
*/
|
|
112670
112577
|
index?: boolean;
|
|
112671
112578
|
/**
|
|
112579
|
+
* For EACH ITEM in the collection: Whether the page is a background page or not.
|
|
112672
112580
|
*
|
|
112673
|
-
*
|
|
112674
|
-
*
|
|
112581
|
+
* @remarks
|
|
112675
112582
|
* [Api set: 1.1]
|
|
112676
112583
|
*/
|
|
112677
112584
|
isBackground?: boolean;
|
|
112678
112585
|
/**
|
|
112586
|
+
* For EACH ITEM in the collection: Page name.
|
|
112679
112587
|
*
|
|
112680
|
-
*
|
|
112681
|
-
*
|
|
112588
|
+
* @remarks
|
|
112682
112589
|
* [Api set: 1.1]
|
|
112683
112590
|
*/
|
|
112684
112591
|
name?: boolean;
|
|
112685
112592
|
/**
|
|
112593
|
+
* For EACH ITEM in the collection: Returns the width of the page.
|
|
112686
112594
|
*
|
|
112687
|
-
*
|
|
112688
|
-
*
|
|
112595
|
+
* @remarks
|
|
112689
112596
|
* [Api set: 1.1]
|
|
112690
112597
|
*/
|
|
112691
112598
|
width?: boolean;
|
|
112692
112599
|
}
|
|
112693
112600
|
/**
|
|
112694
|
-
*
|
|
112695
112601
|
* Represents the Shape Collection.
|
|
112696
112602
|
*
|
|
112603
|
+
* @remarks
|
|
112697
112604
|
* [Api set: 1.1]
|
|
112698
112605
|
*/
|
|
112699
112606
|
interface ShapeCollectionLoadOptions {
|
|
@@ -112702,52 +112609,45 @@ declare namespace Visio {
|
|
|
112702
112609
|
*/
|
|
112703
112610
|
$all?: boolean;
|
|
112704
112611
|
/**
|
|
112705
|
-
*
|
|
112706
112612
|
* For EACH ITEM in the collection: Returns the view of the shape.
|
|
112707
112613
|
*
|
|
112614
|
+
* @remarks
|
|
112708
112615
|
* [Api set: 1.1]
|
|
112709
112616
|
*/
|
|
112710
112617
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
112711
112618
|
/**
|
|
112619
|
+
* For EACH ITEM in the collection: Shape's identifier.
|
|
112712
112620
|
*
|
|
112713
|
-
*
|
|
112714
|
-
*
|
|
112621
|
+
* @remarks
|
|
112715
112622
|
* [Api set: 1.1]
|
|
112716
112623
|
*/
|
|
112717
112624
|
id?: boolean;
|
|
112718
112625
|
/**
|
|
112626
|
+
* For EACH ITEM in the collection: Shape's name.
|
|
112719
112627
|
*
|
|
112720
|
-
*
|
|
112721
|
-
*
|
|
112722
|
-
* [Api set: 1.1]
|
|
112723
|
-
*/
|
|
112724
|
-
isBoundToData?: boolean;
|
|
112725
|
-
/**
|
|
112726
|
-
*
|
|
112727
|
-
* For EACH ITEM in the collection: Shape's name. Read-only.
|
|
112728
|
-
*
|
|
112628
|
+
* @remarks
|
|
112729
112629
|
* [Api set: 1.1]
|
|
112730
112630
|
*/
|
|
112731
112631
|
name?: boolean;
|
|
112732
112632
|
/**
|
|
112733
|
-
*
|
|
112734
112633
|
* For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112735
112634
|
*
|
|
112635
|
+
* @remarks
|
|
112736
112636
|
* [Api set: 1.1]
|
|
112737
112637
|
*/
|
|
112738
112638
|
select?: boolean;
|
|
112739
112639
|
/**
|
|
112640
|
+
* For EACH ITEM in the collection: Shape's text.
|
|
112740
112641
|
*
|
|
112741
|
-
*
|
|
112742
|
-
*
|
|
112642
|
+
* @remarks
|
|
112743
112643
|
* [Api set: 1.1]
|
|
112744
112644
|
*/
|
|
112745
112645
|
text?: boolean;
|
|
112746
112646
|
}
|
|
112747
112647
|
/**
|
|
112748
|
-
*
|
|
112749
112648
|
* Represents the Shape class.
|
|
112750
112649
|
*
|
|
112650
|
+
* @remarks
|
|
112751
112651
|
* [Api set: 1.1]
|
|
112752
112652
|
*/
|
|
112753
112653
|
interface ShapeLoadOptions {
|
|
@@ -112756,52 +112656,45 @@ declare namespace Visio {
|
|
|
112756
112656
|
*/
|
|
112757
112657
|
$all?: boolean;
|
|
112758
112658
|
/**
|
|
112759
|
-
*
|
|
112760
112659
|
* Returns the view of the shape.
|
|
112761
112660
|
*
|
|
112661
|
+
* @remarks
|
|
112762
112662
|
* [Api set: 1.1]
|
|
112763
112663
|
*/
|
|
112764
112664
|
view?: Visio.Interfaces.ShapeViewLoadOptions;
|
|
112765
112665
|
/**
|
|
112666
|
+
* Shape's identifier.
|
|
112766
112667
|
*
|
|
112767
|
-
*
|
|
112768
|
-
*
|
|
112668
|
+
* @remarks
|
|
112769
112669
|
* [Api set: 1.1]
|
|
112770
112670
|
*/
|
|
112771
112671
|
id?: boolean;
|
|
112772
112672
|
/**
|
|
112673
|
+
* Shape's name.
|
|
112773
112674
|
*
|
|
112774
|
-
*
|
|
112775
|
-
*
|
|
112776
|
-
* [Api set: 1.1]
|
|
112777
|
-
*/
|
|
112778
|
-
isBoundToData?: boolean;
|
|
112779
|
-
/**
|
|
112780
|
-
*
|
|
112781
|
-
* Shape's name. Read-only.
|
|
112782
|
-
*
|
|
112675
|
+
* @remarks
|
|
112783
112676
|
* [Api set: 1.1]
|
|
112784
112677
|
*/
|
|
112785
112678
|
name?: boolean;
|
|
112786
112679
|
/**
|
|
112787
|
-
*
|
|
112788
112680
|
* Returns true, if shape is selected. User can set true to select the shape explicitly.
|
|
112789
112681
|
*
|
|
112682
|
+
* @remarks
|
|
112790
112683
|
* [Api set: 1.1]
|
|
112791
112684
|
*/
|
|
112792
112685
|
select?: boolean;
|
|
112793
112686
|
/**
|
|
112687
|
+
* Shape's text.
|
|
112794
112688
|
*
|
|
112795
|
-
*
|
|
112796
|
-
*
|
|
112689
|
+
* @remarks
|
|
112797
112690
|
* [Api set: 1.1]
|
|
112798
112691
|
*/
|
|
112799
112692
|
text?: boolean;
|
|
112800
112693
|
}
|
|
112801
112694
|
/**
|
|
112802
|
-
*
|
|
112803
112695
|
* Represents the ShapeView class.
|
|
112804
112696
|
*
|
|
112697
|
+
* @remarks
|
|
112805
112698
|
* [Api set: 1.1]
|
|
112806
112699
|
*/
|
|
112807
112700
|
interface ShapeViewLoadOptions {
|
|
@@ -112810,17 +112703,17 @@ declare namespace Visio {
|
|
|
112810
112703
|
*/
|
|
112811
112704
|
$all?: boolean;
|
|
112812
112705
|
/**
|
|
112813
|
-
*
|
|
112814
112706
|
* Represents the highlight around the shape.
|
|
112815
112707
|
*
|
|
112708
|
+
* @remarks
|
|
112816
112709
|
* [Api set: 1.1]
|
|
112817
112710
|
*/
|
|
112818
112711
|
highlight?: boolean;
|
|
112819
112712
|
}
|
|
112820
112713
|
/**
|
|
112821
|
-
*
|
|
112822
112714
|
* Represents the ShapeDataItemCollection for a given Shape.
|
|
112823
112715
|
*
|
|
112716
|
+
* @remarks
|
|
112824
112717
|
* [Api set: 1.1]
|
|
112825
112718
|
*/
|
|
112826
112719
|
interface ShapeDataItemCollectionLoadOptions {
|
|
@@ -112829,38 +112722,38 @@ declare namespace Visio {
|
|
|
112829
112722
|
*/
|
|
112830
112723
|
$all?: boolean;
|
|
112831
112724
|
/**
|
|
112725
|
+
* For EACH ITEM in the collection: A string that specifies the format of the shape data item.
|
|
112832
112726
|
*
|
|
112833
|
-
*
|
|
112834
|
-
*
|
|
112727
|
+
* @remarks
|
|
112835
112728
|
* [Api set: 1.1]
|
|
112836
112729
|
*/
|
|
112837
112730
|
format?: boolean;
|
|
112838
112731
|
/**
|
|
112732
|
+
* For EACH ITEM in the collection: A string that specifies the formatted value of the shape data item.
|
|
112839
112733
|
*
|
|
112840
|
-
*
|
|
112841
|
-
*
|
|
112734
|
+
* @remarks
|
|
112842
112735
|
* [Api set: 1.1]
|
|
112843
112736
|
*/
|
|
112844
112737
|
formattedValue?: boolean;
|
|
112845
112738
|
/**
|
|
112739
|
+
* For EACH ITEM in the collection: A string that specifies the label of the shape data item.
|
|
112846
112740
|
*
|
|
112847
|
-
*
|
|
112848
|
-
*
|
|
112741
|
+
* @remarks
|
|
112849
112742
|
* [Api set: 1.1]
|
|
112850
112743
|
*/
|
|
112851
112744
|
label?: boolean;
|
|
112852
112745
|
/**
|
|
112746
|
+
* For EACH ITEM in the collection: A string that specifies the value of the shape data item.
|
|
112853
112747
|
*
|
|
112854
|
-
*
|
|
112855
|
-
*
|
|
112748
|
+
* @remarks
|
|
112856
112749
|
* [Api set: 1.1]
|
|
112857
112750
|
*/
|
|
112858
112751
|
value?: boolean;
|
|
112859
112752
|
}
|
|
112860
112753
|
/**
|
|
112861
|
-
*
|
|
112862
112754
|
* Represents the ShapeDataItem.
|
|
112863
112755
|
*
|
|
112756
|
+
* @remarks
|
|
112864
112757
|
* [Api set: 1.1]
|
|
112865
112758
|
*/
|
|
112866
112759
|
interface ShapeDataItemLoadOptions {
|
|
@@ -112869,38 +112762,38 @@ declare namespace Visio {
|
|
|
112869
112762
|
*/
|
|
112870
112763
|
$all?: boolean;
|
|
112871
112764
|
/**
|
|
112765
|
+
* A string that specifies the format of the shape data item.
|
|
112872
112766
|
*
|
|
112873
|
-
*
|
|
112874
|
-
*
|
|
112767
|
+
* @remarks
|
|
112875
112768
|
* [Api set: 1.1]
|
|
112876
112769
|
*/
|
|
112877
112770
|
format?: boolean;
|
|
112878
112771
|
/**
|
|
112772
|
+
* A string that specifies the formatted value of the shape data item.
|
|
112879
112773
|
*
|
|
112880
|
-
*
|
|
112881
|
-
*
|
|
112774
|
+
* @remarks
|
|
112882
112775
|
* [Api set: 1.1]
|
|
112883
112776
|
*/
|
|
112884
112777
|
formattedValue?: boolean;
|
|
112885
112778
|
/**
|
|
112779
|
+
* A string that specifies the label of the shape data item.
|
|
112886
112780
|
*
|
|
112887
|
-
*
|
|
112888
|
-
*
|
|
112781
|
+
* @remarks
|
|
112889
112782
|
* [Api set: 1.1]
|
|
112890
112783
|
*/
|
|
112891
112784
|
label?: boolean;
|
|
112892
112785
|
/**
|
|
112786
|
+
* A string that specifies the value of the shape data item.
|
|
112893
112787
|
*
|
|
112894
|
-
*
|
|
112895
|
-
*
|
|
112788
|
+
* @remarks
|
|
112896
112789
|
* [Api set: 1.1]
|
|
112897
112790
|
*/
|
|
112898
112791
|
value?: boolean;
|
|
112899
112792
|
}
|
|
112900
112793
|
/**
|
|
112901
|
-
*
|
|
112902
112794
|
* Represents the Hyperlink Collection.
|
|
112903
112795
|
*
|
|
112796
|
+
* @remarks
|
|
112904
112797
|
* [Api set: 1.1]
|
|
112905
112798
|
*/
|
|
112906
112799
|
interface HyperlinkCollectionLoadOptions {
|
|
@@ -112909,38 +112802,38 @@ declare namespace Visio {
|
|
|
112909
112802
|
*/
|
|
112910
112803
|
$all?: boolean;
|
|
112911
112804
|
/**
|
|
112805
|
+
* For EACH ITEM in the collection: Gets the address of the Hyperlink object.
|
|
112912
112806
|
*
|
|
112913
|
-
*
|
|
112914
|
-
*
|
|
112807
|
+
* @remarks
|
|
112915
112808
|
* [Api set: 1.1]
|
|
112916
112809
|
*/
|
|
112917
112810
|
address?: boolean;
|
|
112918
112811
|
/**
|
|
112812
|
+
* For EACH ITEM in the collection: Gets the description of a hyperlink.
|
|
112919
112813
|
*
|
|
112920
|
-
*
|
|
112921
|
-
*
|
|
112814
|
+
* @remarks
|
|
112922
112815
|
* [Api set: 1.1]
|
|
112923
112816
|
*/
|
|
112924
112817
|
description?: boolean;
|
|
112925
112818
|
/**
|
|
112819
|
+
* For EACH ITEM in the collection: Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
112926
112820
|
*
|
|
112927
|
-
*
|
|
112928
|
-
*
|
|
112821
|
+
* @remarks
|
|
112929
112822
|
* [Api set: 1.1]
|
|
112930
112823
|
*/
|
|
112931
112824
|
extraInfo?: boolean;
|
|
112932
112825
|
/**
|
|
112826
|
+
* For EACH ITEM in the collection: Gets the sub-address of the Hyperlink object.
|
|
112933
112827
|
*
|
|
112934
|
-
*
|
|
112935
|
-
*
|
|
112828
|
+
* @remarks
|
|
112936
112829
|
* [Api set: 1.1]
|
|
112937
112830
|
*/
|
|
112938
112831
|
subAddress?: boolean;
|
|
112939
112832
|
}
|
|
112940
112833
|
/**
|
|
112941
|
-
*
|
|
112942
112834
|
* Represents the Hyperlink.
|
|
112943
112835
|
*
|
|
112836
|
+
* @remarks
|
|
112944
112837
|
* [Api set: 1.1]
|
|
112945
112838
|
*/
|
|
112946
112839
|
interface HyperlinkLoadOptions {
|
|
@@ -112949,38 +112842,38 @@ declare namespace Visio {
|
|
|
112949
112842
|
*/
|
|
112950
112843
|
$all?: boolean;
|
|
112951
112844
|
/**
|
|
112845
|
+
* Gets the address of the Hyperlink object.
|
|
112952
112846
|
*
|
|
112953
|
-
*
|
|
112954
|
-
*
|
|
112847
|
+
* @remarks
|
|
112955
112848
|
* [Api set: 1.1]
|
|
112956
112849
|
*/
|
|
112957
112850
|
address?: boolean;
|
|
112958
112851
|
/**
|
|
112852
|
+
* Gets the description of a hyperlink.
|
|
112959
112853
|
*
|
|
112960
|
-
*
|
|
112961
|
-
*
|
|
112854
|
+
* @remarks
|
|
112962
112855
|
* [Api set: 1.1]
|
|
112963
112856
|
*/
|
|
112964
112857
|
description?: boolean;
|
|
112965
112858
|
/**
|
|
112859
|
+
* Gets the extra URL request information used to resolve the hyperlink's URL.
|
|
112966
112860
|
*
|
|
112967
|
-
*
|
|
112968
|
-
*
|
|
112861
|
+
* @remarks
|
|
112969
112862
|
* [Api set: 1.1]
|
|
112970
112863
|
*/
|
|
112971
112864
|
extraInfo?: boolean;
|
|
112972
112865
|
/**
|
|
112866
|
+
* Gets the sub-address of the Hyperlink object.
|
|
112973
112867
|
*
|
|
112974
|
-
*
|
|
112975
|
-
*
|
|
112868
|
+
* @remarks
|
|
112976
112869
|
* [Api set: 1.1]
|
|
112977
112870
|
*/
|
|
112978
112871
|
subAddress?: boolean;
|
|
112979
112872
|
}
|
|
112980
112873
|
/**
|
|
112981
|
-
*
|
|
112982
112874
|
* Represents the CommentCollection for a given Shape.
|
|
112983
112875
|
*
|
|
112876
|
+
* @remarks
|
|
112984
112877
|
* [Api set: 1.1]
|
|
112985
112878
|
*/
|
|
112986
112879
|
interface CommentCollectionLoadOptions {
|
|
@@ -112989,31 +112882,31 @@ declare namespace Visio {
|
|
|
112989
112882
|
*/
|
|
112990
112883
|
$all?: boolean;
|
|
112991
112884
|
/**
|
|
112992
|
-
*
|
|
112993
112885
|
* For EACH ITEM in the collection: A string that specifies the name of the author of the comment.
|
|
112994
112886
|
*
|
|
112887
|
+
* @remarks
|
|
112995
112888
|
* [Api set: 1.1]
|
|
112996
112889
|
*/
|
|
112997
112890
|
author?: boolean;
|
|
112998
112891
|
/**
|
|
112999
|
-
*
|
|
113000
112892
|
* For EACH ITEM in the collection: A string that specifies the date when the comment was created.
|
|
113001
112893
|
*
|
|
112894
|
+
* @remarks
|
|
113002
112895
|
* [Api set: 1.1]
|
|
113003
112896
|
*/
|
|
113004
112897
|
date?: boolean;
|
|
113005
112898
|
/**
|
|
113006
|
-
*
|
|
113007
112899
|
* For EACH ITEM in the collection: A string that contains the comment text.
|
|
113008
112900
|
*
|
|
112901
|
+
* @remarks
|
|
113009
112902
|
* [Api set: 1.1]
|
|
113010
112903
|
*/
|
|
113011
112904
|
text?: boolean;
|
|
113012
112905
|
}
|
|
113013
112906
|
/**
|
|
113014
|
-
*
|
|
113015
112907
|
* Represents the Comment.
|
|
113016
112908
|
*
|
|
112909
|
+
* @remarks
|
|
113017
112910
|
* [Api set: 1.1]
|
|
113018
112911
|
*/
|
|
113019
112912
|
interface CommentLoadOptions {
|
|
@@ -113022,23 +112915,23 @@ declare namespace Visio {
|
|
|
113022
112915
|
*/
|
|
113023
112916
|
$all?: boolean;
|
|
113024
112917
|
/**
|
|
113025
|
-
*
|
|
113026
112918
|
* A string that specifies the name of the author of the comment.
|
|
113027
112919
|
*
|
|
112920
|
+
* @remarks
|
|
113028
112921
|
* [Api set: 1.1]
|
|
113029
112922
|
*/
|
|
113030
112923
|
author?: boolean;
|
|
113031
112924
|
/**
|
|
113032
|
-
*
|
|
113033
112925
|
* A string that specifies the date when the comment was created.
|
|
113034
112926
|
*
|
|
112927
|
+
* @remarks
|
|
113035
112928
|
* [Api set: 1.1]
|
|
113036
112929
|
*/
|
|
113037
112930
|
date?: boolean;
|
|
113038
112931
|
/**
|
|
113039
|
-
*
|
|
113040
112932
|
* A string that contains the comment text.
|
|
113041
112933
|
*
|
|
112934
|
+
* @remarks
|
|
113042
112935
|
* [Api set: 1.1]
|
|
113043
112936
|
*/
|
|
113044
112937
|
text?: boolean;
|
|
@@ -113074,19 +112967,12 @@ declare namespace Visio {
|
|
|
113074
112967
|
* Executes a batch script that performs actions on the Visio object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
113075
112968
|
* @param contextObject - A previously-created Visio.RequestContext. This context will get re-used by the batch function (instead of having a new context created). This means that the batch will be able to pick up changes made to existing API objects, if those objects were derived from this same context.
|
|
113076
112969
|
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Visio application. Since the Office add-in and the Visio application run in two different processes, the RequestContext is required to get access to the Visio object model from the add-in.
|
|
113077
|
-
* @remarks
|
|
113078
|
-
* In addition to this signature, the method also has the following signatures:
|
|
113079
|
-
*
|
|
113080
|
-
* `run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113081
|
-
*
|
|
113082
|
-
* `run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113083
|
-
*
|
|
113084
|
-
* `run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;`
|
|
113085
112970
|
*/
|
|
113086
112971
|
function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;
|
|
113087
112972
|
}
|
|
113088
112973
|
|
|
113089
112974
|
|
|
112975
|
+
|
|
113090
112976
|
////////////////////////////////////////////////////////////////
|
|
113091
112977
|
//////////////////////// End Visio APIs ////////////////////////
|
|
113092
112978
|
////////////////////////////////////////////////////////////////
|