@openfin/remote-adapter 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/remote-adapter-alpha.d.ts +1109 -248
- package/out/remote-adapter-beta.d.ts +1109 -248
- package/out/remote-adapter-public.d.ts +1109 -248
- package/out/remote-adapter.d.ts +1112 -247
- package/out/remote-adapter.js +97 -127
- package/package.json +2 -2
package/out/remote-adapter.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
|
};
|
|
@@ -3540,7 +3597,7 @@ declare type ConstViewOptions = {
|
|
|
3540
3597
|
/**
|
|
3541
3598
|
* Configurations for API injection.
|
|
3542
3599
|
*/
|
|
3543
|
-
api:
|
|
3600
|
+
api: Api;
|
|
3544
3601
|
/**
|
|
3545
3602
|
* The name of the view.
|
|
3546
3603
|
*/
|
|
@@ -3773,9 +3830,7 @@ declare type ConstWindowOptions = {
|
|
|
3773
3830
|
*/
|
|
3774
3831
|
preloadScripts: PreloadScript[];
|
|
3775
3832
|
/**
|
|
3776
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3777
|
-
* 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.
|
|
3778
|
-
* @remarks Will only be used if pages are on the same origin.
|
|
3833
|
+
* String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
|
|
3779
3834
|
*/
|
|
3780
3835
|
processAffinity: string;
|
|
3781
3836
|
/**
|
|
@@ -3859,18 +3914,106 @@ declare type ConstWindowOptions = {
|
|
|
3859
3914
|
* _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
|
|
3860
3915
|
*/
|
|
3861
3916
|
viewVisibility?: ViewVisibilityOptions;
|
|
3917
|
+
};
|
|
3918
|
+
|
|
3919
|
+
declare interface Container extends EventEmitter_2 {
|
|
3862
3920
|
/**
|
|
3863
|
-
*
|
|
3921
|
+
* The current width of the container in pixel
|
|
3864
3922
|
*/
|
|
3865
|
-
|
|
3866
|
-
|
|
3923
|
+
width: number;
|
|
3924
|
+
|
|
3925
|
+
/**
|
|
3926
|
+
* The current height of the container in pixel
|
|
3927
|
+
*/
|
|
3928
|
+
height: number;
|
|
3867
3929
|
|
|
3868
|
-
|
|
3930
|
+
/**
|
|
3931
|
+
* A reference to the component-item that controls this container
|
|
3932
|
+
*/
|
|
3933
|
+
parent: ContentItem;
|
|
3869
3934
|
|
|
3870
|
-
/**
|
|
3871
|
-
|
|
3872
|
-
|
|
3873
|
-
|
|
3935
|
+
/**
|
|
3936
|
+
* A reference to the tab that controls this container. Will initially be null
|
|
3937
|
+
* (and populated once a tab event has been fired).
|
|
3938
|
+
*/
|
|
3939
|
+
tab: Tab;
|
|
3940
|
+
|
|
3941
|
+
/**
|
|
3942
|
+
* The current title of the container
|
|
3943
|
+
*/
|
|
3944
|
+
title: string;
|
|
3945
|
+
|
|
3946
|
+
/*
|
|
3947
|
+
* A reference to the GoldenLayout instance this container belongs to
|
|
3948
|
+
*/
|
|
3949
|
+
layoutManager: GoldenLayout_2;
|
|
3950
|
+
|
|
3951
|
+
/**
|
|
3952
|
+
* True if the item is currently hidden
|
|
3953
|
+
*/
|
|
3954
|
+
isHidden: boolean;
|
|
3955
|
+
|
|
3956
|
+
/**
|
|
3957
|
+
* Overwrites the components state with the provided value. To only change parts of the componentState see
|
|
3958
|
+
* extendState below. This is the main mechanism for saving the state of a component. This state will be the
|
|
3959
|
+
* value of componentState when layout.toConfig() is called and will be passed back to the component's
|
|
3960
|
+
* constructor function. It will also be used when the component is opened in a new window.
|
|
3961
|
+
* @param state A serialisable object
|
|
3962
|
+
*/
|
|
3963
|
+
setState(state: any): void;
|
|
3964
|
+
|
|
3965
|
+
/**
|
|
3966
|
+
* The same as setState but does not emit 'stateChanged' event
|
|
3967
|
+
* @param {serialisable} state
|
|
3968
|
+
*/
|
|
3969
|
+
setStateSkipEvent(state: any): void;
|
|
3970
|
+
|
|
3971
|
+
/**
|
|
3972
|
+
* This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
|
|
3973
|
+
* @param state A serialisable object
|
|
3974
|
+
*/
|
|
3975
|
+
extendState(state: any): void;
|
|
3976
|
+
|
|
3977
|
+
/**
|
|
3978
|
+
* Returns the current state.
|
|
3979
|
+
*/
|
|
3980
|
+
getState(): any;
|
|
3981
|
+
|
|
3982
|
+
/**
|
|
3983
|
+
* Returns the container's inner element as a jQuery element
|
|
3984
|
+
*/
|
|
3985
|
+
getElement(): JQuery;
|
|
3986
|
+
|
|
3987
|
+
/**
|
|
3988
|
+
* hides the container or returns false if hiding it is not possible
|
|
3989
|
+
*/
|
|
3990
|
+
hide(): boolean;
|
|
3991
|
+
|
|
3992
|
+
/**
|
|
3993
|
+
* shows the container or returns false if showing it is not possible
|
|
3994
|
+
*/
|
|
3995
|
+
show(): boolean;
|
|
3996
|
+
|
|
3997
|
+
/**
|
|
3998
|
+
* Sets the container to the specified size or returns false if that's not possible
|
|
3999
|
+
* @param width the new width in pixel
|
|
4000
|
+
* @param height the new height in pixel
|
|
4001
|
+
*/
|
|
4002
|
+
setSize(width: number, height: number): boolean;
|
|
4003
|
+
|
|
4004
|
+
/**
|
|
4005
|
+
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
4006
|
+
* @param title the new title
|
|
4007
|
+
*/
|
|
4008
|
+
setTitle(title: string): void;
|
|
4009
|
+
|
|
4010
|
+
/**
|
|
4011
|
+
* Closes the container or returns false if that is not possible
|
|
4012
|
+
*/
|
|
4013
|
+
close(): boolean;
|
|
4014
|
+
}
|
|
4015
|
+
|
|
4016
|
+
declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
|
|
3874
4017
|
|
|
3875
4018
|
/**
|
|
3876
4019
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
@@ -3894,7 +4037,7 @@ declare type ContentCreationOptions = {
|
|
|
3894
4037
|
* @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
|
|
3895
4038
|
* the specified `behavior` key.
|
|
3896
4039
|
*/
|
|
3897
|
-
declare type ContentCreationRule<Behavior extends
|
|
4040
|
+
declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
|
|
3898
4041
|
behavior: Behavior;
|
|
3899
4042
|
}>;
|
|
3900
4043
|
|
|
@@ -3927,6 +4070,218 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3927
4070
|
disposition: string;
|
|
3928
4071
|
};
|
|
3929
4072
|
|
|
4073
|
+
declare interface ContentItem extends EventEmitter_2 {
|
|
4074
|
+
instance: any;
|
|
4075
|
+
header: any;
|
|
4076
|
+
_splitter: any;
|
|
4077
|
+
/**
|
|
4078
|
+
* This items configuration in its current state
|
|
4079
|
+
*/
|
|
4080
|
+
config: ItemConfigType;
|
|
4081
|
+
|
|
4082
|
+
/**
|
|
4083
|
+
* The type of the item. Can be row, column, stack, component or root
|
|
4084
|
+
*/
|
|
4085
|
+
type: ItemType;
|
|
4086
|
+
|
|
4087
|
+
/**
|
|
4088
|
+
* An array of items that are children of this item
|
|
4089
|
+
*/
|
|
4090
|
+
contentItems: ContentItem[];
|
|
4091
|
+
|
|
4092
|
+
container: Container;
|
|
4093
|
+
/**
|
|
4094
|
+
* The item that is this item's parent (or null if the item is root)
|
|
4095
|
+
*/
|
|
4096
|
+
parent: ContentItem;
|
|
4097
|
+
|
|
4098
|
+
/**
|
|
4099
|
+
* A String or array of identifiers if provided in the configuration
|
|
4100
|
+
*/
|
|
4101
|
+
id: string;
|
|
4102
|
+
|
|
4103
|
+
/**
|
|
4104
|
+
* True if the item had been initialised
|
|
4105
|
+
*/
|
|
4106
|
+
isInitialised: boolean;
|
|
4107
|
+
|
|
4108
|
+
/**
|
|
4109
|
+
* True if the item is maximised
|
|
4110
|
+
*/
|
|
4111
|
+
isMaximised: boolean;
|
|
4112
|
+
|
|
4113
|
+
/**
|
|
4114
|
+
* True if the item is the layout's root item
|
|
4115
|
+
*/
|
|
4116
|
+
isRoot: boolean;
|
|
4117
|
+
|
|
4118
|
+
/**
|
|
4119
|
+
* True if the item is a row
|
|
4120
|
+
*/
|
|
4121
|
+
isRow: boolean;
|
|
4122
|
+
|
|
4123
|
+
/**
|
|
4124
|
+
* True if the item is a column
|
|
4125
|
+
*/
|
|
4126
|
+
isColumn: boolean;
|
|
4127
|
+
|
|
4128
|
+
/**
|
|
4129
|
+
* True if the item is a stack
|
|
4130
|
+
*/
|
|
4131
|
+
isStack: boolean;
|
|
4132
|
+
|
|
4133
|
+
/**
|
|
4134
|
+
* True if the item is a component
|
|
4135
|
+
*/
|
|
4136
|
+
isComponent: boolean;
|
|
4137
|
+
|
|
4138
|
+
/**
|
|
4139
|
+
* A reference to the layoutManager that controls this item
|
|
4140
|
+
*/
|
|
4141
|
+
layoutManager: any;
|
|
4142
|
+
|
|
4143
|
+
/**
|
|
4144
|
+
* The item's outer element
|
|
4145
|
+
*/
|
|
4146
|
+
element: JQuery;
|
|
4147
|
+
|
|
4148
|
+
/**
|
|
4149
|
+
* The item's inner element. Can be the same as the outer element.
|
|
4150
|
+
*/
|
|
4151
|
+
childElementContainer: Container;
|
|
4152
|
+
|
|
4153
|
+
/**
|
|
4154
|
+
* Adds an item as a child to this item. If the item is already a part of a layout it will be removed
|
|
4155
|
+
* from its original position before adding it to this item.
|
|
4156
|
+
* @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4157
|
+
* @param index last index An optional index that determines at which position the new item should be added. Default: last index.
|
|
4158
|
+
*/
|
|
4159
|
+
addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
|
|
4160
|
+
|
|
4161
|
+
/**
|
|
4162
|
+
* Destroys the item and all it's children
|
|
4163
|
+
* @param contentItem The contentItem that should be removed
|
|
4164
|
+
* @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.
|
|
4165
|
+
*/
|
|
4166
|
+
removeChild(contentItem: ContentItem, keepChild?: boolean): void;
|
|
4167
|
+
|
|
4168
|
+
/**
|
|
4169
|
+
* The contentItem that should be removed
|
|
4170
|
+
* @param oldChild ContentItem The contentItem that should be removed
|
|
4171
|
+
* @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4172
|
+
*/
|
|
4173
|
+
replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
|
|
4174
|
+
|
|
4175
|
+
/**
|
|
4176
|
+
* Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
|
|
4177
|
+
*/
|
|
4178
|
+
setSize(): void;
|
|
4179
|
+
|
|
4180
|
+
/**
|
|
4181
|
+
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
4182
|
+
* @param title the new title
|
|
4183
|
+
*/
|
|
4184
|
+
setTitle(title: string): void;
|
|
4185
|
+
|
|
4186
|
+
/**
|
|
4187
|
+
* A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
|
|
4188
|
+
* to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
|
|
4189
|
+
* @param functionName The name of the method to invoke
|
|
4190
|
+
* @param functionArguments An array of arguments to pass to every function
|
|
4191
|
+
* @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
|
|
4192
|
+
* @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
|
|
4193
|
+
*/
|
|
4194
|
+
callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
|
|
4195
|
+
|
|
4196
|
+
/**
|
|
4197
|
+
* 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.
|
|
4198
|
+
*/
|
|
4199
|
+
emitBubblingEvent(name: string): void;
|
|
4200
|
+
|
|
4201
|
+
/**
|
|
4202
|
+
* Convenience method for item.parent.removeChild( item )
|
|
4203
|
+
*/
|
|
4204
|
+
remove(): void;
|
|
4205
|
+
|
|
4206
|
+
/**
|
|
4207
|
+
* Removes the item from its current position in the layout and opens it in a window
|
|
4208
|
+
*/
|
|
4209
|
+
popout(): BrowserWindow;
|
|
4210
|
+
|
|
4211
|
+
/**
|
|
4212
|
+
* Maximises the item or minimises it if it's already maximised
|
|
4213
|
+
*/
|
|
4214
|
+
toggleMaximise(): void;
|
|
4215
|
+
|
|
4216
|
+
/**
|
|
4217
|
+
* Selects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4218
|
+
*/
|
|
4219
|
+
select(): void;
|
|
4220
|
+
|
|
4221
|
+
/**
|
|
4222
|
+
* Unselects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4223
|
+
*/
|
|
4224
|
+
deselect(): void;
|
|
4225
|
+
|
|
4226
|
+
/**
|
|
4227
|
+
* Returns true if the item has the specified id or false if not
|
|
4228
|
+
* @param id An id to check for
|
|
4229
|
+
*/
|
|
4230
|
+
hasId(id: string): boolean;
|
|
4231
|
+
|
|
4232
|
+
/**
|
|
4233
|
+
* Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
|
|
4234
|
+
* @param contentItem The new active content item
|
|
4235
|
+
* @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
|
|
4236
|
+
*/
|
|
4237
|
+
// (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
|
|
4238
|
+
setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
|
|
4239
|
+
|
|
4240
|
+
/**
|
|
4241
|
+
* Only Stacks have this method! Returns the currently selected contentItem.
|
|
4242
|
+
*/
|
|
4243
|
+
getActiveContentItem(): ContentItem;
|
|
4244
|
+
|
|
4245
|
+
/**
|
|
4246
|
+
* Adds an id to an item or does nothing if the id is already present
|
|
4247
|
+
* @param id The id to be added
|
|
4248
|
+
*/
|
|
4249
|
+
addId(id: string): void;
|
|
4250
|
+
|
|
4251
|
+
/**
|
|
4252
|
+
* Removes an id from an item or throws an error if the id couldn't be found
|
|
4253
|
+
* @param id The id to be removed
|
|
4254
|
+
*/
|
|
4255
|
+
removeId(id: string): void;
|
|
4256
|
+
|
|
4257
|
+
/**
|
|
4258
|
+
* Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
|
|
4259
|
+
* @param filterFunction A function that determines whether an item matches certain criteria
|
|
4260
|
+
*/
|
|
4261
|
+
getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
|
|
4262
|
+
|
|
4263
|
+
/**
|
|
4264
|
+
* Returns all items with the specified id.
|
|
4265
|
+
* @param id An id specified in the itemConfig
|
|
4266
|
+
*/
|
|
4267
|
+
getItemsById(id: string | string[]): ContentItem[];
|
|
4268
|
+
|
|
4269
|
+
/**
|
|
4270
|
+
* Returns all items with the specified type
|
|
4271
|
+
* @param type 'row', 'column', 'stack', 'component' or 'root'
|
|
4272
|
+
*/
|
|
4273
|
+
getItemsByType(type: string): ContentItem[];
|
|
4274
|
+
|
|
4275
|
+
/**
|
|
4276
|
+
* Returns all instances of the component with the specified componentName
|
|
4277
|
+
* @param componentName a componentName as specified in the itemConfig
|
|
4278
|
+
*/
|
|
4279
|
+
getComponentsByName(componentName: string): any;
|
|
4280
|
+
|
|
4281
|
+
_contentAreaDimensions: any;
|
|
4282
|
+
_$getArea: () => any;
|
|
4283
|
+
}
|
|
4284
|
+
|
|
3930
4285
|
/**
|
|
3931
4286
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
3932
4287
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
@@ -4411,6 +4766,46 @@ declare type DidFinishLoadEvent = NamedEvent & {
|
|
|
4411
4766
|
type: 'did-finish-load';
|
|
4412
4767
|
};
|
|
4413
4768
|
|
|
4769
|
+
declare interface Dimensions {
|
|
4770
|
+
/**
|
|
4771
|
+
* The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
|
|
4772
|
+
* than the visible one, making it safe to set this to small values without affecting usability.
|
|
4773
|
+
* Default: 5
|
|
4774
|
+
*/
|
|
4775
|
+
borderWidth?: number;
|
|
4776
|
+
|
|
4777
|
+
/**
|
|
4778
|
+
* The minimum height an item can be resized to (in pixel).
|
|
4779
|
+
* Default: 10
|
|
4780
|
+
*/
|
|
4781
|
+
minItemHeight?: number;
|
|
4782
|
+
|
|
4783
|
+
/**
|
|
4784
|
+
* The minimum width an item can be resized to (in pixel).
|
|
4785
|
+
* Default: 10
|
|
4786
|
+
*/
|
|
4787
|
+
minItemWidth?: number;
|
|
4788
|
+
|
|
4789
|
+
/**
|
|
4790
|
+
* The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
|
|
4791
|
+
* adjusted accordingly.
|
|
4792
|
+
* Default: 20
|
|
4793
|
+
*/
|
|
4794
|
+
headerHeight?: number;
|
|
4795
|
+
|
|
4796
|
+
/**
|
|
4797
|
+
* The width of the element that appears when an item is dragged (in pixel).
|
|
4798
|
+
* Default: 300
|
|
4799
|
+
*/
|
|
4800
|
+
dragProxyWidth?: number;
|
|
4801
|
+
|
|
4802
|
+
/**
|
|
4803
|
+
* The height of the element that appears when an item is dragged (in pixel).
|
|
4804
|
+
* Default: 200
|
|
4805
|
+
*/
|
|
4806
|
+
dragProxyHeight?: number;
|
|
4807
|
+
}
|
|
4808
|
+
|
|
4414
4809
|
/**
|
|
4415
4810
|
* @interface
|
|
4416
4811
|
*/
|
|
@@ -4527,25 +4922,6 @@ declare type DisplayMetadata_3 = {
|
|
|
4527
4922
|
readonly glyph?: string;
|
|
4528
4923
|
};
|
|
4529
4924
|
|
|
4530
|
-
/**
|
|
4531
|
-
* @interface
|
|
4532
|
-
*
|
|
4533
|
-
* Rules for domain-conditional `fin` API injection.
|
|
4534
|
-
*
|
|
4535
|
-
* @remarks Subset of {@link DomainSettings}.
|
|
4536
|
-
*/
|
|
4537
|
-
declare type DomainApiSettings = {
|
|
4538
|
-
/**
|
|
4539
|
-
* Injection setting for the `fin` API for contexts on a matched domain.
|
|
4540
|
-
*
|
|
4541
|
-
* * 'none': The `fin` API will be not available.
|
|
4542
|
-
* * 'global': The entire `fin` API will be available.
|
|
4543
|
-
*
|
|
4544
|
-
* @defaultValue 'global'
|
|
4545
|
-
*/
|
|
4546
|
-
fin: InjectionType;
|
|
4547
|
-
};
|
|
4548
|
-
|
|
4549
4925
|
/**
|
|
4550
4926
|
* @interface
|
|
4551
4927
|
* Defines application settings that vary by the domain of the current context.
|
|
@@ -4584,7 +4960,7 @@ declare type DomainSettingsRule = {
|
|
|
4584
4960
|
/**
|
|
4585
4961
|
* {@inheritDoc ApiInjection}
|
|
4586
4962
|
*/
|
|
4587
|
-
api?:
|
|
4963
|
+
api?: ApiInjection;
|
|
4588
4964
|
};
|
|
4589
4965
|
};
|
|
4590
4966
|
|
|
@@ -4623,19 +4999,18 @@ declare type DownloadPreloadOption = {
|
|
|
4623
4999
|
/**
|
|
4624
5000
|
* @interface
|
|
4625
5001
|
*
|
|
4626
|
-
* A rule
|
|
5002
|
+
* A rule governing domain-conditional download behavior.
|
|
4627
5003
|
*/
|
|
4628
5004
|
declare type DownloadRule = {
|
|
4629
5005
|
/**
|
|
4630
|
-
* {@inheritDoc
|
|
5006
|
+
* {@inheritDoc FileDownloadBehaviorNames}
|
|
4631
5007
|
*/
|
|
4632
|
-
behavior:
|
|
5008
|
+
behavior: FileDownloadBehaviorNames;
|
|
4633
5009
|
/**
|
|
4634
5010
|
* Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
|
|
4635
|
-
*
|
|
5011
|
+
* the domain(s) for which the rule applies.
|
|
4636
5012
|
*
|
|
4637
|
-
* @remarks The match is evaluated against the URL of the *
|
|
4638
|
-
* of the page in which a file download link is embedded.
|
|
5013
|
+
* @remarks The match is evaluated against the URL of the *download*.
|
|
4639
5014
|
*/
|
|
4640
5015
|
match: string[];
|
|
4641
5016
|
};
|
|
@@ -4707,6 +5082,8 @@ declare type Dpi = {
|
|
|
4707
5082
|
vertical?: number;
|
|
4708
5083
|
};
|
|
4709
5084
|
|
|
5085
|
+
declare interface DragSource {}
|
|
5086
|
+
|
|
4710
5087
|
/**
|
|
4711
5088
|
* Generated when a window has been embedded.
|
|
4712
5089
|
* @interface
|
|
@@ -4979,7 +5356,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
|
4979
5356
|
*/
|
|
4980
5357
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
4981
5358
|
target: OpenFin.Identity;
|
|
4982
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent
|
|
5359
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
4983
5360
|
|
|
4984
5361
|
/**
|
|
4985
5362
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
@@ -4987,7 +5364,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
|
4987
5364
|
*/
|
|
4988
5365
|
declare type Event_5<Topic extends string> = {
|
|
4989
5366
|
topic: Topic;
|
|
4990
|
-
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent
|
|
5367
|
+
} & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
|
|
4991
5368
|
|
|
4992
5369
|
/**
|
|
4993
5370
|
* [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
|
|
@@ -5023,12 +5400,51 @@ declare class EventAggregator extends EmitterMap {
|
|
|
5023
5400
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5024
5401
|
}
|
|
5025
5402
|
|
|
5403
|
+
declare interface EventEmitter_2 {
|
|
5404
|
+
[x: string]: any;
|
|
5405
|
+
/**
|
|
5406
|
+
* Subscribe to an event
|
|
5407
|
+
* @param eventName The name of the event to describe to
|
|
5408
|
+
* @param callback The function that should be invoked when the event occurs
|
|
5409
|
+
* @param context The value of the this pointer in the callback function
|
|
5410
|
+
*/
|
|
5411
|
+
on(eventName: string, callback: Function, context?: any): void;
|
|
5412
|
+
|
|
5413
|
+
/**
|
|
5414
|
+
* Notify listeners of an event and pass arguments along
|
|
5415
|
+
* @param eventName The name of the event to emit
|
|
5416
|
+
*/
|
|
5417
|
+
emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5418
|
+
|
|
5419
|
+
/**
|
|
5420
|
+
* Alias for emit
|
|
5421
|
+
*/
|
|
5422
|
+
trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5423
|
+
|
|
5424
|
+
/**
|
|
5425
|
+
* Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
|
|
5426
|
+
* eventName and callback or just a specific callback with a specific context if invoked with all three
|
|
5427
|
+
* arguments.
|
|
5428
|
+
* @param eventName The name of the event to unsubscribe from
|
|
5429
|
+
* @param callback The function that should be invoked when the event occurs
|
|
5430
|
+
* @param context The value of the this pointer in the callback function
|
|
5431
|
+
*/
|
|
5432
|
+
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
5433
|
+
|
|
5434
|
+
/**
|
|
5435
|
+
* Alias for unbind
|
|
5436
|
+
*/
|
|
5437
|
+
off(eventName: string, callback?: Function, context?: any): void;
|
|
5438
|
+
}
|
|
5439
|
+
|
|
5026
5440
|
/**
|
|
5027
5441
|
* Handler for an event on an EventEmitter.
|
|
5028
5442
|
* @remarks Selects the correct type for the event
|
|
5029
5443
|
* payload from the provided union based on the provided string literal type.
|
|
5030
5444
|
*/
|
|
5031
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
5445
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
|
|
5446
|
+
type: EventType;
|
|
5447
|
+
}>, ...args: any[]) => void;
|
|
5032
5448
|
|
|
5033
5449
|
declare namespace Events {
|
|
5034
5450
|
export {
|
|
@@ -5180,7 +5596,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5180
5596
|
ExternalApplicationEvent,
|
|
5181
5597
|
EventType_4 as EventType,
|
|
5182
5598
|
ExternalApplicationEventType,
|
|
5183
|
-
|
|
5599
|
+
Payload_5 as Payload,
|
|
5184
5600
|
ByType_4 as ByType
|
|
5185
5601
|
}
|
|
5186
5602
|
}
|
|
@@ -5326,12 +5742,7 @@ declare type FetchManifestPayload = {
|
|
|
5326
5742
|
/**
|
|
5327
5743
|
* Whether file downloads raise a user prompt.
|
|
5328
5744
|
*/
|
|
5329
|
-
declare type
|
|
5330
|
-
|
|
5331
|
-
/**
|
|
5332
|
-
* @deprecated Renamed to {@link FileDownloadBehavior}.
|
|
5333
|
-
*/
|
|
5334
|
-
declare type FileDownloadBehaviorNames = FileDownloadBehavior;
|
|
5745
|
+
declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
|
|
5335
5746
|
|
|
5336
5747
|
/**
|
|
5337
5748
|
* Generated when a file download has completed.
|
|
@@ -5584,8 +5995,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5584
5995
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5585
5996
|
* currently embedded in.
|
|
5586
5997
|
*
|
|
5587
|
-
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5588
|
-
*
|
|
5589
5998
|
* @example
|
|
5590
5999
|
* ```js
|
|
5591
6000
|
* async function getParentWindow() {
|
|
@@ -5627,7 +6036,7 @@ declare namespace FrameEvents {
|
|
|
5627
6036
|
FrameEvent,
|
|
5628
6037
|
EventType_5 as EventType,
|
|
5629
6038
|
FrameEventType,
|
|
5630
|
-
|
|
6039
|
+
Payload_6 as Payload,
|
|
5631
6040
|
ByType_5 as ByType
|
|
5632
6041
|
}
|
|
5633
6042
|
}
|
|
@@ -5853,34 +6262,267 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
|
5853
6262
|
* });
|
|
5854
6263
|
* ```
|
|
5855
6264
|
*/
|
|
5856
|
-
isRegistered(hotkey: string): Promise<boolean>;
|
|
5857
|
-
}
|
|
6265
|
+
isRegistered(hotkey: string): Promise<boolean>;
|
|
6266
|
+
}
|
|
6267
|
+
|
|
6268
|
+
/**
|
|
6269
|
+
* @deprecated Renamed to {@link Event}.
|
|
6270
|
+
*/
|
|
6271
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
6272
|
+
|
|
6273
|
+
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6274
|
+
|
|
6275
|
+
declare namespace GlobalHotkeyEvents {
|
|
6276
|
+
export {
|
|
6277
|
+
BaseEvent_8 as BaseEvent,
|
|
6278
|
+
RegisteredEvent,
|
|
6279
|
+
UnregisteredEvent,
|
|
6280
|
+
Event_9 as Event,
|
|
6281
|
+
GlobalHotkeyEvent,
|
|
6282
|
+
EventType_6 as EventType,
|
|
6283
|
+
GlobalHotkeyEventType,
|
|
6284
|
+
Payload_7 as Payload,
|
|
6285
|
+
ByType_6 as ByType
|
|
6286
|
+
}
|
|
6287
|
+
}
|
|
6288
|
+
|
|
6289
|
+
/**
|
|
6290
|
+
* @deprecated Renamed to {@link EventType}.
|
|
6291
|
+
*/
|
|
6292
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
6293
|
+
|
|
6294
|
+
declare namespace GoldenLayout {
|
|
6295
|
+
export {
|
|
6296
|
+
GoldenLayout_2 as GoldenLayout,
|
|
6297
|
+
ItemConfigType,
|
|
6298
|
+
Settings,
|
|
6299
|
+
Dimensions,
|
|
6300
|
+
Labels,
|
|
6301
|
+
ItemType,
|
|
6302
|
+
ItemConfig,
|
|
6303
|
+
ComponentConfig,
|
|
6304
|
+
ReactComponentConfig,
|
|
6305
|
+
Config,
|
|
6306
|
+
ContentItem,
|
|
6307
|
+
Container,
|
|
6308
|
+
DragSource,
|
|
6309
|
+
BrowserWindow,
|
|
6310
|
+
Header,
|
|
6311
|
+
TabDragListener,
|
|
6312
|
+
Tab,
|
|
6313
|
+
EventEmitter_2 as EventEmitter
|
|
6314
|
+
}
|
|
6315
|
+
}
|
|
6316
|
+
|
|
6317
|
+
declare class GoldenLayout_2 implements EventEmitter_2 {
|
|
6318
|
+
/**
|
|
6319
|
+
* The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
|
|
6320
|
+
* object and of goldenLayout.root as the document.
|
|
6321
|
+
*/
|
|
6322
|
+
root: ContentItem;
|
|
6323
|
+
|
|
6324
|
+
/**
|
|
6325
|
+
* A reference to the (jQuery) DOM element containing the layout
|
|
6326
|
+
*/
|
|
6327
|
+
container: JQuery;
|
|
6328
|
+
|
|
6329
|
+
/**
|
|
6330
|
+
* True once the layout item tree has been created and the initialised event has been fired
|
|
6331
|
+
*/
|
|
6332
|
+
isInitialised: boolean;
|
|
6333
|
+
|
|
6334
|
+
/**
|
|
6335
|
+
* A reference to the current, extended top level config.
|
|
6336
|
+
*
|
|
6337
|
+
* Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
|
|
6338
|
+
*/
|
|
6339
|
+
config: Config;
|
|
6340
|
+
|
|
6341
|
+
/**
|
|
6342
|
+
* The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
|
|
6343
|
+
* to true.
|
|
6344
|
+
*/
|
|
6345
|
+
selectedItem: ContentItem;
|
|
6346
|
+
|
|
6347
|
+
/**
|
|
6348
|
+
* The current outer width of the layout in pixels.
|
|
6349
|
+
*/
|
|
6350
|
+
width: number;
|
|
6351
|
+
|
|
6352
|
+
/**
|
|
6353
|
+
* The current outer height of the layout in pixels.
|
|
6354
|
+
*/
|
|
6355
|
+
height: number;
|
|
6356
|
+
|
|
6357
|
+
/**
|
|
6358
|
+
* An array of BrowserWindow instances
|
|
6359
|
+
*/
|
|
6360
|
+
openPopouts: BrowserWindow[];
|
|
6361
|
+
|
|
6362
|
+
/**
|
|
6363
|
+
* True if the layout has been opened as a popout by another layout.
|
|
6364
|
+
*/
|
|
6365
|
+
isSubWindow: boolean;
|
|
6366
|
+
|
|
6367
|
+
/**
|
|
6368
|
+
* A singleton instance of EventEmitter that works across windows
|
|
6369
|
+
*/
|
|
6370
|
+
eventHub: EventEmitter_2;
|
|
6371
|
+
|
|
6372
|
+
_dragProxy: any;
|
|
6373
|
+
|
|
6374
|
+
dropTargetIndicator: any;
|
|
6375
|
+
|
|
6376
|
+
/**
|
|
6377
|
+
* @param config A GoldenLayout configuration object
|
|
6378
|
+
* @param container The DOM element the layout will be initialised in. Default: document.body
|
|
6379
|
+
*/
|
|
6380
|
+
constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
|
|
6381
|
+
|
|
6382
|
+
/*
|
|
6383
|
+
* @param name The name of the component, as referred to by componentName in the component configuration.
|
|
6384
|
+
* @param component A constructor or factory function. Will be invoked with new and two arguments, a
|
|
6385
|
+
* containerobject and a component state
|
|
6386
|
+
*/
|
|
6387
|
+
registerComponent(name: String, component: any): void;
|
|
6388
|
+
|
|
6389
|
+
/**
|
|
6390
|
+
* Renders the layout into the container. If init() is called before the document is ready it attaches itself as
|
|
6391
|
+
* a listener to the document and executes once it becomes ready.
|
|
6392
|
+
*/
|
|
6393
|
+
init(): void;
|
|
6394
|
+
|
|
6395
|
+
/**
|
|
6396
|
+
* Returns the current state of the layout and its components as a serialisable object.
|
|
6397
|
+
*/
|
|
6398
|
+
toConfig(): Config;
|
|
6399
|
+
|
|
6400
|
+
/**
|
|
6401
|
+
* Returns a component that was previously registered with layout.registerComponent().
|
|
6402
|
+
* @param name The name of a previously registered component
|
|
6403
|
+
*/
|
|
6404
|
+
getComponent(name: string): any;
|
|
6405
|
+
|
|
6406
|
+
/**
|
|
6407
|
+
* Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
|
|
6408
|
+
* @param width The outer width the layout should be resized to. Default: The container elements width
|
|
6409
|
+
* @param height The outer height the layout should be resized to. Default: The container elements height
|
|
6410
|
+
*/
|
|
6411
|
+
updateSize(width?: number, height?: number): void;
|
|
6412
|
+
|
|
6413
|
+
/**
|
|
6414
|
+
* Destroys the layout. Recursively calls destroy on all components and content items, removes all event
|
|
6415
|
+
* listeners and finally removes itself from the DOM.
|
|
6416
|
+
*/
|
|
6417
|
+
destroy(): void;
|
|
6418
|
+
|
|
6419
|
+
/**
|
|
6420
|
+
* Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
|
|
6421
|
+
* directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
|
|
6422
|
+
* all call this method implicitly.
|
|
6423
|
+
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6424
|
+
* @param parent A parent item
|
|
6425
|
+
*/
|
|
6426
|
+
createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
|
|
6427
|
+
|
|
6428
|
+
/**
|
|
6429
|
+
* Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
|
|
6430
|
+
* @param configOrContentItem The content item or config that will be created in the new window. If a item is
|
|
6431
|
+
* provided its config will be read, if config is provided, only the content key
|
|
6432
|
+
* will be used
|
|
6433
|
+
* @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
|
|
6434
|
+
* place the window in another screen.
|
|
6435
|
+
* @param parentId The id of the item within the current layout the child window's content will be appended to
|
|
6436
|
+
* when popIn is clicked
|
|
6437
|
+
* @param indexInParent The index at which the child window's contents will be appended to. Default: null
|
|
6438
|
+
*/
|
|
6439
|
+
createPopout(
|
|
6440
|
+
configOrContentItem: ItemConfigType | ContentItem,
|
|
6441
|
+
dimensions: {
|
|
6442
|
+
width: number;
|
|
6443
|
+
height: number;
|
|
6444
|
+
left: number;
|
|
6445
|
+
top: number;
|
|
6446
|
+
},
|
|
6447
|
+
parentId?: string,
|
|
6448
|
+
indexInParent?: number
|
|
6449
|
+
): void;
|
|
6450
|
+
|
|
6451
|
+
/**
|
|
6452
|
+
* Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
|
|
6453
|
+
* where it turns into a contentItem.
|
|
6454
|
+
* @param element The DOM element that will be turned into a dragSource
|
|
6455
|
+
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6456
|
+
* @return the dragSource that was created. This can be used to remove the
|
|
6457
|
+
* dragSource from the layout later.
|
|
6458
|
+
*/
|
|
6459
|
+
createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
|
|
6460
|
+
|
|
6461
|
+
/**
|
|
6462
|
+
* Removes a dragSource from the layout.
|
|
6463
|
+
*
|
|
6464
|
+
* @param dragSource The dragSource to remove
|
|
6465
|
+
*/
|
|
6466
|
+
removeDragSource(dragSource: DragSource): void;
|
|
6467
|
+
|
|
6468
|
+
/**
|
|
6469
|
+
* If settings.selectionEnabled is set to true, this allows to select items programmatically.
|
|
6470
|
+
* @param contentItem A ContentItem instance
|
|
6471
|
+
*/
|
|
6472
|
+
selectItem(contentItem: ContentItem): void;
|
|
6473
|
+
|
|
6474
|
+
/**
|
|
6475
|
+
* Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
|
|
6476
|
+
* and replace frequent keys and values with single letter substitutes.
|
|
6477
|
+
* @param config A GoldenLayout configuration object
|
|
6478
|
+
*/
|
|
6479
|
+
static minifyConfig(config: any): any;
|
|
6480
|
+
|
|
6481
|
+
/**
|
|
6482
|
+
* Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
|
|
6483
|
+
* @param minifiedConfig A minified GoldenLayout configuration object
|
|
6484
|
+
*/
|
|
6485
|
+
static unminifyConfig(minifiedConfig: any): any;
|
|
5858
6486
|
|
|
5859
|
-
/**
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
6487
|
+
/**
|
|
6488
|
+
* Subscribe to an event
|
|
6489
|
+
* @param eventName The name of the event to describe to
|
|
6490
|
+
* @param callback The function that should be invoked when the event occurs
|
|
6491
|
+
* @param context The value of the this pointer in the callback function
|
|
6492
|
+
*/
|
|
6493
|
+
on(eventName: string, callback: Function, context?: any): void;
|
|
5863
6494
|
|
|
5864
|
-
|
|
6495
|
+
/**
|
|
6496
|
+
* Notify listeners of an event and pass arguments along
|
|
6497
|
+
* @param eventName The name of the event to emit
|
|
6498
|
+
*/
|
|
6499
|
+
emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5865
6500
|
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5870
|
-
UnregisteredEvent,
|
|
5871
|
-
Event_9 as Event,
|
|
5872
|
-
GlobalHotkeyEvent,
|
|
5873
|
-
EventType_6 as EventType,
|
|
5874
|
-
GlobalHotkeyEventType,
|
|
5875
|
-
Payload_8 as Payload,
|
|
5876
|
-
ByType_6 as ByType
|
|
5877
|
-
}
|
|
5878
|
-
}
|
|
6501
|
+
/**
|
|
6502
|
+
* Alias for emit
|
|
6503
|
+
*/
|
|
6504
|
+
trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5879
6505
|
|
|
5880
|
-
/**
|
|
5881
|
-
|
|
5882
|
-
|
|
5883
|
-
|
|
6506
|
+
/**
|
|
6507
|
+
* Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
|
|
6508
|
+
* eventName and callback or just a specific callback with a specific context if invoked with all three
|
|
6509
|
+
* arguments.
|
|
6510
|
+
* @param eventName The name of the event to unsubscribe from
|
|
6511
|
+
* @param callback The function that should be invoked when the event occurs
|
|
6512
|
+
* @param context The value of the this pointer in the callback function
|
|
6513
|
+
*/
|
|
6514
|
+
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
6515
|
+
|
|
6516
|
+
/**
|
|
6517
|
+
* Alias for unbind
|
|
6518
|
+
*/
|
|
6519
|
+
off(eventName: string, callback?: Function, context?: any): void;
|
|
6520
|
+
|
|
6521
|
+
/**
|
|
6522
|
+
* Internal method that create drop areas on the far edges of window, e.g. far-right of window
|
|
6523
|
+
*/
|
|
6524
|
+
_$createRootItemAreas(): void;
|
|
6525
|
+
}
|
|
5884
6526
|
|
|
5885
6527
|
/**
|
|
5886
6528
|
* @interface
|
|
@@ -5889,6 +6531,62 @@ declare type GpuInfo = {
|
|
|
5889
6531
|
name: string;
|
|
5890
6532
|
};
|
|
5891
6533
|
|
|
6534
|
+
declare interface Header {
|
|
6535
|
+
/**
|
|
6536
|
+
* A reference to the LayoutManager instance
|
|
6537
|
+
*/
|
|
6538
|
+
layoutManager: GoldenLayout_2;
|
|
6539
|
+
|
|
6540
|
+
/**
|
|
6541
|
+
* A reference to the Stack this Header belongs to
|
|
6542
|
+
*/
|
|
6543
|
+
parent: ContentItem;
|
|
6544
|
+
|
|
6545
|
+
/**
|
|
6546
|
+
* An array of the Tabs within this header
|
|
6547
|
+
*/
|
|
6548
|
+
tabs: Tab[];
|
|
6549
|
+
|
|
6550
|
+
/**
|
|
6551
|
+
* The currently selected activeContentItem
|
|
6552
|
+
*/
|
|
6553
|
+
activeContentItem: ContentItem;
|
|
6554
|
+
|
|
6555
|
+
/**
|
|
6556
|
+
* The outer (jQuery) DOM element of this Header
|
|
6557
|
+
*/
|
|
6558
|
+
element: JQuery;
|
|
6559
|
+
|
|
6560
|
+
/**
|
|
6561
|
+
* The (jQuery) DOM element containing the tabs
|
|
6562
|
+
*/
|
|
6563
|
+
tabsContainer: JQuery;
|
|
6564
|
+
|
|
6565
|
+
/**
|
|
6566
|
+
* The (jQuery) DOM element containing the close, maximise and popout button
|
|
6567
|
+
*/
|
|
6568
|
+
controlsContainer: JQuery;
|
|
6569
|
+
|
|
6570
|
+
/**
|
|
6571
|
+
* Hides the currently selected contentItem, shows the specified one and highlights its tab.
|
|
6572
|
+
* @param contentItem The content item that will be selected
|
|
6573
|
+
*/
|
|
6574
|
+
setActiveContentItem(contentItem: ContentItem): void;
|
|
6575
|
+
|
|
6576
|
+
/**
|
|
6577
|
+
* Creates a new tab and associates it with a content item
|
|
6578
|
+
* @param contentItem The content item the tab will be associated with
|
|
6579
|
+
* @param index A zero based index, specifying the position of the new tab
|
|
6580
|
+
*/
|
|
6581
|
+
createTab(contentItem: ContentItem, index?: number): void;
|
|
6582
|
+
|
|
6583
|
+
/**
|
|
6584
|
+
* Finds a tab by its contentItem and removes it
|
|
6585
|
+
* @param contentItem The content item the tab is associated with
|
|
6586
|
+
*/
|
|
6587
|
+
removeTab(contentItem: ContentItem): void;
|
|
6588
|
+
}
|
|
6589
|
+
|
|
5892
6590
|
/**
|
|
5893
6591
|
* Generated when a View is hidden.
|
|
5894
6592
|
* @interface
|
|
@@ -6148,13 +6846,6 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
|
|
|
6148
6846
|
metadata?: MetadataType;
|
|
6149
6847
|
};
|
|
6150
6848
|
|
|
6151
|
-
declare type InheritableOptions = {
|
|
6152
|
-
customContext: boolean;
|
|
6153
|
-
customData: boolean;
|
|
6154
|
-
icon: boolean;
|
|
6155
|
-
preloadScripts: boolean;
|
|
6156
|
-
};
|
|
6157
|
-
|
|
6158
6849
|
/**
|
|
6159
6850
|
* Initialize a remote connection as a "host" application.
|
|
6160
6851
|
* @param {InitOptions} options init options
|
|
@@ -6619,15 +7310,6 @@ declare class InteropBroker extends Base {
|
|
|
6619
7310
|
setContext({ context }: {
|
|
6620
7311
|
context: OpenFin.Context;
|
|
6621
7312
|
}, clientIdentity: OpenFin.ClientIdentity): void;
|
|
6622
|
-
/**
|
|
6623
|
-
* Sets a context for the context group.
|
|
6624
|
-
* @param setContextOptions - New context to set.
|
|
6625
|
-
* @param contextGroupId - Context group id.
|
|
6626
|
-
*
|
|
6627
|
-
*/
|
|
6628
|
-
setContextForGroup({ context }: {
|
|
6629
|
-
context: OpenFin.Context;
|
|
6630
|
-
}, contextGroupId: string): void;
|
|
6631
7313
|
/**
|
|
6632
7314
|
* Get current context for a client subscribed to a Context Group.
|
|
6633
7315
|
*
|
|
@@ -7604,6 +8286,50 @@ declare class InteropModule extends Base {
|
|
|
7604
8286
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
|
7605
8287
|
}
|
|
7606
8288
|
|
|
8289
|
+
declare interface ItemConfig {
|
|
8290
|
+
/**
|
|
8291
|
+
* The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
|
|
8292
|
+
*/
|
|
8293
|
+
type: ItemType;
|
|
8294
|
+
|
|
8295
|
+
/**
|
|
8296
|
+
* An array of configurations for items that will be created as children of this item.
|
|
8297
|
+
*/
|
|
8298
|
+
content?: ItemConfigType[];
|
|
8299
|
+
|
|
8300
|
+
/**
|
|
8301
|
+
* The width of this item, relative to the other children of its parent in percent
|
|
8302
|
+
*/
|
|
8303
|
+
width?: number;
|
|
8304
|
+
|
|
8305
|
+
/**
|
|
8306
|
+
* The height of this item, relative to the other children of its parent in percent
|
|
8307
|
+
*/
|
|
8308
|
+
height?: number;
|
|
8309
|
+
|
|
8310
|
+
/**
|
|
8311
|
+
* A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
|
|
8312
|
+
*/
|
|
8313
|
+
id?: string | string[];
|
|
8314
|
+
|
|
8315
|
+
/**
|
|
8316
|
+
* Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
|
|
8317
|
+
* will return false
|
|
8318
|
+
* Default: true
|
|
8319
|
+
*/
|
|
8320
|
+
isClosable?: boolean;
|
|
8321
|
+
|
|
8322
|
+
/**
|
|
8323
|
+
* The title of the item as displayed on its tab and on popout windows
|
|
8324
|
+
* Default: componentName or ''
|
|
8325
|
+
*/
|
|
8326
|
+
title?: string;
|
|
8327
|
+
}
|
|
8328
|
+
|
|
8329
|
+
declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
|
|
8330
|
+
|
|
8331
|
+
declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
|
|
8332
|
+
|
|
7607
8333
|
/**
|
|
7608
8334
|
* @interface
|
|
7609
8335
|
*/
|
|
@@ -7661,6 +8387,32 @@ declare type JumpListTask = {
|
|
|
7661
8387
|
iconIndex?: number;
|
|
7662
8388
|
};
|
|
7663
8389
|
|
|
8390
|
+
declare interface Labels {
|
|
8391
|
+
/**
|
|
8392
|
+
* The tooltip text that appears when hovering over the close icon.
|
|
8393
|
+
* Default: 'close'
|
|
8394
|
+
*/
|
|
8395
|
+
close?: string;
|
|
8396
|
+
|
|
8397
|
+
/**
|
|
8398
|
+
* The tooltip text that appears when hovering over the maximise icon.
|
|
8399
|
+
* Default: 'maximise'
|
|
8400
|
+
*/
|
|
8401
|
+
maximise?: string;
|
|
8402
|
+
|
|
8403
|
+
/**
|
|
8404
|
+
* The tooltip text that appears when hovering over the minimise icon.
|
|
8405
|
+
* Default: 'minimise'
|
|
8406
|
+
*/
|
|
8407
|
+
minimise?: string;
|
|
8408
|
+
|
|
8409
|
+
/**
|
|
8410
|
+
* The tooltip text that appears when hovering over the popout icon.
|
|
8411
|
+
* Default: 'open in new window'
|
|
8412
|
+
*/
|
|
8413
|
+
popout?: string;
|
|
8414
|
+
}
|
|
8415
|
+
|
|
7664
8416
|
/**
|
|
7665
8417
|
* The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
|
|
7666
8418
|
*
|
|
@@ -7739,7 +8491,6 @@ declare type LaunchExternalProcessRule = {
|
|
|
7739
8491
|
*/
|
|
7740
8492
|
declare type LaunchIntoPlatformPayload = {
|
|
7741
8493
|
manifest: any;
|
|
7742
|
-
manifestUrl?: string;
|
|
7743
8494
|
};
|
|
7744
8495
|
|
|
7745
8496
|
/**
|
|
@@ -8092,7 +8843,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
|
|
|
8092
8843
|
entityId: string;
|
|
8093
8844
|
};
|
|
8094
8845
|
|
|
8095
|
-
declare type LayoutEntityTypes =
|
|
8846
|
+
declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
|
|
8096
8847
|
|
|
8097
8848
|
/**
|
|
8098
8849
|
* @interface
|
|
@@ -9093,7 +9844,7 @@ declare type MutableViewOptions = {
|
|
|
9093
9844
|
/**
|
|
9094
9845
|
* Configurations for API injection.
|
|
9095
9846
|
*/
|
|
9096
|
-
api:
|
|
9847
|
+
api: Api;
|
|
9097
9848
|
/**
|
|
9098
9849
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
9099
9850
|
* In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
|
|
@@ -9568,7 +10319,6 @@ declare namespace OpenFin {
|
|
|
9568
10319
|
WindowState,
|
|
9569
10320
|
AutoplayPolicyOptions,
|
|
9570
10321
|
ConstWindowOptions,
|
|
9571
|
-
InheritableOptions,
|
|
9572
10322
|
MutableWindowOptions,
|
|
9573
10323
|
WorkspacePlatformOptions,
|
|
9574
10324
|
WebRequestHeader,
|
|
@@ -9577,7 +10327,6 @@ declare namespace OpenFin {
|
|
|
9577
10327
|
ResizeRegion,
|
|
9578
10328
|
Accelerator,
|
|
9579
10329
|
Api,
|
|
9580
|
-
ApiSettings,
|
|
9581
10330
|
InjectionType,
|
|
9582
10331
|
NavigationRules,
|
|
9583
10332
|
ContentNavigation,
|
|
@@ -9729,9 +10478,7 @@ declare namespace OpenFin {
|
|
|
9729
10478
|
DefaultDomainSettingsRule,
|
|
9730
10479
|
DomainSettings,
|
|
9731
10480
|
ApiInjection,
|
|
9732
|
-
DomainApiSettings,
|
|
9733
10481
|
DomainSettingsRule,
|
|
9734
|
-
FileDownloadBehavior,
|
|
9735
10482
|
FileDownloadBehaviorNames,
|
|
9736
10483
|
FileDownloadSettings,
|
|
9737
10484
|
DownloadRule,
|
|
@@ -9739,7 +10486,6 @@ declare namespace OpenFin {
|
|
|
9739
10486
|
Intent_2 as Intent,
|
|
9740
10487
|
IntentMetadata_3 as IntentMetadata,
|
|
9741
10488
|
IntentHandler_2 as IntentHandler,
|
|
9742
|
-
ContentCreationBehavior,
|
|
9743
10489
|
ContentCreationBehaviorNames,
|
|
9744
10490
|
MatchPattern,
|
|
9745
10491
|
BaseContentCreationRule,
|
|
@@ -9891,101 +10637,77 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
9891
10637
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
|
9892
10638
|
};
|
|
9893
10639
|
|
|
9894
|
-
/**
|
|
9895
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
9896
|
-
*
|
|
9897
|
-
* @see {@link ByType}
|
|
9898
|
-
*
|
|
9899
|
-
* @typeParam Type String key specifying the event to extract
|
|
9900
|
-
*/
|
|
9901
|
-
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
|
9902
|
-
|
|
9903
|
-
/**
|
|
9904
|
-
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
|
9905
|
-
*
|
|
9906
|
-
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
|
9907
|
-
* the appropriate payload union for that namespace.
|
|
9908
|
-
*
|
|
9909
|
-
* @typeParam Event Union of payloads for events on the given emitter
|
|
9910
|
-
* @see {@link ByType}
|
|
9911
|
-
*
|
|
9912
|
-
* @typeParam Type String key specifying the event to extract from the union
|
|
9913
|
-
*
|
|
9914
|
-
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
|
9915
|
-
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
|
9916
|
-
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
|
9917
|
-
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
|
9918
|
-
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
|
9919
|
-
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
|
9920
|
-
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
|
9921
|
-
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
|
9922
|
-
*/
|
|
9923
|
-
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
|
9924
|
-
type: EventType;
|
|
9925
|
-
}>;
|
|
9926
|
-
|
|
9927
10640
|
/**
|
|
9928
10641
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
9929
10642
|
*
|
|
9930
|
-
* @see {@link ByType}
|
|
9931
|
-
*
|
|
9932
10643
|
* @typeParam Type String key specifying the event to extract
|
|
9933
10644
|
*/
|
|
9934
|
-
declare type
|
|
10645
|
+
declare type Payload_2<Type extends EventType> = Extract<Event_4, {
|
|
10646
|
+
type: Type;
|
|
10647
|
+
}>;
|
|
9935
10648
|
|
|
9936
10649
|
/**
|
|
9937
10650
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
9938
10651
|
*
|
|
9939
|
-
* @see {@link ByType}
|
|
9940
|
-
*
|
|
9941
10652
|
* @typeParam Type String key specifying the event to extract
|
|
9942
10653
|
*/
|
|
9943
|
-
declare type
|
|
10654
|
+
declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
|
|
10655
|
+
type: Type;
|
|
10656
|
+
}>;
|
|
9944
10657
|
|
|
9945
10658
|
/**
|
|
9946
10659
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
9947
10660
|
*
|
|
9948
|
-
* @see {@link ByType}
|
|
9949
|
-
*
|
|
9950
10661
|
* @typeParam Type String key specifying the event to extract
|
|
9951
10662
|
*/
|
|
9952
|
-
declare type
|
|
10663
|
+
declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
|
|
10664
|
+
type: Type;
|
|
10665
|
+
}>;
|
|
9953
10666
|
|
|
9954
10667
|
/**
|
|
9955
10668
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
9956
10669
|
*
|
|
9957
|
-
* @see {@link ByType}
|
|
9958
|
-
*
|
|
9959
10670
|
* @typeParam Type String key specifying the event to extract
|
|
9960
10671
|
*/
|
|
9961
|
-
declare type
|
|
10672
|
+
declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
|
|
10673
|
+
type: Type;
|
|
10674
|
+
}>;
|
|
9962
10675
|
|
|
9963
10676
|
/**
|
|
9964
10677
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
9965
10678
|
*
|
|
9966
|
-
* @see {@link ByType}
|
|
9967
|
-
*
|
|
9968
10679
|
* @typeParam Type String key specifying the event to extract
|
|
9969
10680
|
*/
|
|
9970
|
-
declare type
|
|
10681
|
+
declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
|
|
10682
|
+
type: Type;
|
|
10683
|
+
}>;
|
|
9971
10684
|
|
|
9972
10685
|
/**
|
|
9973
10686
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
9974
10687
|
*
|
|
9975
|
-
* @see {@link ByType}
|
|
9976
|
-
*
|
|
9977
10688
|
* @typeParam Type String key specifying the event to extract
|
|
9978
10689
|
*/
|
|
9979
|
-
declare type
|
|
10690
|
+
declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
|
|
10691
|
+
type: Type;
|
|
10692
|
+
}>;
|
|
9980
10693
|
|
|
9981
10694
|
/**
|
|
9982
10695
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
9983
10696
|
*
|
|
9984
|
-
* @
|
|
10697
|
+
* @typeParam Type String key specifying the event to extract
|
|
10698
|
+
*/
|
|
10699
|
+
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
10700
|
+
type: Type;
|
|
10701
|
+
}>;
|
|
10702
|
+
|
|
10703
|
+
/**
|
|
10704
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
9985
10705
|
*
|
|
9986
10706
|
* @typeParam Type String key specifying the event to extract
|
|
9987
10707
|
*/
|
|
9988
|
-
declare type Payload_9<Type extends
|
|
10708
|
+
declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
|
|
10709
|
+
type: Type;
|
|
10710
|
+
}>;
|
|
9989
10711
|
|
|
9990
10712
|
declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
|
|
9991
10713
|
|
|
@@ -10679,7 +11401,7 @@ declare namespace PlatformEvents {
|
|
|
10679
11401
|
PlatformEvent,
|
|
10680
11402
|
EventType_7 as EventType,
|
|
10681
11403
|
PlatformEventType,
|
|
10682
|
-
|
|
11404
|
+
Payload_8 as Payload,
|
|
10683
11405
|
ByType_7 as ByType
|
|
10684
11406
|
}
|
|
10685
11407
|
}
|
|
@@ -10866,13 +11588,9 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
10866
11588
|
*/
|
|
10867
11589
|
providerUrl?: string;
|
|
10868
11590
|
/**
|
|
10869
|
-
*
|
|
10870
|
-
*
|
|
10871
|
-
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
10872
|
-
*
|
|
10873
|
-
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11591
|
+
* The permissions for secured APIs.
|
|
10874
11592
|
*/
|
|
10875
|
-
|
|
11593
|
+
permissions?: Partial<Permissions_2>;
|
|
10876
11594
|
};
|
|
10877
11595
|
|
|
10878
11596
|
/**
|
|
@@ -11677,7 +12395,7 @@ declare type PreloadScriptInfoRunning = {
|
|
|
11677
12395
|
* @interface
|
|
11678
12396
|
*/
|
|
11679
12397
|
declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
|
|
11680
|
-
type: 'preload-
|
|
12398
|
+
type: 'preload-script-state-changed';
|
|
11681
12399
|
};
|
|
11682
12400
|
|
|
11683
12401
|
/**
|
|
@@ -11694,7 +12412,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
|
|
|
11694
12412
|
* @interface
|
|
11695
12413
|
*/
|
|
11696
12414
|
declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
|
|
11697
|
-
type: 'preload-
|
|
12415
|
+
type: 'preload-script-state-changing';
|
|
11698
12416
|
};
|
|
11699
12417
|
|
|
11700
12418
|
declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
|
|
@@ -12120,7 +12838,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12120
12838
|
'interop-broker-remove-client-from-context-group': VoidCall;
|
|
12121
12839
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
12122
12840
|
'interop-broker-set-context': VoidCall;
|
|
12123
|
-
'interop-broker-set-context-for-group': VoidCall;
|
|
12124
12841
|
'query-permission-for-current-context': {
|
|
12125
12842
|
request: {
|
|
12126
12843
|
apiName: string;
|
|
@@ -12311,6 +13028,18 @@ declare type QueryPermissionResult = {
|
|
|
12311
13028
|
rawValue?: unknown;
|
|
12312
13029
|
};
|
|
12313
13030
|
|
|
13031
|
+
declare interface ReactComponentConfig extends ItemConfig {
|
|
13032
|
+
/**
|
|
13033
|
+
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
|
|
13034
|
+
*/
|
|
13035
|
+
component: string;
|
|
13036
|
+
|
|
13037
|
+
/**
|
|
13038
|
+
* Properties that will be passed to the component and accessible using this.props.
|
|
13039
|
+
*/
|
|
13040
|
+
props?: any;
|
|
13041
|
+
}
|
|
13042
|
+
|
|
12314
13043
|
/**
|
|
12315
13044
|
* @interface
|
|
12316
13045
|
*/
|
|
@@ -12398,15 +13127,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
|
12398
13127
|
token: string;
|
|
12399
13128
|
}
|
|
12400
13129
|
|
|
12401
|
-
/**
|
|
12402
|
-
* Generated when a View is removed from a layout.
|
|
12403
|
-
* @interface
|
|
12404
|
-
*/
|
|
12405
|
-
declare type RemovedFromLayoutEvent = BaseEvent_4 & {
|
|
12406
|
-
type: 'removed-from-layout';
|
|
12407
|
-
layoutIdentity: OpenFin.LayoutIdentity;
|
|
12408
|
-
};
|
|
12409
|
-
|
|
12410
13130
|
/**
|
|
12411
13131
|
* @interface
|
|
12412
13132
|
*/
|
|
@@ -12826,6 +13546,97 @@ declare type SessionContextGroup = {
|
|
|
12826
13546
|
}>;
|
|
12827
13547
|
};
|
|
12828
13548
|
|
|
13549
|
+
declare interface Settings {
|
|
13550
|
+
preventSplitterResize?: boolean;
|
|
13551
|
+
|
|
13552
|
+
newTabButton?: {
|
|
13553
|
+
url?: string;
|
|
13554
|
+
};
|
|
13555
|
+
|
|
13556
|
+
/**
|
|
13557
|
+
* If true, tabs can't be dragged into the window.
|
|
13558
|
+
* Default: false
|
|
13559
|
+
*/
|
|
13560
|
+
preventDragIn?: boolean;
|
|
13561
|
+
|
|
13562
|
+
/**
|
|
13563
|
+
* If true, tabs can't be dragged out of the window.
|
|
13564
|
+
* Default: false
|
|
13565
|
+
*/
|
|
13566
|
+
preventDragOut?: boolean;
|
|
13567
|
+
|
|
13568
|
+
/**
|
|
13569
|
+
* If true, stack headers are the only areas where tabs can be dropped.
|
|
13570
|
+
* Default: false
|
|
13571
|
+
*/
|
|
13572
|
+
constrainDragToHeaders?: boolean;
|
|
13573
|
+
/**
|
|
13574
|
+
* Turns headers on or off. If false, the layout will be displayed with splitters only.
|
|
13575
|
+
* Default: true
|
|
13576
|
+
*/
|
|
13577
|
+
hasHeaders?: boolean;
|
|
13578
|
+
|
|
13579
|
+
/**
|
|
13580
|
+
* (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
|
|
13581
|
+
* automatically when layout.createDragSource() is called.
|
|
13582
|
+
* Default: true
|
|
13583
|
+
*/
|
|
13584
|
+
constrainDragToContainer?: boolean;
|
|
13585
|
+
|
|
13586
|
+
/**
|
|
13587
|
+
* If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
|
|
13588
|
+
* Default: true
|
|
13589
|
+
*/
|
|
13590
|
+
reorderEnabled?: boolean;
|
|
13591
|
+
|
|
13592
|
+
/**
|
|
13593
|
+
* If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
|
|
13594
|
+
* the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
|
|
13595
|
+
* Default: false
|
|
13596
|
+
*/
|
|
13597
|
+
selectionEnabled?: boolean;
|
|
13598
|
+
|
|
13599
|
+
/**
|
|
13600
|
+
* Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
|
|
13601
|
+
* be transferred to the new window, if false only the active component will be opened.
|
|
13602
|
+
* Default: false
|
|
13603
|
+
*/
|
|
13604
|
+
popoutWholeStack?: boolean;
|
|
13605
|
+
|
|
13606
|
+
/**
|
|
13607
|
+
* Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
|
|
13608
|
+
* If false, the popout call will fail silently.
|
|
13609
|
+
* Default: true
|
|
13610
|
+
*/
|
|
13611
|
+
blockedPopoutsThrowError?: boolean;
|
|
13612
|
+
|
|
13613
|
+
/**
|
|
13614
|
+
* Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
|
|
13615
|
+
* strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
|
|
13616
|
+
* addition, any changes made to popouts won't be stored after the parent is closed.
|
|
13617
|
+
* Default: true
|
|
13618
|
+
*/
|
|
13619
|
+
closePopoutsOnUnload?: boolean;
|
|
13620
|
+
|
|
13621
|
+
/**
|
|
13622
|
+
* Specifies if the popout icon should be displayed in the header-bar.
|
|
13623
|
+
* Default: true
|
|
13624
|
+
*/
|
|
13625
|
+
showPopoutIcon?: boolean;
|
|
13626
|
+
|
|
13627
|
+
/**
|
|
13628
|
+
* Specifies if the maximise icon should be displayed in the header-bar.
|
|
13629
|
+
* Default: true
|
|
13630
|
+
*/
|
|
13631
|
+
showMaximiseIcon?: boolean;
|
|
13632
|
+
|
|
13633
|
+
/**
|
|
13634
|
+
* Specifies if the close icon should be displayed in the header-bar.
|
|
13635
|
+
* Default: true
|
|
13636
|
+
*/
|
|
13637
|
+
showCloseIcon?: boolean;
|
|
13638
|
+
}
|
|
13639
|
+
|
|
12829
13640
|
/**
|
|
12830
13641
|
* @interface
|
|
12831
13642
|
*/
|
|
@@ -13049,7 +13860,7 @@ declare type Snapshot = {
|
|
|
13049
13860
|
* _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.
|
|
13050
13861
|
* @interface
|
|
13051
13862
|
*/
|
|
13052
|
-
declare type SnapshotAppliedEvent =
|
|
13863
|
+
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13053
13864
|
topic: 'application';
|
|
13054
13865
|
type: 'platform-snapshot-applied';
|
|
13055
13866
|
};
|
|
@@ -14661,7 +15472,7 @@ declare namespace SystemEvents {
|
|
|
14661
15472
|
SystemEvent,
|
|
14662
15473
|
EventType_8 as EventType,
|
|
14663
15474
|
SystemEventType,
|
|
14664
|
-
|
|
15475
|
+
Payload_9 as Payload,
|
|
14665
15476
|
ByType_8 as ByType
|
|
14666
15477
|
}
|
|
14667
15478
|
}
|
|
@@ -14734,6 +15545,59 @@ declare type SystemShutdownHandler = (shutdownEvent: {
|
|
|
14734
15545
|
proceed: () => void;
|
|
14735
15546
|
}) => void;
|
|
14736
15547
|
|
|
15548
|
+
declare interface Tab {
|
|
15549
|
+
_dragListener: TabDragListener;
|
|
15550
|
+
|
|
15551
|
+
/**
|
|
15552
|
+
* True if this tab is the selected tab
|
|
15553
|
+
*/
|
|
15554
|
+
isActive: boolean;
|
|
15555
|
+
|
|
15556
|
+
/**
|
|
15557
|
+
* A reference to the header this tab is a child of
|
|
15558
|
+
*/
|
|
15559
|
+
header: Header;
|
|
15560
|
+
|
|
15561
|
+
/**
|
|
15562
|
+
* A reference to the content item this tab relates to
|
|
15563
|
+
*/
|
|
15564
|
+
contentItem: ContentItem;
|
|
15565
|
+
|
|
15566
|
+
/**
|
|
15567
|
+
* The tabs outer (jQuery) DOM element
|
|
15568
|
+
*/
|
|
15569
|
+
element: JQuery;
|
|
15570
|
+
|
|
15571
|
+
/**
|
|
15572
|
+
* The (jQuery) DOM element containing the title
|
|
15573
|
+
*/
|
|
15574
|
+
titleElement: JQuery;
|
|
15575
|
+
|
|
15576
|
+
/**
|
|
15577
|
+
* The (jQuery) DOM element that closes the tab
|
|
15578
|
+
*/
|
|
15579
|
+
closeElement: JQuery;
|
|
15580
|
+
|
|
15581
|
+
/**
|
|
15582
|
+
* Sets the tab's title. Does not affect the contentItem's title!
|
|
15583
|
+
* @param title The new title
|
|
15584
|
+
*/
|
|
15585
|
+
setTitle(title: string): void;
|
|
15586
|
+
|
|
15587
|
+
/**
|
|
15588
|
+
* Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
|
|
15589
|
+
* @param isActive Whether the tab is active
|
|
15590
|
+
*/
|
|
15591
|
+
setActive(isActive: boolean): void;
|
|
15592
|
+
}
|
|
15593
|
+
|
|
15594
|
+
declare interface TabDragListener extends EventEmitter_2 {
|
|
15595
|
+
/**
|
|
15596
|
+
* A reference to the content item this tab relates to
|
|
15597
|
+
*/
|
|
15598
|
+
contentItem: ContentItem;
|
|
15599
|
+
}
|
|
15600
|
+
|
|
14737
15601
|
/**
|
|
14738
15602
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
14739
15603
|
*/
|
|
@@ -15711,8 +16575,6 @@ declare namespace ViewEvents {
|
|
|
15711
16575
|
BaseEvent_4 as BaseEvent,
|
|
15712
16576
|
BaseViewEvent,
|
|
15713
16577
|
TargetChangedEvent,
|
|
15714
|
-
AddedToLayoutEvent,
|
|
15715
|
-
RemovedFromLayoutEvent,
|
|
15716
16578
|
NonPropagatedViewEvent,
|
|
15717
16579
|
CreatedEvent,
|
|
15718
16580
|
DestroyedEvent,
|
|
@@ -15729,7 +16591,7 @@ declare namespace ViewEvents {
|
|
|
15729
16591
|
PropagatedViewEvent,
|
|
15730
16592
|
PropagatedEventType_2 as PropagatedEventType,
|
|
15731
16593
|
PropagatedViewEventType,
|
|
15732
|
-
|
|
16594
|
+
Payload_2 as Payload,
|
|
15733
16595
|
ByType
|
|
15734
16596
|
}
|
|
15735
16597
|
}
|
|
@@ -16912,8 +17774,7 @@ declare namespace WebContentsEvents {
|
|
|
16912
17774
|
Event_5 as Event,
|
|
16913
17775
|
WebContentsEvent,
|
|
16914
17776
|
WillPropagateWebContentsEvent,
|
|
16915
|
-
NonPropagatedWebContentsEvent
|
|
16916
|
-
WillRedirectEvent
|
|
17777
|
+
NonPropagatedWebContentsEvent
|
|
16917
17778
|
}
|
|
16918
17779
|
}
|
|
16919
17780
|
|
|
@@ -16991,15 +17852,14 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
|
|
|
16991
17852
|
declare type WillPropagateWindowEvent = WindowSourcedEvent;
|
|
16992
17853
|
|
|
16993
17854
|
/**
|
|
16994
|
-
* Generated
|
|
17855
|
+
* Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
|
|
16995
17856
|
* @interface
|
|
16996
17857
|
*/
|
|
16997
|
-
declare type WillRedirectEvent =
|
|
17858
|
+
declare type WillRedirectEvent = BaseEvent_5 & {
|
|
16998
17859
|
type: 'will-redirect';
|
|
16999
17860
|
blocked: boolean;
|
|
17000
17861
|
isInPlace: boolean;
|
|
17001
17862
|
url: string;
|
|
17002
|
-
isMainFrame: boolean;
|
|
17003
17863
|
};
|
|
17004
17864
|
|
|
17005
17865
|
/**
|
|
@@ -17024,6 +17884,10 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
|
|
|
17024
17884
|
* @internal
|
|
17025
17885
|
*/
|
|
17026
17886
|
constructor(wire: Transport, identity: OpenFin.Identity);
|
|
17887
|
+
/**
|
|
17888
|
+
* create a new window
|
|
17889
|
+
* @internal
|
|
17890
|
+
*/
|
|
17027
17891
|
createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
|
|
17028
17892
|
/**
|
|
17029
17893
|
* Retrieves an array of frame info objects representing the main frame and any
|
|
@@ -18147,6 +19011,7 @@ declare namespace WindowEvents {
|
|
|
18147
19011
|
AlertRequestedEvent,
|
|
18148
19012
|
AuthRequestedEvent,
|
|
18149
19013
|
EndLoadEvent,
|
|
19014
|
+
WillRedirectEvent,
|
|
18150
19015
|
ReloadedEvent,
|
|
18151
19016
|
OptionsChangedEvent,
|
|
18152
19017
|
WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
|
|
@@ -18208,7 +19073,7 @@ declare namespace WindowEvents {
|
|
|
18208
19073
|
PropagatedEvent_3 as PropagatedEvent,
|
|
18209
19074
|
PropagatedWindowEvent,
|
|
18210
19075
|
PropagatedWindowEventType,
|
|
18211
|
-
|
|
19076
|
+
Payload_3 as Payload,
|
|
18212
19077
|
ByType_2 as ByType
|
|
18213
19078
|
}
|
|
18214
19079
|
}
|
|
@@ -18394,7 +19259,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
|
|
|
18394
19259
|
* A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
|
|
18395
19260
|
* from {@link OpenFin.ViewEvents}.
|
|
18396
19261
|
*/
|
|
18397
|
-
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;
|
|
19262
|
+
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;
|
|
18398
19263
|
|
|
18399
19264
|
/**
|
|
18400
19265
|
* Generated when a child window starts loading.
|