@openfin/fdc3-api 36.80.26 → 37.80.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/fdc3-api-alpha.d.ts +1109 -248
- package/out/fdc3-api-beta.d.ts +1109 -248
- package/out/fdc3-api-public.d.ts +1109 -248
- package/out/fdc3-api.d.ts +1112 -247
- package/package.json +1 -1
package/out/fdc3-api.d.ts
CHANGED
|
@@ -42,15 +42,6 @@ declare type Accelerator = {
|
|
|
42
42
|
zoom: boolean;
|
|
43
43
|
};
|
|
44
44
|
|
|
45
|
-
/**
|
|
46
|
-
* Generated when a View is added to a layout.
|
|
47
|
-
* @interface
|
|
48
|
-
*/
|
|
49
|
-
declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
50
|
-
type: 'added-to-layout';
|
|
51
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
52
|
-
};
|
|
53
|
-
|
|
54
45
|
/**
|
|
55
46
|
* Options to use when adding a view to a {@link TabStack}.
|
|
56
47
|
*
|
|
@@ -85,42 +76,14 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
|
|
|
85
76
|
|
|
86
77
|
declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
|
|
87
78
|
|
|
88
|
-
/**
|
|
89
|
-
* @deprecated Renamed to {@link ApiSettings}.
|
|
90
|
-
*/
|
|
91
|
-
declare type Api = ApiSettings;
|
|
92
|
-
|
|
93
|
-
declare type ApiCall<Request, Response> = {
|
|
94
|
-
request: Request;
|
|
95
|
-
response: Response;
|
|
96
|
-
};
|
|
97
|
-
|
|
98
|
-
declare type ApiClient<T extends Record<any, any>> = {
|
|
99
|
-
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
|
100
|
-
};
|
|
101
|
-
|
|
102
|
-
/**
|
|
103
|
-
* @deprecated Renamed to {@link DomainApiSettings}.
|
|
104
|
-
*/
|
|
105
|
-
declare type ApiInjection = DomainApiSettings;
|
|
106
|
-
|
|
107
|
-
/**
|
|
108
|
-
* Generated when a new Platform's API becomes responsive.
|
|
109
|
-
* @interface
|
|
110
|
-
*/
|
|
111
|
-
declare type ApiReadyEvent = BaseEvents.BaseEvent & {
|
|
112
|
-
topic: 'application';
|
|
113
|
-
type: 'platform-api-ready';
|
|
114
|
-
};
|
|
115
|
-
|
|
116
79
|
/**
|
|
117
80
|
* Configurations for API injection.
|
|
118
81
|
*
|
|
119
82
|
* @interface
|
|
120
83
|
*/
|
|
121
|
-
declare type
|
|
84
|
+
declare type Api = {
|
|
122
85
|
/**
|
|
123
|
-
* Configure
|
|
86
|
+
* Configure injection of OpenFin API into iframes based on domain
|
|
124
87
|
*/
|
|
125
88
|
iframe?: {
|
|
126
89
|
/**
|
|
@@ -151,6 +114,41 @@ declare type ApiSettings = {
|
|
|
151
114
|
fin?: InjectionType;
|
|
152
115
|
};
|
|
153
116
|
|
|
117
|
+
declare type ApiCall<Request, Response> = {
|
|
118
|
+
request: Request;
|
|
119
|
+
response: Response;
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
declare type ApiClient<T extends Record<any, any>> = {
|
|
123
|
+
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
|
124
|
+
};
|
|
125
|
+
|
|
126
|
+
/**
|
|
127
|
+
* @interface
|
|
128
|
+
*
|
|
129
|
+
* Rules for domain-conditional `fin` API injection.
|
|
130
|
+
*/
|
|
131
|
+
declare type ApiInjection = {
|
|
132
|
+
/**
|
|
133
|
+
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
134
|
+
*
|
|
135
|
+
* * 'none': The `fin` API will be not available.
|
|
136
|
+
* * 'global': The entire `fin` API will be available.
|
|
137
|
+
*
|
|
138
|
+
* @defaultValue 'global'
|
|
139
|
+
*/
|
|
140
|
+
fin: InjectionType;
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Generated when a new Platform's API becomes responsive.
|
|
145
|
+
* @interface
|
|
146
|
+
*/
|
|
147
|
+
declare type ApiReadyEvent = BaseEvent & {
|
|
148
|
+
topic: 'application';
|
|
149
|
+
type: 'platform-api-ready';
|
|
150
|
+
};
|
|
151
|
+
|
|
154
152
|
/**
|
|
155
153
|
* @interface
|
|
156
154
|
*/
|
|
@@ -951,7 +949,7 @@ declare namespace ApplicationEvents {
|
|
|
951
949
|
PropagatedApplicationEvent,
|
|
952
950
|
PropagatedEventType_3 as PropagatedEventType,
|
|
953
951
|
PropagatedApplicationEventType,
|
|
954
|
-
|
|
952
|
+
Payload_4 as Payload,
|
|
955
953
|
ByType_3 as ByType
|
|
956
954
|
}
|
|
957
955
|
}
|
|
@@ -974,7 +972,7 @@ declare type ApplicationIdentity_2 = {
|
|
|
974
972
|
* @interface
|
|
975
973
|
*/
|
|
976
974
|
declare type ApplicationInfo = {
|
|
977
|
-
initialOptions: ApplicationCreationOptions
|
|
975
|
+
initialOptions: ApplicationCreationOptions;
|
|
978
976
|
launchMode: string;
|
|
979
977
|
manifest: Manifest & {
|
|
980
978
|
[key: string]: any;
|
|
@@ -1193,14 +1191,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1193
1191
|
*/
|
|
1194
1192
|
mainWindowOptions: WindowCreationOptions;
|
|
1195
1193
|
/**
|
|
1196
|
-
* The name of the application.
|
|
1197
|
-
*
|
|
1198
|
-
* @remarks
|
|
1199
|
-
* This property is used for naming the application logging folder, which will be sanitized to remove
|
|
1200
|
-
* any special characters, spaces or international characters. It's also used in error messages, API
|
|
1201
|
-
* security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
|
|
1194
|
+
* The name of the application (and the application's main window).
|
|
1202
1195
|
*
|
|
1203
|
-
*
|
|
1196
|
+
* If provided, _must_ match `uuid`.
|
|
1204
1197
|
*/
|
|
1205
1198
|
name: string;
|
|
1206
1199
|
/**
|
|
@@ -1230,7 +1223,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1230
1223
|
url: string;
|
|
1231
1224
|
/**
|
|
1232
1225
|
* The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
|
|
1233
|
-
*
|
|
1226
|
+
* running in the OpenFin Runtime.
|
|
1227
|
+
*
|
|
1228
|
+
* Note that `name` and `uuid` must match.
|
|
1234
1229
|
*/
|
|
1235
1230
|
uuid: string;
|
|
1236
1231
|
/**
|
|
@@ -1291,10 +1286,6 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1291
1286
|
* Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
|
|
1292
1287
|
*/
|
|
1293
1288
|
domainSettings: DomainSettings;
|
|
1294
|
-
/**
|
|
1295
|
-
* The permissions for secured APIs.
|
|
1296
|
-
*/
|
|
1297
|
-
permissions?: Partial<Permissions_2>;
|
|
1298
1289
|
/**
|
|
1299
1290
|
* @defaultValue false
|
|
1300
1291
|
*
|
|
@@ -1816,7 +1807,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
|
1816
1807
|
* A base Channel event.
|
|
1817
1808
|
* @interface
|
|
1818
1809
|
*/
|
|
1819
|
-
declare type BaseEvent_2 =
|
|
1810
|
+
declare type BaseEvent_2 = NamedEvent & {
|
|
1820
1811
|
channelName: string;
|
|
1821
1812
|
channelId: string;
|
|
1822
1813
|
};
|
|
@@ -1886,7 +1877,6 @@ declare namespace BaseEvents {
|
|
|
1886
1877
|
NotCloseRequested,
|
|
1887
1878
|
PropagatedEventType,
|
|
1888
1879
|
PropagatedEvent,
|
|
1889
|
-
Payload_2 as Payload,
|
|
1890
1880
|
EventHandler,
|
|
1891
1881
|
BaseEvent,
|
|
1892
1882
|
IdentityEvent,
|
|
@@ -2020,6 +2010,48 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
|
2020
2010
|
behavior: 'browser';
|
|
2021
2011
|
};
|
|
2022
2012
|
|
|
2013
|
+
declare interface BrowserWindow {
|
|
2014
|
+
/**
|
|
2015
|
+
* True if the window has been opened and its GoldenLayout instance initialised.
|
|
2016
|
+
*/
|
|
2017
|
+
isInitialised: boolean;
|
|
2018
|
+
|
|
2019
|
+
/**
|
|
2020
|
+
* Creates a window configuration object from the Popout.
|
|
2021
|
+
*/
|
|
2022
|
+
toConfig(): {
|
|
2023
|
+
dimensions: {
|
|
2024
|
+
width: number;
|
|
2025
|
+
height: number;
|
|
2026
|
+
left: number;
|
|
2027
|
+
top: number;
|
|
2028
|
+
};
|
|
2029
|
+
content: Config;
|
|
2030
|
+
parentId: string;
|
|
2031
|
+
indexInParent: number;
|
|
2032
|
+
};
|
|
2033
|
+
|
|
2034
|
+
/**
|
|
2035
|
+
* Returns the GoldenLayout instance from the child window
|
|
2036
|
+
*/
|
|
2037
|
+
getGlInstance(): GoldenLayout_2;
|
|
2038
|
+
|
|
2039
|
+
/**
|
|
2040
|
+
* Returns the native Window object
|
|
2041
|
+
*/
|
|
2042
|
+
getWindow(): Window;
|
|
2043
|
+
|
|
2044
|
+
/**
|
|
2045
|
+
* Closes the popout
|
|
2046
|
+
*/
|
|
2047
|
+
close(): void;
|
|
2048
|
+
|
|
2049
|
+
/**
|
|
2050
|
+
* Returns the popout to its original position as specified in parentId and indexInParent
|
|
2051
|
+
*/
|
|
2052
|
+
popIn(): void;
|
|
2053
|
+
}
|
|
2054
|
+
|
|
2023
2055
|
/**
|
|
2024
2056
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
2025
2057
|
*
|
|
@@ -2027,7 +2059,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
|
2027
2059
|
*
|
|
2028
2060
|
* @typeParam Type String key specifying the event to extract
|
|
2029
2061
|
*/
|
|
2030
|
-
declare type ByType<Type extends EventType> =
|
|
2062
|
+
declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
2031
2063
|
|
|
2032
2064
|
/**
|
|
2033
2065
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
@@ -2036,7 +2068,7 @@ declare type ByType<Type extends EventType> = Payload_3<Type>;
|
|
|
2036
2068
|
*
|
|
2037
2069
|
* @typeParam Type String key specifying the event to extract
|
|
2038
2070
|
*/
|
|
2039
|
-
declare type ByType_2<Type extends EventType_2> =
|
|
2071
|
+
declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
2040
2072
|
|
|
2041
2073
|
/**
|
|
2042
2074
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
@@ -2045,7 +2077,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
|
|
2045
2077
|
*
|
|
2046
2078
|
* @typeParam Type String key specifying the event to extract
|
|
2047
2079
|
*/
|
|
2048
|
-
declare type ByType_3<Type extends EventType_3> =
|
|
2080
|
+
declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
2049
2081
|
|
|
2050
2082
|
/**
|
|
2051
2083
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
@@ -2054,7 +2086,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
|
|
2054
2086
|
*
|
|
2055
2087
|
* @typeParam Type String key specifying the event to extract
|
|
2056
2088
|
*/
|
|
2057
|
-
declare type ByType_4<Type extends EventType_4> =
|
|
2089
|
+
declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
2058
2090
|
|
|
2059
2091
|
/**
|
|
2060
2092
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
@@ -2063,7 +2095,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
|
|
2063
2095
|
*
|
|
2064
2096
|
* @typeParam Type String key specifying the event to extract
|
|
2065
2097
|
*/
|
|
2066
|
-
declare type ByType_5<Type extends EventType_5> =
|
|
2098
|
+
declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
2067
2099
|
|
|
2068
2100
|
/**
|
|
2069
2101
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
@@ -2072,7 +2104,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
|
|
2072
2104
|
*
|
|
2073
2105
|
* @typeParam Type String key specifying the event to extract
|
|
2074
2106
|
*/
|
|
2075
|
-
declare type ByType_6<Type extends EventType_6> =
|
|
2107
|
+
declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2076
2108
|
|
|
2077
2109
|
/**
|
|
2078
2110
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
@@ -2081,7 +2113,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
|
|
2081
2113
|
*
|
|
2082
2114
|
* @typeParam Type String key specifying the event to extract
|
|
2083
2115
|
*/
|
|
2084
|
-
declare type ByType_7<Type extends EventType_7> =
|
|
2116
|
+
declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2085
2117
|
|
|
2086
2118
|
/**
|
|
2087
2119
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
@@ -2090,7 +2122,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
|
|
2090
2122
|
*
|
|
2091
2123
|
* @typeParam Type String key specifying the event to extract
|
|
2092
2124
|
*/
|
|
2093
|
-
declare type ByType_8<Type extends EventType_8> =
|
|
2125
|
+
declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2094
2126
|
|
|
2095
2127
|
/**
|
|
2096
2128
|
* Configuration for page capture.
|
|
@@ -3462,6 +3494,31 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
|
|
|
3462
3494
|
close(): Promise<void>;
|
|
3463
3495
|
}
|
|
3464
3496
|
|
|
3497
|
+
declare interface ComponentConfig extends ItemConfig {
|
|
3498
|
+
/**
|
|
3499
|
+
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
|
|
3500
|
+
*/
|
|
3501
|
+
componentName: string;
|
|
3502
|
+
|
|
3503
|
+
/**
|
|
3504
|
+
* A serialisable object. Will be passed to the component constructor function and will be the value returned by
|
|
3505
|
+
* container.getState().
|
|
3506
|
+
*/
|
|
3507
|
+
componentState?: any;
|
|
3508
|
+
}
|
|
3509
|
+
|
|
3510
|
+
declare interface Config {
|
|
3511
|
+
settings?: Settings;
|
|
3512
|
+
dimensions?: Dimensions;
|
|
3513
|
+
labels?: Labels;
|
|
3514
|
+
content?: ItemConfigType[];
|
|
3515
|
+
/**
|
|
3516
|
+
* (Only on layout config object)
|
|
3517
|
+
* Id of the currently maximised content item
|
|
3518
|
+
*/
|
|
3519
|
+
maximisedItemId?: string;
|
|
3520
|
+
}
|
|
3521
|
+
|
|
3465
3522
|
declare type ConfigWithRuntime = BaseConfig & {
|
|
3466
3523
|
runtime: RuntimeConfig;
|
|
3467
3524
|
};
|
|
@@ -3516,7 +3573,7 @@ declare type ConstViewOptions = {
|
|
|
3516
3573
|
/**
|
|
3517
3574
|
* Configurations for API injection.
|
|
3518
3575
|
*/
|
|
3519
|
-
api:
|
|
3576
|
+
api: Api;
|
|
3520
3577
|
/**
|
|
3521
3578
|
* The name of the view.
|
|
3522
3579
|
*/
|
|
@@ -3749,9 +3806,7 @@ declare type ConstWindowOptions = {
|
|
|
3749
3806
|
*/
|
|
3750
3807
|
preloadScripts: PreloadScript[];
|
|
3751
3808
|
/**
|
|
3752
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3753
|
-
* However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
|
|
3754
|
-
* @remarks Will only be used if pages are on the same origin.
|
|
3809
|
+
* String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
|
|
3755
3810
|
*/
|
|
3756
3811
|
processAffinity: string;
|
|
3757
3812
|
/**
|
|
@@ -3835,18 +3890,106 @@ declare type ConstWindowOptions = {
|
|
|
3835
3890
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
3836
3891
|
*/
|
|
3837
3892
|
viewVisibility?: ViewVisibilityOptions;
|
|
3893
|
+
};
|
|
3894
|
+
|
|
3895
|
+
declare interface Container extends EventEmitter_2 {
|
|
3838
3896
|
/**
|
|
3839
|
-
*
|
|
3897
|
+
* The current width of the container in pixel
|
|
3840
3898
|
*/
|
|
3841
|
-
|
|
3842
|
-
|
|
3899
|
+
width: number;
|
|
3900
|
+
|
|
3901
|
+
/**
|
|
3902
|
+
* The current height of the container in pixel
|
|
3903
|
+
*/
|
|
3904
|
+
height: number;
|
|
3843
3905
|
|
|
3844
|
-
|
|
3906
|
+
/**
|
|
3907
|
+
* A reference to the component-item that controls this container
|
|
3908
|
+
*/
|
|
3909
|
+
parent: ContentItem;
|
|
3845
3910
|
|
|
3846
|
-
/**
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3911
|
+
/**
|
|
3912
|
+
* A reference to the tab that controls this container. Will initially be null
|
|
3913
|
+
* (and populated once a tab event has been fired).
|
|
3914
|
+
*/
|
|
3915
|
+
tab: Tab;
|
|
3916
|
+
|
|
3917
|
+
/**
|
|
3918
|
+
* The current title of the container
|
|
3919
|
+
*/
|
|
3920
|
+
title: string;
|
|
3921
|
+
|
|
3922
|
+
/*
|
|
3923
|
+
* A reference to the GoldenLayout instance this container belongs to
|
|
3924
|
+
*/
|
|
3925
|
+
layoutManager: GoldenLayout_2;
|
|
3926
|
+
|
|
3927
|
+
/**
|
|
3928
|
+
* True if the item is currently hidden
|
|
3929
|
+
*/
|
|
3930
|
+
isHidden: boolean;
|
|
3931
|
+
|
|
3932
|
+
/**
|
|
3933
|
+
* Overwrites the components state with the provided value. To only change parts of the componentState see
|
|
3934
|
+
* extendState below. This is the main mechanism for saving the state of a component. This state will be the
|
|
3935
|
+
* value of componentState when layout.toConfig() is called and will be passed back to the component's
|
|
3936
|
+
* constructor function. It will also be used when the component is opened in a new window.
|
|
3937
|
+
* @param state A serialisable object
|
|
3938
|
+
*/
|
|
3939
|
+
setState(state: any): void;
|
|
3940
|
+
|
|
3941
|
+
/**
|
|
3942
|
+
* The same as setState but does not emit 'stateChanged' event
|
|
3943
|
+
* @param {serialisable} state
|
|
3944
|
+
*/
|
|
3945
|
+
setStateSkipEvent(state: any): void;
|
|
3946
|
+
|
|
3947
|
+
/**
|
|
3948
|
+
* This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
|
|
3949
|
+
* @param state A serialisable object
|
|
3950
|
+
*/
|
|
3951
|
+
extendState(state: any): void;
|
|
3952
|
+
|
|
3953
|
+
/**
|
|
3954
|
+
* Returns the current state.
|
|
3955
|
+
*/
|
|
3956
|
+
getState(): any;
|
|
3957
|
+
|
|
3958
|
+
/**
|
|
3959
|
+
* Returns the container's inner element as a jQuery element
|
|
3960
|
+
*/
|
|
3961
|
+
getElement(): JQuery;
|
|
3962
|
+
|
|
3963
|
+
/**
|
|
3964
|
+
* hides the container or returns false if hiding it is not possible
|
|
3965
|
+
*/
|
|
3966
|
+
hide(): boolean;
|
|
3967
|
+
|
|
3968
|
+
/**
|
|
3969
|
+
* shows the container or returns false if showing it is not possible
|
|
3970
|
+
*/
|
|
3971
|
+
show(): boolean;
|
|
3972
|
+
|
|
3973
|
+
/**
|
|
3974
|
+
* Sets the container to the specified size or returns false if that's not possible
|
|
3975
|
+
* @param width the new width in pixel
|
|
3976
|
+
* @param height the new height in pixel
|
|
3977
|
+
*/
|
|
3978
|
+
setSize(width: number, height: number): boolean;
|
|
3979
|
+
|
|
3980
|
+
/**
|
|
3981
|
+
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
3982
|
+
* @param title the new title
|
|
3983
|
+
*/
|
|
3984
|
+
setTitle(title: string): void;
|
|
3985
|
+
|
|
3986
|
+
/**
|
|
3987
|
+
* Closes the container or returns false if that is not possible
|
|
3988
|
+
*/
|
|
3989
|
+
close(): boolean;
|
|
3990
|
+
}
|
|
3991
|
+
|
|
3992
|
+
declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
|
|
3850
3993
|
|
|
3851
3994
|
/**
|
|
3852
3995
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
@@ -3870,7 +4013,7 @@ declare type ContentCreationOptions = {
|
|
|
3870
4013
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
|
3871
4014
|
* the specified `behavior` key.
|
|
3872
4015
|
*/
|
|
3873
|
-
declare type ContentCreationRule<Behavior extends
|
|
4016
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
|
3874
4017
|
behavior: Behavior;
|
|
3875
4018
|
}>;
|
|
3876
4019
|
|
|
@@ -3903,6 +4046,218 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3903
4046
|
disposition: string;
|
|
3904
4047
|
};
|
|
3905
4048
|
|
|
4049
|
+
declare interface ContentItem extends EventEmitter_2 {
|
|
4050
|
+
instance: any;
|
|
4051
|
+
header: any;
|
|
4052
|
+
_splitter: any;
|
|
4053
|
+
/**
|
|
4054
|
+
* This items configuration in its current state
|
|
4055
|
+
*/
|
|
4056
|
+
config: ItemConfigType;
|
|
4057
|
+
|
|
4058
|
+
/**
|
|
4059
|
+
* The type of the item. Can be row, column, stack, component or root
|
|
4060
|
+
*/
|
|
4061
|
+
type: ItemType;
|
|
4062
|
+
|
|
4063
|
+
/**
|
|
4064
|
+
* An array of items that are children of this item
|
|
4065
|
+
*/
|
|
4066
|
+
contentItems: ContentItem[];
|
|
4067
|
+
|
|
4068
|
+
container: Container;
|
|
4069
|
+
/**
|
|
4070
|
+
* The item that is this item's parent (or null if the item is root)
|
|
4071
|
+
*/
|
|
4072
|
+
parent: ContentItem;
|
|
4073
|
+
|
|
4074
|
+
/**
|
|
4075
|
+
* A String or array of identifiers if provided in the configuration
|
|
4076
|
+
*/
|
|
4077
|
+
id: string;
|
|
4078
|
+
|
|
4079
|
+
/**
|
|
4080
|
+
* True if the item had been initialised
|
|
4081
|
+
*/
|
|
4082
|
+
isInitialised: boolean;
|
|
4083
|
+
|
|
4084
|
+
/**
|
|
4085
|
+
* True if the item is maximised
|
|
4086
|
+
*/
|
|
4087
|
+
isMaximised: boolean;
|
|
4088
|
+
|
|
4089
|
+
/**
|
|
4090
|
+
* True if the item is the layout's root item
|
|
4091
|
+
*/
|
|
4092
|
+
isRoot: boolean;
|
|
4093
|
+
|
|
4094
|
+
/**
|
|
4095
|
+
* True if the item is a row
|
|
4096
|
+
*/
|
|
4097
|
+
isRow: boolean;
|
|
4098
|
+
|
|
4099
|
+
/**
|
|
4100
|
+
* True if the item is a column
|
|
4101
|
+
*/
|
|
4102
|
+
isColumn: boolean;
|
|
4103
|
+
|
|
4104
|
+
/**
|
|
4105
|
+
* True if the item is a stack
|
|
4106
|
+
*/
|
|
4107
|
+
isStack: boolean;
|
|
4108
|
+
|
|
4109
|
+
/**
|
|
4110
|
+
* True if the item is a component
|
|
4111
|
+
*/
|
|
4112
|
+
isComponent: boolean;
|
|
4113
|
+
|
|
4114
|
+
/**
|
|
4115
|
+
* A reference to the layoutManager that controls this item
|
|
4116
|
+
*/
|
|
4117
|
+
layoutManager: any;
|
|
4118
|
+
|
|
4119
|
+
/**
|
|
4120
|
+
* The item's outer element
|
|
4121
|
+
*/
|
|
4122
|
+
element: JQuery;
|
|
4123
|
+
|
|
4124
|
+
/**
|
|
4125
|
+
* The item's inner element. Can be the same as the outer element.
|
|
4126
|
+
*/
|
|
4127
|
+
childElementContainer: Container;
|
|
4128
|
+
|
|
4129
|
+
/**
|
|
4130
|
+
* Adds an item as a child to this item. If the item is already a part of a layout it will be removed
|
|
4131
|
+
* from its original position before adding it to this item.
|
|
4132
|
+
* @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4133
|
+
* @param index last index An optional index that determines at which position the new item should be added. Default: last index.
|
|
4134
|
+
*/
|
|
4135
|
+
addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
|
|
4136
|
+
|
|
4137
|
+
/**
|
|
4138
|
+
* Destroys the item and all it's children
|
|
4139
|
+
* @param contentItem The contentItem that should be removed
|
|
4140
|
+
* @param keepChild If true the item won't be destroyed. (Use cautiosly, if the item isn't destroyed it's up to you to destroy it later). Default: false.
|
|
4141
|
+
*/
|
|
4142
|
+
removeChild(contentItem: ContentItem, keepChild?: boolean): void;
|
|
4143
|
+
|
|
4144
|
+
/**
|
|
4145
|
+
* The contentItem that should be removed
|
|
4146
|
+
* @param oldChild ContentItem The contentItem that should be removed
|
|
4147
|
+
* @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4148
|
+
*/
|
|
4149
|
+
replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
|
|
4150
|
+
|
|
4151
|
+
/**
|
|
4152
|
+
* Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
|
|
4153
|
+
*/
|
|
4154
|
+
setSize(): void;
|
|
4155
|
+
|
|
4156
|
+
/**
|
|
4157
|
+
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
4158
|
+
* @param title the new title
|
|
4159
|
+
*/
|
|
4160
|
+
setTitle(title: string): void;
|
|
4161
|
+
|
|
4162
|
+
/**
|
|
4163
|
+
* A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
|
|
4164
|
+
* to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
|
|
4165
|
+
* @param functionName The name of the method to invoke
|
|
4166
|
+
* @param functionArguments An array of arguments to pass to every function
|
|
4167
|
+
* @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
|
|
4168
|
+
* @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
|
|
4169
|
+
*/
|
|
4170
|
+
callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
|
|
4171
|
+
|
|
4172
|
+
/**
|
|
4173
|
+
* Emits an event that bubbles up the item tree until it reaches the root element (and after a delay the layout manager). Useful e.g. for indicating state changes.
|
|
4174
|
+
*/
|
|
4175
|
+
emitBubblingEvent(name: string): void;
|
|
4176
|
+
|
|
4177
|
+
/**
|
|
4178
|
+
* Convenience method for item.parent.removeChild( item )
|
|
4179
|
+
*/
|
|
4180
|
+
remove(): void;
|
|
4181
|
+
|
|
4182
|
+
/**
|
|
4183
|
+
* Removes the item from its current position in the layout and opens it in a window
|
|
4184
|
+
*/
|
|
4185
|
+
popout(): BrowserWindow;
|
|
4186
|
+
|
|
4187
|
+
/**
|
|
4188
|
+
* Maximises the item or minimises it if it's already maximised
|
|
4189
|
+
*/
|
|
4190
|
+
toggleMaximise(): void;
|
|
4191
|
+
|
|
4192
|
+
/**
|
|
4193
|
+
* Selects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4194
|
+
*/
|
|
4195
|
+
select(): void;
|
|
4196
|
+
|
|
4197
|
+
/**
|
|
4198
|
+
* Unselects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4199
|
+
*/
|
|
4200
|
+
deselect(): void;
|
|
4201
|
+
|
|
4202
|
+
/**
|
|
4203
|
+
* Returns true if the item has the specified id or false if not
|
|
4204
|
+
* @param id An id to check for
|
|
4205
|
+
*/
|
|
4206
|
+
hasId(id: string): boolean;
|
|
4207
|
+
|
|
4208
|
+
/**
|
|
4209
|
+
* Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
|
|
4210
|
+
* @param contentItem The new active content item
|
|
4211
|
+
* @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
|
|
4212
|
+
*/
|
|
4213
|
+
// (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
|
|
4214
|
+
setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
|
|
4215
|
+
|
|
4216
|
+
/**
|
|
4217
|
+
* Only Stacks have this method! Returns the currently selected contentItem.
|
|
4218
|
+
*/
|
|
4219
|
+
getActiveContentItem(): ContentItem;
|
|
4220
|
+
|
|
4221
|
+
/**
|
|
4222
|
+
* Adds an id to an item or does nothing if the id is already present
|
|
4223
|
+
* @param id The id to be added
|
|
4224
|
+
*/
|
|
4225
|
+
addId(id: string): void;
|
|
4226
|
+
|
|
4227
|
+
/**
|
|
4228
|
+
* Removes an id from an item or throws an error if the id couldn't be found
|
|
4229
|
+
* @param id The id to be removed
|
|
4230
|
+
*/
|
|
4231
|
+
removeId(id: string): void;
|
|
4232
|
+
|
|
4233
|
+
/**
|
|
4234
|
+
* Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
|
|
4235
|
+
* @param filterFunction A function that determines whether an item matches certain criteria
|
|
4236
|
+
*/
|
|
4237
|
+
getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
|
|
4238
|
+
|
|
4239
|
+
/**
|
|
4240
|
+
* Returns all items with the specified id.
|
|
4241
|
+
* @param id An id specified in the itemConfig
|
|
4242
|
+
*/
|
|
4243
|
+
getItemsById(id: string | string[]): ContentItem[];
|
|
4244
|
+
|
|
4245
|
+
/**
|
|
4246
|
+
* Returns all items with the specified type
|
|
4247
|
+
* @param type 'row', 'column', 'stack', 'component' or 'root'
|
|
4248
|
+
*/
|
|
4249
|
+
getItemsByType(type: string): ContentItem[];
|
|
4250
|
+
|
|
4251
|
+
/**
|
|
4252
|
+
* Returns all instances of the component with the specified componentName
|
|
4253
|
+
* @param componentName a componentName as specified in the itemConfig
|
|
4254
|
+
*/
|
|
4255
|
+
getComponentsByName(componentName: string): any;
|
|
4256
|
+
|
|
4257
|
+
_contentAreaDimensions: any;
|
|
4258
|
+
_$getArea: () => any;
|
|
4259
|
+
}
|
|
4260
|
+
|
|
3906
4261
|
/**
|
|
3907
4262
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3908
4263
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
@@ -4387,6 +4742,46 @@ declare type DidFinishLoadEvent = NamedEvent & {
|
|
|
4387
4742
|
type: 'did-finish-load';
|
|
4388
4743
|
};
|
|
4389
4744
|
|
|
4745
|
+
declare interface Dimensions {
|
|
4746
|
+
/**
|
|
4747
|
+
* The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
|
|
4748
|
+
* than the visible one, making it safe to set this to small values without affecting usability.
|
|
4749
|
+
* Default: 5
|
|
4750
|
+
*/
|
|
4751
|
+
borderWidth?: number;
|
|
4752
|
+
|
|
4753
|
+
/**
|
|
4754
|
+
* The minimum height an item can be resized to (in pixel).
|
|
4755
|
+
* Default: 10
|
|
4756
|
+
*/
|
|
4757
|
+
minItemHeight?: number;
|
|
4758
|
+
|
|
4759
|
+
/**
|
|
4760
|
+
* The minimum width an item can be resized to (in pixel).
|
|
4761
|
+
* Default: 10
|
|
4762
|
+
*/
|
|
4763
|
+
minItemWidth?: number;
|
|
4764
|
+
|
|
4765
|
+
/**
|
|
4766
|
+
* The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
|
|
4767
|
+
* adjusted accordingly.
|
|
4768
|
+
* Default: 20
|
|
4769
|
+
*/
|
|
4770
|
+
headerHeight?: number;
|
|
4771
|
+
|
|
4772
|
+
/**
|
|
4773
|
+
* The width of the element that appears when an item is dragged (in pixel).
|
|
4774
|
+
* Default: 300
|
|
4775
|
+
*/
|
|
4776
|
+
dragProxyWidth?: number;
|
|
4777
|
+
|
|
4778
|
+
/**
|
|
4779
|
+
* The height of the element that appears when an item is dragged (in pixel).
|
|
4780
|
+
* Default: 200
|
|
4781
|
+
*/
|
|
4782
|
+
dragProxyHeight?: number;
|
|
4783
|
+
}
|
|
4784
|
+
|
|
4390
4785
|
/**
|
|
4391
4786
|
* @interface
|
|
4392
4787
|
*/
|
|
@@ -4503,25 +4898,6 @@ declare type DisplayMetadata_3 = {
|
|
|
4503
4898
|
readonly glyph?: string;
|
|
4504
4899
|
};
|
|
4505
4900
|
|
|
4506
|
-
/**
|
|
4507
|
-
* @interface
|
|
4508
|
-
*
|
|
4509
|
-
* Rules for domain-conditional `fin` API injection.
|
|
4510
|
-
*
|
|
4511
|
-
* @remarks Subset of {@link DomainSettings}.
|
|
4512
|
-
*/
|
|
4513
|
-
declare type DomainApiSettings = {
|
|
4514
|
-
/**
|
|
4515
|
-
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
4516
|
-
*
|
|
4517
|
-
* * 'none': The `fin` API will be not available.
|
|
4518
|
-
* * 'global': The entire `fin` API will be available.
|
|
4519
|
-
*
|
|
4520
|
-
* @defaultValue 'global'
|
|
4521
|
-
*/
|
|
4522
|
-
fin: InjectionType;
|
|
4523
|
-
};
|
|
4524
|
-
|
|
4525
4901
|
/**
|
|
4526
4902
|
* @interface
|
|
4527
4903
|
* Defines application settings that vary by the domain of the current context.
|
|
@@ -4560,7 +4936,7 @@ declare type DomainSettingsRule = {
|
|
|
4560
4936
|
/**
|
|
4561
4937
|
* {@inheritDoc ApiInjection}
|
|
4562
4938
|
*/
|
|
4563
|
-
api?:
|
|
4939
|
+
api?: ApiInjection;
|
|
4564
4940
|
};
|
|
4565
4941
|
};
|
|
4566
4942
|
|
|
@@ -4599,19 +4975,18 @@ declare type DownloadPreloadOption = {
|
|
|
4599
4975
|
/**
|
|
4600
4976
|
* @interface
|
|
4601
4977
|
*
|
|
4602
|
-
* A rule
|
|
4978
|
+
* A rule governing domain-conditional download behavior.
|
|
4603
4979
|
*/
|
|
4604
4980
|
declare type DownloadRule = {
|
|
4605
4981
|
/**
|
|
4606
|
-
* {@inheritDoc
|
|
4982
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4607
4983
|
*/
|
|
4608
|
-
behavior:
|
|
4984
|
+
behavior: FileDownloadBehaviorNames;
|
|
4609
4985
|
/**
|
|
4610
4986
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4611
|
-
*
|
|
4987
|
+
* the domain(s) for which the rule applies.
|
|
4612
4988
|
*
|
|
4613
|
-
* @remarks The match is evaluated against the URL of the *
|
|
4614
|
-
* of the page in which a file download link is embedded.
|
|
4989
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4615
4990
|
*/
|
|
4616
4991
|
match: string[];
|
|
4617
4992
|
};
|
|
@@ -4683,6 +5058,8 @@ declare type Dpi = {
|
|
|
4683
5058
|
vertical?: number;
|
|
4684
5059
|
};
|
|
4685
5060
|
|
|
5061
|
+
declare interface DragSource {}
|
|
5062
|
+
|
|
4686
5063
|
/**
|
|
4687
5064
|
* Generated when a window has been embedded.
|
|
4688
5065
|
* @interface
|
|
@@ -4955,7 +5332,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
|
4955
5332
|
*/
|
|
4956
5333
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
4957
5334
|
target: OpenFin.Identity;
|
|
4958
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent
|
|
5335
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
4959
5336
|
|
|
4960
5337
|
/**
|
|
4961
5338
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
@@ -4963,7 +5340,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
|
4963
5340
|
*/
|
|
4964
5341
|
declare type Event_5<Topic extends string> = {
|
|
4965
5342
|
topic: Topic;
|
|
4966
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent
|
|
5343
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
4967
5344
|
|
|
4968
5345
|
/**
|
|
4969
5346
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
|
|
@@ -4999,12 +5376,51 @@ declare class EventAggregator extends EmitterMap {
|
|
|
4999
5376
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5000
5377
|
}
|
|
5001
5378
|
|
|
5379
|
+
declare interface EventEmitter_2 {
|
|
5380
|
+
[x: string]: any;
|
|
5381
|
+
/**
|
|
5382
|
+
* Subscribe to an event
|
|
5383
|
+
* @param eventName The name of the event to describe to
|
|
5384
|
+
* @param callback The function that should be invoked when the event occurs
|
|
5385
|
+
* @param context The value of the this pointer in the callback function
|
|
5386
|
+
*/
|
|
5387
|
+
on(eventName: string, callback: Function, context?: any): void;
|
|
5388
|
+
|
|
5389
|
+
/**
|
|
5390
|
+
* Notify listeners of an event and pass arguments along
|
|
5391
|
+
* @param eventName The name of the event to emit
|
|
5392
|
+
*/
|
|
5393
|
+
emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5394
|
+
|
|
5395
|
+
/**
|
|
5396
|
+
* Alias for emit
|
|
5397
|
+
*/
|
|
5398
|
+
trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5399
|
+
|
|
5400
|
+
/**
|
|
5401
|
+
* Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
|
|
5402
|
+
* eventName and callback or just a specific callback with a specific context if invoked with all three
|
|
5403
|
+
* arguments.
|
|
5404
|
+
* @param eventName The name of the event to unsubscribe from
|
|
5405
|
+
* @param callback The function that should be invoked when the event occurs
|
|
5406
|
+
* @param context The value of the this pointer in the callback function
|
|
5407
|
+
*/
|
|
5408
|
+
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
5409
|
+
|
|
5410
|
+
/**
|
|
5411
|
+
* Alias for unbind
|
|
5412
|
+
*/
|
|
5413
|
+
off(eventName: string, callback?: Function, context?: any): void;
|
|
5414
|
+
}
|
|
5415
|
+
|
|
5002
5416
|
/**
|
|
5003
5417
|
* Handler for an event on an EventEmitter.
|
|
5004
5418
|
* @remarks Selects the correct type for the event
|
|
5005
5419
|
* payload from the provided union based on the provided string literal type.
|
|
5006
5420
|
*/
|
|
5007
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
5421
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
|
|
5422
|
+
type: EventType;
|
|
5423
|
+
}>, ...args: any[]) => void;
|
|
5008
5424
|
|
|
5009
5425
|
declare namespace Events {
|
|
5010
5426
|
export {
|
|
@@ -5156,7 +5572,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5156
5572
|
ExternalApplicationEvent,
|
|
5157
5573
|
EventType_4 as EventType,
|
|
5158
5574
|
ExternalApplicationEventType,
|
|
5159
|
-
|
|
5575
|
+
Payload_5 as Payload,
|
|
5160
5576
|
ByType_4 as ByType
|
|
5161
5577
|
}
|
|
5162
5578
|
}
|
|
@@ -5638,12 +6054,7 @@ declare type FetchManifestPayload = {
|
|
|
5638
6054
|
/**
|
|
5639
6055
|
* Whether file downloads raise a user prompt.
|
|
5640
6056
|
*/
|
|
5641
|
-
declare type
|
|
5642
|
-
|
|
5643
|
-
/**
|
|
5644
|
-
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
|
5645
|
-
*/
|
|
5646
|
-
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
|
6057
|
+
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5647
6058
|
|
|
5648
6059
|
/**
|
|
5649
6060
|
* Generated when a file download has completed.
|
|
@@ -5896,8 +6307,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5896
6307
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5897
6308
|
* currently embedded in.
|
|
5898
6309
|
*
|
|
5899
|
-
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5900
|
-
*
|
|
5901
6310
|
* @example
|
|
5902
6311
|
* ```js
|
|
5903
6312
|
* async function getParentWindow() {
|
|
@@ -5939,7 +6348,7 @@ declare namespace FrameEvents {
|
|
|
5939
6348
|
FrameEvent,
|
|
5940
6349
|
EventType_5 as EventType,
|
|
5941
6350
|
FrameEventType,
|
|
5942
|
-
|
|
6351
|
+
Payload_6 as Payload,
|
|
5943
6352
|
ByType_5 as ByType
|
|
5944
6353
|
}
|
|
5945
6354
|
}
|
|
@@ -6165,34 +6574,267 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
|
6165
6574
|
* });
|
|
6166
6575
|
* ```
|
|
6167
6576
|
*/
|
|
6168
|
-
isRegistered(hotkey: string): Promise<boolean>;
|
|
6169
|
-
}
|
|
6577
|
+
isRegistered(hotkey: string): Promise<boolean>;
|
|
6578
|
+
}
|
|
6579
|
+
|
|
6580
|
+
/**
|
|
6581
|
+
* @deprecated Renamed to {@link Event}.
|
|
6582
|
+
*/
|
|
6583
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
6584
|
+
|
|
6585
|
+
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6586
|
+
|
|
6587
|
+
declare namespace GlobalHotkeyEvents {
|
|
6588
|
+
export {
|
|
6589
|
+
BaseEvent_8 as BaseEvent,
|
|
6590
|
+
RegisteredEvent,
|
|
6591
|
+
UnregisteredEvent,
|
|
6592
|
+
Event_9 as Event,
|
|
6593
|
+
GlobalHotkeyEvent,
|
|
6594
|
+
EventType_6 as EventType,
|
|
6595
|
+
GlobalHotkeyEventType,
|
|
6596
|
+
Payload_7 as Payload,
|
|
6597
|
+
ByType_6 as ByType
|
|
6598
|
+
}
|
|
6599
|
+
}
|
|
6600
|
+
|
|
6601
|
+
/**
|
|
6602
|
+
* @deprecated Renamed to {@link EventType}.
|
|
6603
|
+
*/
|
|
6604
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
6605
|
+
|
|
6606
|
+
declare namespace GoldenLayout {
|
|
6607
|
+
export {
|
|
6608
|
+
GoldenLayout_2 as GoldenLayout,
|
|
6609
|
+
ItemConfigType,
|
|
6610
|
+
Settings,
|
|
6611
|
+
Dimensions,
|
|
6612
|
+
Labels,
|
|
6613
|
+
ItemType,
|
|
6614
|
+
ItemConfig,
|
|
6615
|
+
ComponentConfig,
|
|
6616
|
+
ReactComponentConfig,
|
|
6617
|
+
Config,
|
|
6618
|
+
ContentItem,
|
|
6619
|
+
Container,
|
|
6620
|
+
DragSource,
|
|
6621
|
+
BrowserWindow,
|
|
6622
|
+
Header,
|
|
6623
|
+
TabDragListener,
|
|
6624
|
+
Tab,
|
|
6625
|
+
EventEmitter_2 as EventEmitter
|
|
6626
|
+
}
|
|
6627
|
+
}
|
|
6628
|
+
|
|
6629
|
+
declare class GoldenLayout_2 implements EventEmitter_2 {
|
|
6630
|
+
/**
|
|
6631
|
+
* The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
|
|
6632
|
+
* object and of goldenLayout.root as the document.
|
|
6633
|
+
*/
|
|
6634
|
+
root: ContentItem;
|
|
6635
|
+
|
|
6636
|
+
/**
|
|
6637
|
+
* A reference to the (jQuery) DOM element containing the layout
|
|
6638
|
+
*/
|
|
6639
|
+
container: JQuery;
|
|
6640
|
+
|
|
6641
|
+
/**
|
|
6642
|
+
* True once the layout item tree has been created and the initialised event has been fired
|
|
6643
|
+
*/
|
|
6644
|
+
isInitialised: boolean;
|
|
6645
|
+
|
|
6646
|
+
/**
|
|
6647
|
+
* A reference to the current, extended top level config.
|
|
6648
|
+
*
|
|
6649
|
+
* Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
|
|
6650
|
+
*/
|
|
6651
|
+
config: Config;
|
|
6652
|
+
|
|
6653
|
+
/**
|
|
6654
|
+
* The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
|
|
6655
|
+
* to true.
|
|
6656
|
+
*/
|
|
6657
|
+
selectedItem: ContentItem;
|
|
6658
|
+
|
|
6659
|
+
/**
|
|
6660
|
+
* The current outer width of the layout in pixels.
|
|
6661
|
+
*/
|
|
6662
|
+
width: number;
|
|
6663
|
+
|
|
6664
|
+
/**
|
|
6665
|
+
* The current outer height of the layout in pixels.
|
|
6666
|
+
*/
|
|
6667
|
+
height: number;
|
|
6668
|
+
|
|
6669
|
+
/**
|
|
6670
|
+
* An array of BrowserWindow instances
|
|
6671
|
+
*/
|
|
6672
|
+
openPopouts: BrowserWindow[];
|
|
6673
|
+
|
|
6674
|
+
/**
|
|
6675
|
+
* True if the layout has been opened as a popout by another layout.
|
|
6676
|
+
*/
|
|
6677
|
+
isSubWindow: boolean;
|
|
6678
|
+
|
|
6679
|
+
/**
|
|
6680
|
+
* A singleton instance of EventEmitter that works across windows
|
|
6681
|
+
*/
|
|
6682
|
+
eventHub: EventEmitter_2;
|
|
6683
|
+
|
|
6684
|
+
_dragProxy: any;
|
|
6685
|
+
|
|
6686
|
+
dropTargetIndicator: any;
|
|
6687
|
+
|
|
6688
|
+
/**
|
|
6689
|
+
* @param config A GoldenLayout configuration object
|
|
6690
|
+
* @param container The DOM element the layout will be initialised in. Default: document.body
|
|
6691
|
+
*/
|
|
6692
|
+
constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
|
|
6693
|
+
|
|
6694
|
+
/*
|
|
6695
|
+
* @param name The name of the component, as referred to by componentName in the component configuration.
|
|
6696
|
+
* @param component A constructor or factory function. Will be invoked with new and two arguments, a
|
|
6697
|
+
* containerobject and a component state
|
|
6698
|
+
*/
|
|
6699
|
+
registerComponent(name: String, component: any): void;
|
|
6700
|
+
|
|
6701
|
+
/**
|
|
6702
|
+
* Renders the layout into the container. If init() is called before the document is ready it attaches itself as
|
|
6703
|
+
* a listener to the document and executes once it becomes ready.
|
|
6704
|
+
*/
|
|
6705
|
+
init(): void;
|
|
6706
|
+
|
|
6707
|
+
/**
|
|
6708
|
+
* Returns the current state of the layout and its components as a serialisable object.
|
|
6709
|
+
*/
|
|
6710
|
+
toConfig(): Config;
|
|
6711
|
+
|
|
6712
|
+
/**
|
|
6713
|
+
* Returns a component that was previously registered with layout.registerComponent().
|
|
6714
|
+
* @param name The name of a previously registered component
|
|
6715
|
+
*/
|
|
6716
|
+
getComponent(name: string): any;
|
|
6717
|
+
|
|
6718
|
+
/**
|
|
6719
|
+
* Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
|
|
6720
|
+
* @param width The outer width the layout should be resized to. Default: The container elements width
|
|
6721
|
+
* @param height The outer height the layout should be resized to. Default: The container elements height
|
|
6722
|
+
*/
|
|
6723
|
+
updateSize(width?: number, height?: number): void;
|
|
6724
|
+
|
|
6725
|
+
/**
|
|
6726
|
+
* Destroys the layout. Recursively calls destroy on all components and content items, removes all event
|
|
6727
|
+
* listeners and finally removes itself from the DOM.
|
|
6728
|
+
*/
|
|
6729
|
+
destroy(): void;
|
|
6730
|
+
|
|
6731
|
+
/**
|
|
6732
|
+
* Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
|
|
6733
|
+
* directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
|
|
6734
|
+
* all call this method implicitly.
|
|
6735
|
+
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6736
|
+
* @param parent A parent item
|
|
6737
|
+
*/
|
|
6738
|
+
createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
|
|
6739
|
+
|
|
6740
|
+
/**
|
|
6741
|
+
* Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
|
|
6742
|
+
* @param configOrContentItem The content item or config that will be created in the new window. If a item is
|
|
6743
|
+
* provided its config will be read, if config is provided, only the content key
|
|
6744
|
+
* will be used
|
|
6745
|
+
* @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
|
|
6746
|
+
* place the window in another screen.
|
|
6747
|
+
* @param parentId The id of the item within the current layout the child window's content will be appended to
|
|
6748
|
+
* when popIn is clicked
|
|
6749
|
+
* @param indexInParent The index at which the child window's contents will be appended to. Default: null
|
|
6750
|
+
*/
|
|
6751
|
+
createPopout(
|
|
6752
|
+
configOrContentItem: ItemConfigType | ContentItem,
|
|
6753
|
+
dimensions: {
|
|
6754
|
+
width: number;
|
|
6755
|
+
height: number;
|
|
6756
|
+
left: number;
|
|
6757
|
+
top: number;
|
|
6758
|
+
},
|
|
6759
|
+
parentId?: string,
|
|
6760
|
+
indexInParent?: number
|
|
6761
|
+
): void;
|
|
6762
|
+
|
|
6763
|
+
/**
|
|
6764
|
+
* Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
|
|
6765
|
+
* where it turns into a contentItem.
|
|
6766
|
+
* @param element The DOM element that will be turned into a dragSource
|
|
6767
|
+
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6768
|
+
* @return the dragSource that was created. This can be used to remove the
|
|
6769
|
+
* dragSource from the layout later.
|
|
6770
|
+
*/
|
|
6771
|
+
createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
|
|
6772
|
+
|
|
6773
|
+
/**
|
|
6774
|
+
* Removes a dragSource from the layout.
|
|
6775
|
+
*
|
|
6776
|
+
* @param dragSource The dragSource to remove
|
|
6777
|
+
*/
|
|
6778
|
+
removeDragSource(dragSource: DragSource): void;
|
|
6779
|
+
|
|
6780
|
+
/**
|
|
6781
|
+
* If settings.selectionEnabled is set to true, this allows to select items programmatically.
|
|
6782
|
+
* @param contentItem A ContentItem instance
|
|
6783
|
+
*/
|
|
6784
|
+
selectItem(contentItem: ContentItem): void;
|
|
6785
|
+
|
|
6786
|
+
/**
|
|
6787
|
+
* Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
|
|
6788
|
+
* and replace frequent keys and values with single letter substitutes.
|
|
6789
|
+
* @param config A GoldenLayout configuration object
|
|
6790
|
+
*/
|
|
6791
|
+
static minifyConfig(config: any): any;
|
|
6792
|
+
|
|
6793
|
+
/**
|
|
6794
|
+
* Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
|
|
6795
|
+
* @param minifiedConfig A minified GoldenLayout configuration object
|
|
6796
|
+
*/
|
|
6797
|
+
static unminifyConfig(minifiedConfig: any): any;
|
|
6170
6798
|
|
|
6171
|
-
/**
|
|
6172
|
-
|
|
6173
|
-
|
|
6174
|
-
|
|
6799
|
+
/**
|
|
6800
|
+
* Subscribe to an event
|
|
6801
|
+
* @param eventName The name of the event to describe to
|
|
6802
|
+
* @param callback The function that should be invoked when the event occurs
|
|
6803
|
+
* @param context The value of the this pointer in the callback function
|
|
6804
|
+
*/
|
|
6805
|
+
on(eventName: string, callback: Function, context?: any): void;
|
|
6175
6806
|
|
|
6176
|
-
|
|
6807
|
+
/**
|
|
6808
|
+
* Notify listeners of an event and pass arguments along
|
|
6809
|
+
* @param eventName The name of the event to emit
|
|
6810
|
+
*/
|
|
6811
|
+
emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
6177
6812
|
|
|
6178
|
-
|
|
6179
|
-
|
|
6180
|
-
|
|
6181
|
-
|
|
6182
|
-
UnregisteredEvent,
|
|
6183
|
-
Event_9 as Event,
|
|
6184
|
-
GlobalHotkeyEvent,
|
|
6185
|
-
EventType_6 as EventType,
|
|
6186
|
-
GlobalHotkeyEventType,
|
|
6187
|
-
Payload_8 as Payload,
|
|
6188
|
-
ByType_6 as ByType
|
|
6189
|
-
}
|
|
6190
|
-
}
|
|
6813
|
+
/**
|
|
6814
|
+
* Alias for emit
|
|
6815
|
+
*/
|
|
6816
|
+
trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
6191
6817
|
|
|
6192
|
-
/**
|
|
6193
|
-
|
|
6194
|
-
|
|
6195
|
-
|
|
6818
|
+
/**
|
|
6819
|
+
* Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
|
|
6820
|
+
* eventName and callback or just a specific callback with a specific context if invoked with all three
|
|
6821
|
+
* arguments.
|
|
6822
|
+
* @param eventName The name of the event to unsubscribe from
|
|
6823
|
+
* @param callback The function that should be invoked when the event occurs
|
|
6824
|
+
* @param context The value of the this pointer in the callback function
|
|
6825
|
+
*/
|
|
6826
|
+
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
6827
|
+
|
|
6828
|
+
/**
|
|
6829
|
+
* Alias for unbind
|
|
6830
|
+
*/
|
|
6831
|
+
off(eventName: string, callback?: Function, context?: any): void;
|
|
6832
|
+
|
|
6833
|
+
/**
|
|
6834
|
+
* Internal method that create drop areas on the far edges of window, e.g. far-right of window
|
|
6835
|
+
*/
|
|
6836
|
+
_$createRootItemAreas(): void;
|
|
6837
|
+
}
|
|
6196
6838
|
|
|
6197
6839
|
/**
|
|
6198
6840
|
* @interface
|
|
@@ -6201,6 +6843,62 @@ declare type GpuInfo = {
|
|
|
6201
6843
|
name: string;
|
|
6202
6844
|
};
|
|
6203
6845
|
|
|
6846
|
+
declare interface Header {
|
|
6847
|
+
/**
|
|
6848
|
+
* A reference to the LayoutManager instance
|
|
6849
|
+
*/
|
|
6850
|
+
layoutManager: GoldenLayout_2;
|
|
6851
|
+
|
|
6852
|
+
/**
|
|
6853
|
+
* A reference to the Stack this Header belongs to
|
|
6854
|
+
*/
|
|
6855
|
+
parent: ContentItem;
|
|
6856
|
+
|
|
6857
|
+
/**
|
|
6858
|
+
* An array of the Tabs within this header
|
|
6859
|
+
*/
|
|
6860
|
+
tabs: Tab[];
|
|
6861
|
+
|
|
6862
|
+
/**
|
|
6863
|
+
* The currently selected activeContentItem
|
|
6864
|
+
*/
|
|
6865
|
+
activeContentItem: ContentItem;
|
|
6866
|
+
|
|
6867
|
+
/**
|
|
6868
|
+
* The outer (jQuery) DOM element of this Header
|
|
6869
|
+
*/
|
|
6870
|
+
element: JQuery;
|
|
6871
|
+
|
|
6872
|
+
/**
|
|
6873
|
+
* The (jQuery) DOM element containing the tabs
|
|
6874
|
+
*/
|
|
6875
|
+
tabsContainer: JQuery;
|
|
6876
|
+
|
|
6877
|
+
/**
|
|
6878
|
+
* The (jQuery) DOM element containing the close, maximise and popout button
|
|
6879
|
+
*/
|
|
6880
|
+
controlsContainer: JQuery;
|
|
6881
|
+
|
|
6882
|
+
/**
|
|
6883
|
+
* Hides the currently selected contentItem, shows the specified one and highlights its tab.
|
|
6884
|
+
* @param contentItem The content item that will be selected
|
|
6885
|
+
*/
|
|
6886
|
+
setActiveContentItem(contentItem: ContentItem): void;
|
|
6887
|
+
|
|
6888
|
+
/**
|
|
6889
|
+
* Creates a new tab and associates it with a content item
|
|
6890
|
+
* @param contentItem The content item the tab will be associated with
|
|
6891
|
+
* @param index A zero based index, specifying the position of the new tab
|
|
6892
|
+
*/
|
|
6893
|
+
createTab(contentItem: ContentItem, index?: number): void;
|
|
6894
|
+
|
|
6895
|
+
/**
|
|
6896
|
+
* Finds a tab by its contentItem and removes it
|
|
6897
|
+
* @param contentItem The content item the tab is associated with
|
|
6898
|
+
*/
|
|
6899
|
+
removeTab(contentItem: ContentItem): void;
|
|
6900
|
+
}
|
|
6901
|
+
|
|
6204
6902
|
/**
|
|
6205
6903
|
* Generated when a View is hidden.
|
|
6206
6904
|
* @interface
|
|
@@ -6460,13 +7158,6 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
|
6460
7158
|
metadata?: MetadataType;
|
|
6461
7159
|
};
|
|
6462
7160
|
|
|
6463
|
-
declare type InheritableOptions = {
|
|
6464
|
-
customContext: boolean;
|
|
6465
|
-
customData: boolean;
|
|
6466
|
-
icon: boolean;
|
|
6467
|
-
preloadScripts: boolean;
|
|
6468
|
-
};
|
|
6469
|
-
|
|
6470
7161
|
/**
|
|
6471
7162
|
* Generated when an application has initialized.
|
|
6472
7163
|
* @interface
|
|
@@ -6910,15 +7601,6 @@ declare class InteropBroker extends Base {
|
|
|
6910
7601
|
setContext({ context }: {
|
|
6911
7602
|
context: OpenFin.Context;
|
|
6912
7603
|
}, clientIdentity: OpenFin.ClientIdentity): void;
|
|
6913
|
-
/**
|
|
6914
|
-
* Sets a context for the context group.
|
|
6915
|
-
* @param setContextOptions - New context to set.
|
|
6916
|
-
* @param contextGroupId - Context group id.
|
|
6917
|
-
*
|
|
6918
|
-
*/
|
|
6919
|
-
setContextForGroup({ context }: {
|
|
6920
|
-
context: OpenFin.Context;
|
|
6921
|
-
}, contextGroupId: string): void;
|
|
6922
7604
|
/**
|
|
6923
7605
|
* Get current context for a client subscribed to a Context Group.
|
|
6924
7606
|
*
|
|
@@ -7895,6 +8577,50 @@ declare class InteropModule extends Base {
|
|
|
7895
8577
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
|
7896
8578
|
}
|
|
7897
8579
|
|
|
8580
|
+
declare interface ItemConfig {
|
|
8581
|
+
/**
|
|
8582
|
+
* The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
|
|
8583
|
+
*/
|
|
8584
|
+
type: ItemType;
|
|
8585
|
+
|
|
8586
|
+
/**
|
|
8587
|
+
* An array of configurations for items that will be created as children of this item.
|
|
8588
|
+
*/
|
|
8589
|
+
content?: ItemConfigType[];
|
|
8590
|
+
|
|
8591
|
+
/**
|
|
8592
|
+
* The width of this item, relative to the other children of its parent in percent
|
|
8593
|
+
*/
|
|
8594
|
+
width?: number;
|
|
8595
|
+
|
|
8596
|
+
/**
|
|
8597
|
+
* The height of this item, relative to the other children of its parent in percent
|
|
8598
|
+
*/
|
|
8599
|
+
height?: number;
|
|
8600
|
+
|
|
8601
|
+
/**
|
|
8602
|
+
* A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
|
|
8603
|
+
*/
|
|
8604
|
+
id?: string | string[];
|
|
8605
|
+
|
|
8606
|
+
/**
|
|
8607
|
+
* Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
|
|
8608
|
+
* will return false
|
|
8609
|
+
* Default: true
|
|
8610
|
+
*/
|
|
8611
|
+
isClosable?: boolean;
|
|
8612
|
+
|
|
8613
|
+
/**
|
|
8614
|
+
* The title of the item as displayed on its tab and on popout windows
|
|
8615
|
+
* Default: componentName or ''
|
|
8616
|
+
*/
|
|
8617
|
+
title?: string;
|
|
8618
|
+
}
|
|
8619
|
+
|
|
8620
|
+
declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
|
|
8621
|
+
|
|
8622
|
+
declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
|
|
8623
|
+
|
|
7898
8624
|
/**
|
|
7899
8625
|
* @interface
|
|
7900
8626
|
*/
|
|
@@ -7952,6 +8678,32 @@ declare type JumpListTask = {
|
|
|
7952
8678
|
iconIndex?: number;
|
|
7953
8679
|
};
|
|
7954
8680
|
|
|
8681
|
+
declare interface Labels {
|
|
8682
|
+
/**
|
|
8683
|
+
* The tooltip text that appears when hovering over the close icon.
|
|
8684
|
+
* Default: 'close'
|
|
8685
|
+
*/
|
|
8686
|
+
close?: string;
|
|
8687
|
+
|
|
8688
|
+
/**
|
|
8689
|
+
* The tooltip text that appears when hovering over the maximise icon.
|
|
8690
|
+
* Default: 'maximise'
|
|
8691
|
+
*/
|
|
8692
|
+
maximise?: string;
|
|
8693
|
+
|
|
8694
|
+
/**
|
|
8695
|
+
* The tooltip text that appears when hovering over the minimise icon.
|
|
8696
|
+
* Default: 'minimise'
|
|
8697
|
+
*/
|
|
8698
|
+
minimise?: string;
|
|
8699
|
+
|
|
8700
|
+
/**
|
|
8701
|
+
* The tooltip text that appears when hovering over the popout icon.
|
|
8702
|
+
* Default: 'open in new window'
|
|
8703
|
+
*/
|
|
8704
|
+
popout?: string;
|
|
8705
|
+
}
|
|
8706
|
+
|
|
7955
8707
|
/**
|
|
7956
8708
|
* The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
|
|
7957
8709
|
*
|
|
@@ -8030,7 +8782,6 @@ declare type LaunchExternalProcessRule = {
|
|
|
8030
8782
|
*/
|
|
8031
8783
|
declare type LaunchIntoPlatformPayload = {
|
|
8032
8784
|
manifest: any;
|
|
8033
|
-
manifestUrl?: string;
|
|
8034
8785
|
};
|
|
8035
8786
|
|
|
8036
8787
|
/**
|
|
@@ -8383,7 +9134,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
|
|
|
8383
9134
|
entityId: string;
|
|
8384
9135
|
};
|
|
8385
9136
|
|
|
8386
|
-
declare type LayoutEntityTypes =
|
|
9137
|
+
declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
|
|
8387
9138
|
|
|
8388
9139
|
/**
|
|
8389
9140
|
* @interface
|
|
@@ -9384,7 +10135,7 @@ declare type MutableViewOptions = {
|
|
|
9384
10135
|
/**
|
|
9385
10136
|
* Configurations for API injection.
|
|
9386
10137
|
*/
|
|
9387
|
-
api:
|
|
10138
|
+
api: Api;
|
|
9388
10139
|
/**
|
|
9389
10140
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9390
10141
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
@@ -9859,7 +10610,6 @@ declare namespace OpenFin {
|
|
|
9859
10610
|
WindowState,
|
|
9860
10611
|
AutoplayPolicyOptions,
|
|
9861
10612
|
ConstWindowOptions,
|
|
9862
|
-
InheritableOptions,
|
|
9863
10613
|
MutableWindowOptions,
|
|
9864
10614
|
WorkspacePlatformOptions,
|
|
9865
10615
|
WebRequestHeader,
|
|
@@ -9868,7 +10618,6 @@ declare namespace OpenFin {
|
|
|
9868
10618
|
ResizeRegion,
|
|
9869
10619
|
Accelerator,
|
|
9870
10620
|
Api,
|
|
9871
|
-
ApiSettings,
|
|
9872
10621
|
InjectionType,
|
|
9873
10622
|
NavigationRules,
|
|
9874
10623
|
ContentNavigation,
|
|
@@ -10020,9 +10769,7 @@ declare namespace OpenFin {
|
|
|
10020
10769
|
DefaultDomainSettingsRule,
|
|
10021
10770
|
DomainSettings,
|
|
10022
10771
|
ApiInjection,
|
|
10023
|
-
DomainApiSettings,
|
|
10024
10772
|
DomainSettingsRule,
|
|
10025
|
-
FileDownloadBehavior,
|
|
10026
10773
|
FileDownloadBehaviorNames,
|
|
10027
10774
|
FileDownloadSettings,
|
|
10028
10775
|
DownloadRule,
|
|
@@ -10030,7 +10777,6 @@ declare namespace OpenFin {
|
|
|
10030
10777
|
Intent_2 as Intent,
|
|
10031
10778
|
IntentMetadata_3 as IntentMetadata,
|
|
10032
10779
|
IntentHandler_2 as IntentHandler,
|
|
10033
|
-
ContentCreationBehavior,
|
|
10034
10780
|
ContentCreationBehaviorNames,
|
|
10035
10781
|
MatchPattern,
|
|
10036
10782
|
BaseContentCreationRule,
|
|
@@ -10182,101 +10928,77 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10182
10928
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
|
10183
10929
|
};
|
|
10184
10930
|
|
|
10185
|
-
/**
|
|
10186
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10187
|
-
*
|
|
10188
|
-
* @see {@link ByType}
|
|
10189
|
-
*
|
|
10190
|
-
* @typeParam Type String key specifying the event to extract
|
|
10191
|
-
*/
|
|
10192
|
-
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
|
10193
|
-
|
|
10194
|
-
/**
|
|
10195
|
-
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
|
10196
|
-
*
|
|
10197
|
-
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
|
10198
|
-
* the appropriate payload union for that namespace.
|
|
10199
|
-
*
|
|
10200
|
-
* @typeParam Event Union of payloads for events on the given emitter
|
|
10201
|
-
* @see {@link ByType}
|
|
10202
|
-
*
|
|
10203
|
-
* @typeParam Type String key specifying the event to extract from the union
|
|
10204
|
-
*
|
|
10205
|
-
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
|
10206
|
-
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
|
10207
|
-
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
|
10208
|
-
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
|
10209
|
-
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
|
10210
|
-
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
|
10211
|
-
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
|
10212
|
-
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
|
10213
|
-
*/
|
|
10214
|
-
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
|
10215
|
-
type: EventType;
|
|
10216
|
-
}>;
|
|
10217
|
-
|
|
10218
10931
|
/**
|
|
10219
10932
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10220
10933
|
*
|
|
10221
|
-
* @see {@link ByType}
|
|
10222
|
-
*
|
|
10223
10934
|
* @typeParam Type String key specifying the event to extract
|
|
10224
10935
|
*/
|
|
10225
|
-
declare type
|
|
10936
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
10937
|
+
type: Type;
|
|
10938
|
+
}>;
|
|
10226
10939
|
|
|
10227
10940
|
/**
|
|
10228
10941
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10229
10942
|
*
|
|
10230
|
-
* @see {@link ByType}
|
|
10231
|
-
*
|
|
10232
10943
|
* @typeParam Type String key specifying the event to extract
|
|
10233
10944
|
*/
|
|
10234
|
-
declare type
|
|
10945
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10946
|
+
type: Type;
|
|
10947
|
+
}>;
|
|
10235
10948
|
|
|
10236
10949
|
/**
|
|
10237
10950
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
10238
10951
|
*
|
|
10239
|
-
* @see {@link ByType}
|
|
10240
|
-
*
|
|
10241
10952
|
* @typeParam Type String key specifying the event to extract
|
|
10242
10953
|
*/
|
|
10243
|
-
declare type
|
|
10954
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10955
|
+
type: Type;
|
|
10956
|
+
}>;
|
|
10244
10957
|
|
|
10245
10958
|
/**
|
|
10246
10959
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
10247
10960
|
*
|
|
10248
|
-
* @see {@link ByType}
|
|
10249
|
-
*
|
|
10250
10961
|
* @typeParam Type String key specifying the event to extract
|
|
10251
10962
|
*/
|
|
10252
|
-
declare type
|
|
10963
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10964
|
+
type: Type;
|
|
10965
|
+
}>;
|
|
10253
10966
|
|
|
10254
10967
|
/**
|
|
10255
10968
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
10256
10969
|
*
|
|
10257
|
-
* @see {@link ByType}
|
|
10258
|
-
*
|
|
10259
10970
|
* @typeParam Type String key specifying the event to extract
|
|
10260
10971
|
*/
|
|
10261
|
-
declare type
|
|
10972
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10973
|
+
type: Type;
|
|
10974
|
+
}>;
|
|
10262
10975
|
|
|
10263
10976
|
/**
|
|
10264
10977
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
10265
10978
|
*
|
|
10266
|
-
* @see {@link ByType}
|
|
10267
|
-
*
|
|
10268
10979
|
* @typeParam Type String key specifying the event to extract
|
|
10269
10980
|
*/
|
|
10270
|
-
declare type
|
|
10981
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10982
|
+
type: Type;
|
|
10983
|
+
}>;
|
|
10271
10984
|
|
|
10272
10985
|
/**
|
|
10273
10986
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
10274
10987
|
*
|
|
10275
|
-
* @
|
|
10988
|
+
* @typeParam Type String key specifying the event to extract
|
|
10989
|
+
*/
|
|
10990
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10991
|
+
type: Type;
|
|
10992
|
+
}>;
|
|
10993
|
+
|
|
10994
|
+
/**
|
|
10995
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10276
10996
|
*
|
|
10277
10997
|
* @typeParam Type String key specifying the event to extract
|
|
10278
10998
|
*/
|
|
10279
|
-
declare type Payload_9<Type extends
|
|
10999
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
11000
|
+
type: Type;
|
|
11001
|
+
}>;
|
|
10280
11002
|
|
|
10281
11003
|
declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
|
|
10282
11004
|
|
|
@@ -10970,7 +11692,7 @@ declare namespace PlatformEvents {
|
|
|
10970
11692
|
PlatformEvent,
|
|
10971
11693
|
EventType_7 as EventType,
|
|
10972
11694
|
PlatformEventType,
|
|
10973
|
-
|
|
11695
|
+
Payload_8 as Payload,
|
|
10974
11696
|
ByType_7 as ByType
|
|
10975
11697
|
}
|
|
10976
11698
|
}
|
|
@@ -11157,13 +11879,9 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11157
11879
|
*/
|
|
11158
11880
|
providerUrl?: string;
|
|
11159
11881
|
/**
|
|
11160
|
-
*
|
|
11161
|
-
*
|
|
11162
|
-
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11163
|
-
*
|
|
11164
|
-
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11882
|
+
* The permissions for secured APIs.
|
|
11165
11883
|
*/
|
|
11166
|
-
|
|
11884
|
+
permissions?: Partial<Permissions_2>;
|
|
11167
11885
|
};
|
|
11168
11886
|
|
|
11169
11887
|
/**
|
|
@@ -11968,7 +12686,7 @@ declare type PreloadScriptInfoRunning = {
|
|
|
11968
12686
|
* @interface
|
|
11969
12687
|
*/
|
|
11970
12688
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
|
11971
|
-
type: 'preload-
|
|
12689
|
+
type: 'preload-script-state-changed';
|
|
11972
12690
|
};
|
|
11973
12691
|
|
|
11974
12692
|
/**
|
|
@@ -11985,7 +12703,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
|
11985
12703
|
* @interface
|
|
11986
12704
|
*/
|
|
11987
12705
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
|
11988
|
-
type: 'preload-
|
|
12706
|
+
type: 'preload-script-state-changing';
|
|
11989
12707
|
};
|
|
11990
12708
|
|
|
11991
12709
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
|
@@ -12411,7 +13129,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12411
13129
|
'interop-broker-remove-client-from-context-group': VoidCall;
|
|
12412
13130
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12413
13131
|
'interop-broker-set-context': VoidCall;
|
|
12414
|
-
'interop-broker-set-context-for-group': VoidCall;
|
|
12415
13132
|
'query-permission-for-current-context': {
|
|
12416
13133
|
request: {
|
|
12417
13134
|
apiName: string;
|
|
@@ -12602,6 +13319,18 @@ declare type QueryPermissionResult = {
|
|
|
12602
13319
|
rawValue?: unknown;
|
|
12603
13320
|
};
|
|
12604
13321
|
|
|
13322
|
+
declare interface ReactComponentConfig extends ItemConfig {
|
|
13323
|
+
/**
|
|
13324
|
+
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
|
|
13325
|
+
*/
|
|
13326
|
+
component: string;
|
|
13327
|
+
|
|
13328
|
+
/**
|
|
13329
|
+
* Properties that will be passed to the component and accessible using this.props.
|
|
13330
|
+
*/
|
|
13331
|
+
props?: any;
|
|
13332
|
+
}
|
|
13333
|
+
|
|
12605
13334
|
/**
|
|
12606
13335
|
* @interface
|
|
12607
13336
|
*/
|
|
@@ -12689,15 +13418,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
|
12689
13418
|
token: string;
|
|
12690
13419
|
}
|
|
12691
13420
|
|
|
12692
|
-
/**
|
|
12693
|
-
* Generated when a View is removed from a layout.
|
|
12694
|
-
* @interface
|
|
12695
|
-
*/
|
|
12696
|
-
declare type RemovedFromLayoutEvent = BaseEvent_4 & {
|
|
12697
|
-
type: 'removed-from-layout';
|
|
12698
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
12699
|
-
};
|
|
12700
|
-
|
|
12701
13421
|
/**
|
|
12702
13422
|
* @interface
|
|
12703
13423
|
*/
|
|
@@ -13117,6 +13837,97 @@ declare type SessionContextGroup = {
|
|
|
13117
13837
|
}>;
|
|
13118
13838
|
};
|
|
13119
13839
|
|
|
13840
|
+
declare interface Settings {
|
|
13841
|
+
preventSplitterResize?: boolean;
|
|
13842
|
+
|
|
13843
|
+
newTabButton?: {
|
|
13844
|
+
url?: string;
|
|
13845
|
+
};
|
|
13846
|
+
|
|
13847
|
+
/**
|
|
13848
|
+
* If true, tabs can't be dragged into the window.
|
|
13849
|
+
* Default: false
|
|
13850
|
+
*/
|
|
13851
|
+
preventDragIn?: boolean;
|
|
13852
|
+
|
|
13853
|
+
/**
|
|
13854
|
+
* If true, tabs can't be dragged out of the window.
|
|
13855
|
+
* Default: false
|
|
13856
|
+
*/
|
|
13857
|
+
preventDragOut?: boolean;
|
|
13858
|
+
|
|
13859
|
+
/**
|
|
13860
|
+
* If true, stack headers are the only areas where tabs can be dropped.
|
|
13861
|
+
* Default: false
|
|
13862
|
+
*/
|
|
13863
|
+
constrainDragToHeaders?: boolean;
|
|
13864
|
+
/**
|
|
13865
|
+
* Turns headers on or off. If false, the layout will be displayed with splitters only.
|
|
13866
|
+
* Default: true
|
|
13867
|
+
*/
|
|
13868
|
+
hasHeaders?: boolean;
|
|
13869
|
+
|
|
13870
|
+
/**
|
|
13871
|
+
* (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
|
|
13872
|
+
* automatically when layout.createDragSource() is called.
|
|
13873
|
+
* Default: true
|
|
13874
|
+
*/
|
|
13875
|
+
constrainDragToContainer?: boolean;
|
|
13876
|
+
|
|
13877
|
+
/**
|
|
13878
|
+
* If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
|
|
13879
|
+
* Default: true
|
|
13880
|
+
*/
|
|
13881
|
+
reorderEnabled?: boolean;
|
|
13882
|
+
|
|
13883
|
+
/**
|
|
13884
|
+
* If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
|
|
13885
|
+
* the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
|
|
13886
|
+
* Default: false
|
|
13887
|
+
*/
|
|
13888
|
+
selectionEnabled?: boolean;
|
|
13889
|
+
|
|
13890
|
+
/**
|
|
13891
|
+
* Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
|
|
13892
|
+
* be transferred to the new window, if false only the active component will be opened.
|
|
13893
|
+
* Default: false
|
|
13894
|
+
*/
|
|
13895
|
+
popoutWholeStack?: boolean;
|
|
13896
|
+
|
|
13897
|
+
/**
|
|
13898
|
+
* Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
|
|
13899
|
+
* If false, the popout call will fail silently.
|
|
13900
|
+
* Default: true
|
|
13901
|
+
*/
|
|
13902
|
+
blockedPopoutsThrowError?: boolean;
|
|
13903
|
+
|
|
13904
|
+
/**
|
|
13905
|
+
* Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
|
|
13906
|
+
* strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
|
|
13907
|
+
* addition, any changes made to popouts won't be stored after the parent is closed.
|
|
13908
|
+
* Default: true
|
|
13909
|
+
*/
|
|
13910
|
+
closePopoutsOnUnload?: boolean;
|
|
13911
|
+
|
|
13912
|
+
/**
|
|
13913
|
+
* Specifies if the popout icon should be displayed in the header-bar.
|
|
13914
|
+
* Default: true
|
|
13915
|
+
*/
|
|
13916
|
+
showPopoutIcon?: boolean;
|
|
13917
|
+
|
|
13918
|
+
/**
|
|
13919
|
+
* Specifies if the maximise icon should be displayed in the header-bar.
|
|
13920
|
+
* Default: true
|
|
13921
|
+
*/
|
|
13922
|
+
showMaximiseIcon?: boolean;
|
|
13923
|
+
|
|
13924
|
+
/**
|
|
13925
|
+
* Specifies if the close icon should be displayed in the header-bar.
|
|
13926
|
+
* Default: true
|
|
13927
|
+
*/
|
|
13928
|
+
showCloseIcon?: boolean;
|
|
13929
|
+
}
|
|
13930
|
+
|
|
13120
13931
|
/**
|
|
13121
13932
|
* @interface
|
|
13122
13933
|
*/
|
|
@@ -13340,7 +14151,7 @@ declare type Snapshot = {
|
|
|
13340
14151
|
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
|
13341
14152
|
* @interface
|
|
13342
14153
|
*/
|
|
13343
|
-
declare type SnapshotAppliedEvent =
|
|
14154
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13344
14155
|
topic: 'application';
|
|
13345
14156
|
type: 'platform-snapshot-applied';
|
|
13346
14157
|
};
|
|
@@ -14952,7 +15763,7 @@ declare namespace SystemEvents {
|
|
|
14952
15763
|
SystemEvent,
|
|
14953
15764
|
EventType_8 as EventType,
|
|
14954
15765
|
SystemEventType,
|
|
14955
|
-
|
|
15766
|
+
Payload_9 as Payload,
|
|
14956
15767
|
ByType_8 as ByType
|
|
14957
15768
|
}
|
|
14958
15769
|
}
|
|
@@ -15025,6 +15836,59 @@ declare type SystemShutdownHandler = (shutdownEvent: {
|
|
|
15025
15836
|
proceed: () => void;
|
|
15026
15837
|
}) => void;
|
|
15027
15838
|
|
|
15839
|
+
declare interface Tab {
|
|
15840
|
+
_dragListener: TabDragListener;
|
|
15841
|
+
|
|
15842
|
+
/**
|
|
15843
|
+
* True if this tab is the selected tab
|
|
15844
|
+
*/
|
|
15845
|
+
isActive: boolean;
|
|
15846
|
+
|
|
15847
|
+
/**
|
|
15848
|
+
* A reference to the header this tab is a child of
|
|
15849
|
+
*/
|
|
15850
|
+
header: Header;
|
|
15851
|
+
|
|
15852
|
+
/**
|
|
15853
|
+
* A reference to the content item this tab relates to
|
|
15854
|
+
*/
|
|
15855
|
+
contentItem: ContentItem;
|
|
15856
|
+
|
|
15857
|
+
/**
|
|
15858
|
+
* The tabs outer (jQuery) DOM element
|
|
15859
|
+
*/
|
|
15860
|
+
element: JQuery;
|
|
15861
|
+
|
|
15862
|
+
/**
|
|
15863
|
+
* The (jQuery) DOM element containing the title
|
|
15864
|
+
*/
|
|
15865
|
+
titleElement: JQuery;
|
|
15866
|
+
|
|
15867
|
+
/**
|
|
15868
|
+
* The (jQuery) DOM element that closes the tab
|
|
15869
|
+
*/
|
|
15870
|
+
closeElement: JQuery;
|
|
15871
|
+
|
|
15872
|
+
/**
|
|
15873
|
+
* Sets the tab's title. Does not affect the contentItem's title!
|
|
15874
|
+
* @param title The new title
|
|
15875
|
+
*/
|
|
15876
|
+
setTitle(title: string): void;
|
|
15877
|
+
|
|
15878
|
+
/**
|
|
15879
|
+
* Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
|
|
15880
|
+
* @param isActive Whether the tab is active
|
|
15881
|
+
*/
|
|
15882
|
+
setActive(isActive: boolean): void;
|
|
15883
|
+
}
|
|
15884
|
+
|
|
15885
|
+
declare interface TabDragListener extends EventEmitter_2 {
|
|
15886
|
+
/**
|
|
15887
|
+
* A reference to the content item this tab relates to
|
|
15888
|
+
*/
|
|
15889
|
+
contentItem: ContentItem;
|
|
15890
|
+
}
|
|
15891
|
+
|
|
15028
15892
|
/**
|
|
15029
15893
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
15030
15894
|
*/
|
|
@@ -16002,8 +16866,6 @@ declare namespace ViewEvents {
|
|
|
16002
16866
|
BaseEvent_4 as BaseEvent,
|
|
16003
16867
|
BaseViewEvent,
|
|
16004
16868
|
TargetChangedEvent,
|
|
16005
|
-
AddedToLayoutEvent,
|
|
16006
|
-
RemovedFromLayoutEvent,
|
|
16007
16869
|
NonPropagatedViewEvent,
|
|
16008
16870
|
CreatedEvent,
|
|
16009
16871
|
DestroyedEvent,
|
|
@@ -16020,7 +16882,7 @@ declare namespace ViewEvents {
|
|
|
16020
16882
|
PropagatedViewEvent,
|
|
16021
16883
|
PropagatedEventType_2 as PropagatedEventType,
|
|
16022
16884
|
PropagatedViewEventType,
|
|
16023
|
-
|
|
16885
|
+
Payload_2 as Payload,
|
|
16024
16886
|
ByType
|
|
16025
16887
|
}
|
|
16026
16888
|
}
|
|
@@ -17203,8 +18065,7 @@ declare namespace WebContentsEvents {
|
|
|
17203
18065
|
Event_5 as Event,
|
|
17204
18066
|
WebContentsEvent,
|
|
17205
18067
|
WillPropagateWebContentsEvent,
|
|
17206
|
-
NonPropagatedWebContentsEvent
|
|
17207
|
-
WillRedirectEvent
|
|
18068
|
+
NonPropagatedWebContentsEvent
|
|
17208
18069
|
}
|
|
17209
18070
|
}
|
|
17210
18071
|
|
|
@@ -17282,15 +18143,14 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
|
17282
18143
|
declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
17283
18144
|
|
|
17284
18145
|
/**
|
|
17285
|
-
* Generated
|
|
18146
|
+
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
17286
18147
|
* @interface
|
|
17287
18148
|
*/
|
|
17288
|
-
declare type WillRedirectEvent =
|
|
18149
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
|
17289
18150
|
type: 'will-redirect';
|
|
17290
18151
|
blocked: boolean;
|
|
17291
18152
|
isInPlace: boolean;
|
|
17292
18153
|
url: string;
|
|
17293
|
-
isMainFrame: boolean;
|
|
17294
18154
|
};
|
|
17295
18155
|
|
|
17296
18156
|
/**
|
|
@@ -17315,6 +18175,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
17315
18175
|
* @internal
|
|
17316
18176
|
*/
|
|
17317
18177
|
constructor(wire: Transport, identity: OpenFin.Identity);
|
|
18178
|
+
/**
|
|
18179
|
+
* create a new window
|
|
18180
|
+
* @internal
|
|
18181
|
+
*/
|
|
17318
18182
|
createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
|
|
17319
18183
|
/**
|
|
17320
18184
|
* Retrieves an array of frame info objects representing the main frame and any
|
|
@@ -18438,6 +19302,7 @@ declare namespace WindowEvents {
|
|
|
18438
19302
|
AlertRequestedEvent,
|
|
18439
19303
|
AuthRequestedEvent,
|
|
18440
19304
|
EndLoadEvent,
|
|
19305
|
+
WillRedirectEvent,
|
|
18441
19306
|
ReloadedEvent,
|
|
18442
19307
|
OptionsChangedEvent,
|
|
18443
19308
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
@@ -18499,7 +19364,7 @@ declare namespace WindowEvents {
|
|
|
18499
19364
|
PropagatedEvent_3 as PropagatedEvent,
|
|
18500
19365
|
PropagatedWindowEvent,
|
|
18501
19366
|
PropagatedWindowEventType,
|
|
18502
|
-
|
|
19367
|
+
Payload_3 as Payload,
|
|
18503
19368
|
ByType_2 as ByType
|
|
18504
19369
|
}
|
|
18505
19370
|
}
|
|
@@ -18685,7 +19550,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
18685
19550
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
18686
19551
|
* from {@link OpenFin.ViewEvents}.
|
|
18687
19552
|
*/
|
|
18688
|
-
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
19553
|
+
declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
|
|
18689
19554
|
|
|
18690
19555
|
/**
|
|
18691
19556
|
* Generated when a child window starts loading.
|