@openfin/fdc3-api 36.80.11 → 36.80.25
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 +156 -1078
- package/out/fdc3-api-beta.d.ts +156 -1078
- package/out/fdc3-api-public.d.ts +156 -1078
- package/out/fdc3-api.d.ts +156 -1078
- package/package.json +1 -1
package/out/fdc3-api.d.ts
CHANGED
|
@@ -42,6 +42,15 @@ 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
|
+
|
|
45
54
|
/**
|
|
46
55
|
* Options to use when adding a view to a {@link TabStack}.
|
|
47
56
|
*
|
|
@@ -99,7 +108,7 @@ declare type ApiInjection = DomainApiSettings;
|
|
|
99
108
|
* Generated when a new Platform's API becomes responsive.
|
|
100
109
|
* @interface
|
|
101
110
|
*/
|
|
102
|
-
declare type ApiReadyEvent = BaseEvent & {
|
|
111
|
+
declare type ApiReadyEvent = BaseEvents.BaseEvent & {
|
|
103
112
|
topic: 'application';
|
|
104
113
|
type: 'platform-api-ready';
|
|
105
114
|
};
|
|
@@ -942,7 +951,7 @@ declare namespace ApplicationEvents {
|
|
|
942
951
|
PropagatedApplicationEvent,
|
|
943
952
|
PropagatedEventType_3 as PropagatedEventType,
|
|
944
953
|
PropagatedApplicationEventType,
|
|
945
|
-
|
|
954
|
+
Payload_5 as Payload,
|
|
946
955
|
ByType_3 as ByType
|
|
947
956
|
}
|
|
948
957
|
}
|
|
@@ -1184,9 +1193,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1184
1193
|
*/
|
|
1185
1194
|
mainWindowOptions: WindowCreationOptions;
|
|
1186
1195
|
/**
|
|
1187
|
-
* The name of the application
|
|
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>.
|
|
1188
1202
|
*
|
|
1189
|
-
*
|
|
1203
|
+
* This property will be deprecated in the future.
|
|
1190
1204
|
*/
|
|
1191
1205
|
name: string;
|
|
1192
1206
|
/**
|
|
@@ -1216,9 +1230,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1216
1230
|
url: string;
|
|
1217
1231
|
/**
|
|
1218
1232
|
* The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1221
|
-
* Note that `name` and `uuid` must match.
|
|
1233
|
+
* running in the OpenFin Runtime.
|
|
1222
1234
|
*/
|
|
1223
1235
|
uuid: string;
|
|
1224
1236
|
/**
|
|
@@ -1804,7 +1816,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
|
1804
1816
|
* A base Channel event.
|
|
1805
1817
|
* @interface
|
|
1806
1818
|
*/
|
|
1807
|
-
declare type BaseEvent_2 = NamedEvent & {
|
|
1819
|
+
declare type BaseEvent_2 = BaseEvents.NamedEvent & {
|
|
1808
1820
|
channelName: string;
|
|
1809
1821
|
channelId: string;
|
|
1810
1822
|
};
|
|
@@ -1874,6 +1886,7 @@ declare namespace BaseEvents {
|
|
|
1874
1886
|
NotCloseRequested,
|
|
1875
1887
|
PropagatedEventType,
|
|
1876
1888
|
PropagatedEvent,
|
|
1889
|
+
Payload_2 as Payload,
|
|
1877
1890
|
EventHandler,
|
|
1878
1891
|
BaseEvent,
|
|
1879
1892
|
IdentityEvent,
|
|
@@ -2007,48 +2020,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
|
2007
2020
|
behavior: 'browser';
|
|
2008
2021
|
};
|
|
2009
2022
|
|
|
2010
|
-
declare interface BrowserWindow {
|
|
2011
|
-
/**
|
|
2012
|
-
* True if the window has been opened and its GoldenLayout instance initialised.
|
|
2013
|
-
*/
|
|
2014
|
-
isInitialised: boolean;
|
|
2015
|
-
|
|
2016
|
-
/**
|
|
2017
|
-
* Creates a window configuration object from the Popout.
|
|
2018
|
-
*/
|
|
2019
|
-
toConfig(): {
|
|
2020
|
-
dimensions: {
|
|
2021
|
-
width: number;
|
|
2022
|
-
height: number;
|
|
2023
|
-
left: number;
|
|
2024
|
-
top: number;
|
|
2025
|
-
};
|
|
2026
|
-
content: Config;
|
|
2027
|
-
parentId: string;
|
|
2028
|
-
indexInParent: number;
|
|
2029
|
-
};
|
|
2030
|
-
|
|
2031
|
-
/**
|
|
2032
|
-
* Returns the GoldenLayout instance from the child window
|
|
2033
|
-
*/
|
|
2034
|
-
getGlInstance(): GoldenLayout_2;
|
|
2035
|
-
|
|
2036
|
-
/**
|
|
2037
|
-
* Returns the native Window object
|
|
2038
|
-
*/
|
|
2039
|
-
getWindow(): Window;
|
|
2040
|
-
|
|
2041
|
-
/**
|
|
2042
|
-
* Closes the popout
|
|
2043
|
-
*/
|
|
2044
|
-
close(): void;
|
|
2045
|
-
|
|
2046
|
-
/**
|
|
2047
|
-
* Returns the popout to its original position as specified in parentId and indexInParent
|
|
2048
|
-
*/
|
|
2049
|
-
popIn(): void;
|
|
2050
|
-
}
|
|
2051
|
-
|
|
2052
2023
|
/**
|
|
2053
2024
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
2054
2025
|
*
|
|
@@ -2056,7 +2027,7 @@ declare interface BrowserWindow {
|
|
|
2056
2027
|
*
|
|
2057
2028
|
* @typeParam Type String key specifying the event to extract
|
|
2058
2029
|
*/
|
|
2059
|
-
declare type ByType<Type extends EventType> =
|
|
2030
|
+
declare type ByType<Type extends EventType> = Payload_3<Type>;
|
|
2060
2031
|
|
|
2061
2032
|
/**
|
|
2062
2033
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
@@ -2065,7 +2036,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
|
2065
2036
|
*
|
|
2066
2037
|
* @typeParam Type String key specifying the event to extract
|
|
2067
2038
|
*/
|
|
2068
|
-
declare type ByType_2<Type extends EventType_2> =
|
|
2039
|
+
declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
|
2069
2040
|
|
|
2070
2041
|
/**
|
|
2071
2042
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
@@ -2074,7 +2045,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
|
2074
2045
|
*
|
|
2075
2046
|
* @typeParam Type String key specifying the event to extract
|
|
2076
2047
|
*/
|
|
2077
|
-
declare type ByType_3<Type extends EventType_3> =
|
|
2048
|
+
declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
|
2078
2049
|
|
|
2079
2050
|
/**
|
|
2080
2051
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
@@ -2083,7 +2054,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
|
2083
2054
|
*
|
|
2084
2055
|
* @typeParam Type String key specifying the event to extract
|
|
2085
2056
|
*/
|
|
2086
|
-
declare type ByType_4<Type extends EventType_4> =
|
|
2057
|
+
declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
|
2087
2058
|
|
|
2088
2059
|
/**
|
|
2089
2060
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
@@ -2092,7 +2063,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
|
2092
2063
|
*
|
|
2093
2064
|
* @typeParam Type String key specifying the event to extract
|
|
2094
2065
|
*/
|
|
2095
|
-
declare type ByType_5<Type extends EventType_5> =
|
|
2066
|
+
declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
|
2096
2067
|
|
|
2097
2068
|
/**
|
|
2098
2069
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
@@ -2101,7 +2072,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
|
2101
2072
|
*
|
|
2102
2073
|
* @typeParam Type String key specifying the event to extract
|
|
2103
2074
|
*/
|
|
2104
|
-
declare type ByType_6<Type extends EventType_6> =
|
|
2075
|
+
declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
|
2105
2076
|
|
|
2106
2077
|
/**
|
|
2107
2078
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
@@ -2110,7 +2081,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
|
2110
2081
|
*
|
|
2111
2082
|
* @typeParam Type String key specifying the event to extract
|
|
2112
2083
|
*/
|
|
2113
|
-
declare type ByType_7<Type extends EventType_7> =
|
|
2084
|
+
declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
|
2114
2085
|
|
|
2115
2086
|
/**
|
|
2116
2087
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
@@ -2119,7 +2090,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
|
2119
2090
|
*
|
|
2120
2091
|
* @typeParam Type String key specifying the event to extract
|
|
2121
2092
|
*/
|
|
2122
|
-
declare type ByType_8<Type extends EventType_8> =
|
|
2093
|
+
declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
|
2123
2094
|
|
|
2124
2095
|
/**
|
|
2125
2096
|
* Configuration for page capture.
|
|
@@ -3491,31 +3462,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
|
|
|
3491
3462
|
close(): Promise<void>;
|
|
3492
3463
|
}
|
|
3493
3464
|
|
|
3494
|
-
declare interface ComponentConfig extends ItemConfig {
|
|
3495
|
-
/**
|
|
3496
|
-
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
|
|
3497
|
-
*/
|
|
3498
|
-
componentName: string;
|
|
3499
|
-
|
|
3500
|
-
/**
|
|
3501
|
-
* A serialisable object. Will be passed to the component constructor function and will be the value returned by
|
|
3502
|
-
* container.getState().
|
|
3503
|
-
*/
|
|
3504
|
-
componentState?: any;
|
|
3505
|
-
}
|
|
3506
|
-
|
|
3507
|
-
declare interface Config {
|
|
3508
|
-
settings?: Settings;
|
|
3509
|
-
dimensions?: Dimensions;
|
|
3510
|
-
labels?: Labels;
|
|
3511
|
-
content?: ItemConfigType[];
|
|
3512
|
-
/**
|
|
3513
|
-
* (Only on layout config object)
|
|
3514
|
-
* Id of the currently maximised content item
|
|
3515
|
-
*/
|
|
3516
|
-
maximisedItemId?: string;
|
|
3517
|
-
}
|
|
3518
|
-
|
|
3519
3465
|
declare type ConfigWithRuntime = BaseConfig & {
|
|
3520
3466
|
runtime: RuntimeConfig;
|
|
3521
3467
|
};
|
|
@@ -3803,7 +3749,9 @@ declare type ConstWindowOptions = {
|
|
|
3803
3749
|
*/
|
|
3804
3750
|
preloadScripts: PreloadScript[];
|
|
3805
3751
|
/**
|
|
3806
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
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.
|
|
3807
3755
|
*/
|
|
3808
3756
|
processAffinity: string;
|
|
3809
3757
|
/**
|
|
@@ -3893,103 +3841,6 @@ declare type ConstWindowOptions = {
|
|
|
3893
3841
|
inheritance?: Partial<InheritableOptions>;
|
|
3894
3842
|
};
|
|
3895
3843
|
|
|
3896
|
-
declare interface Container extends EventEmitter_2 {
|
|
3897
|
-
/**
|
|
3898
|
-
* The current width of the container in pixel
|
|
3899
|
-
*/
|
|
3900
|
-
width: number;
|
|
3901
|
-
|
|
3902
|
-
/**
|
|
3903
|
-
* The current height of the container in pixel
|
|
3904
|
-
*/
|
|
3905
|
-
height: number;
|
|
3906
|
-
|
|
3907
|
-
/**
|
|
3908
|
-
* A reference to the component-item that controls this container
|
|
3909
|
-
*/
|
|
3910
|
-
parent: ContentItem;
|
|
3911
|
-
|
|
3912
|
-
/**
|
|
3913
|
-
* A reference to the tab that controls this container. Will initially be null
|
|
3914
|
-
* (and populated once a tab event has been fired).
|
|
3915
|
-
*/
|
|
3916
|
-
tab: Tab;
|
|
3917
|
-
|
|
3918
|
-
/**
|
|
3919
|
-
* The current title of the container
|
|
3920
|
-
*/
|
|
3921
|
-
title: string;
|
|
3922
|
-
|
|
3923
|
-
/*
|
|
3924
|
-
* A reference to the GoldenLayout instance this container belongs to
|
|
3925
|
-
*/
|
|
3926
|
-
layoutManager: GoldenLayout_2;
|
|
3927
|
-
|
|
3928
|
-
/**
|
|
3929
|
-
* True if the item is currently hidden
|
|
3930
|
-
*/
|
|
3931
|
-
isHidden: boolean;
|
|
3932
|
-
|
|
3933
|
-
/**
|
|
3934
|
-
* Overwrites the components state with the provided value. To only change parts of the componentState see
|
|
3935
|
-
* extendState below. This is the main mechanism for saving the state of a component. This state will be the
|
|
3936
|
-
* value of componentState when layout.toConfig() is called and will be passed back to the component's
|
|
3937
|
-
* constructor function. It will also be used when the component is opened in a new window.
|
|
3938
|
-
* @param state A serialisable object
|
|
3939
|
-
*/
|
|
3940
|
-
setState(state: any): void;
|
|
3941
|
-
|
|
3942
|
-
/**
|
|
3943
|
-
* The same as setState but does not emit 'stateChanged' event
|
|
3944
|
-
* @param {serialisable} state
|
|
3945
|
-
*/
|
|
3946
|
-
setStateSkipEvent(state: any): void;
|
|
3947
|
-
|
|
3948
|
-
/**
|
|
3949
|
-
* This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
|
|
3950
|
-
* @param state A serialisable object
|
|
3951
|
-
*/
|
|
3952
|
-
extendState(state: any): void;
|
|
3953
|
-
|
|
3954
|
-
/**
|
|
3955
|
-
* Returns the current state.
|
|
3956
|
-
*/
|
|
3957
|
-
getState(): any;
|
|
3958
|
-
|
|
3959
|
-
/**
|
|
3960
|
-
* Returns the container's inner element as a jQuery element
|
|
3961
|
-
*/
|
|
3962
|
-
getElement(): JQuery;
|
|
3963
|
-
|
|
3964
|
-
/**
|
|
3965
|
-
* hides the container or returns false if hiding it is not possible
|
|
3966
|
-
*/
|
|
3967
|
-
hide(): boolean;
|
|
3968
|
-
|
|
3969
|
-
/**
|
|
3970
|
-
* shows the container or returns false if showing it is not possible
|
|
3971
|
-
*/
|
|
3972
|
-
show(): boolean;
|
|
3973
|
-
|
|
3974
|
-
/**
|
|
3975
|
-
* Sets the container to the specified size or returns false if that's not possible
|
|
3976
|
-
* @param width the new width in pixel
|
|
3977
|
-
* @param height the new height in pixel
|
|
3978
|
-
*/
|
|
3979
|
-
setSize(width: number, height: number): boolean;
|
|
3980
|
-
|
|
3981
|
-
/**
|
|
3982
|
-
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
3983
|
-
* @param title the new title
|
|
3984
|
-
*/
|
|
3985
|
-
setTitle(title: string): void;
|
|
3986
|
-
|
|
3987
|
-
/**
|
|
3988
|
-
* Closes the container or returns false if that is not possible
|
|
3989
|
-
*/
|
|
3990
|
-
close(): boolean;
|
|
3991
|
-
}
|
|
3992
|
-
|
|
3993
3844
|
declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
|
|
3994
3845
|
|
|
3995
3846
|
/**
|
|
@@ -4052,218 +3903,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
4052
3903
|
disposition: string;
|
|
4053
3904
|
};
|
|
4054
3905
|
|
|
4055
|
-
declare interface ContentItem extends EventEmitter_2 {
|
|
4056
|
-
instance: any;
|
|
4057
|
-
header: any;
|
|
4058
|
-
_splitter: any;
|
|
4059
|
-
/**
|
|
4060
|
-
* This items configuration in its current state
|
|
4061
|
-
*/
|
|
4062
|
-
config: ItemConfigType;
|
|
4063
|
-
|
|
4064
|
-
/**
|
|
4065
|
-
* The type of the item. Can be row, column, stack, component or root
|
|
4066
|
-
*/
|
|
4067
|
-
type: ItemType;
|
|
4068
|
-
|
|
4069
|
-
/**
|
|
4070
|
-
* An array of items that are children of this item
|
|
4071
|
-
*/
|
|
4072
|
-
contentItems: ContentItem[];
|
|
4073
|
-
|
|
4074
|
-
container: Container;
|
|
4075
|
-
/**
|
|
4076
|
-
* The item that is this item's parent (or null if the item is root)
|
|
4077
|
-
*/
|
|
4078
|
-
parent: ContentItem;
|
|
4079
|
-
|
|
4080
|
-
/**
|
|
4081
|
-
* A String or array of identifiers if provided in the configuration
|
|
4082
|
-
*/
|
|
4083
|
-
id: string;
|
|
4084
|
-
|
|
4085
|
-
/**
|
|
4086
|
-
* True if the item had been initialised
|
|
4087
|
-
*/
|
|
4088
|
-
isInitialised: boolean;
|
|
4089
|
-
|
|
4090
|
-
/**
|
|
4091
|
-
* True if the item is maximised
|
|
4092
|
-
*/
|
|
4093
|
-
isMaximised: boolean;
|
|
4094
|
-
|
|
4095
|
-
/**
|
|
4096
|
-
* True if the item is the layout's root item
|
|
4097
|
-
*/
|
|
4098
|
-
isRoot: boolean;
|
|
4099
|
-
|
|
4100
|
-
/**
|
|
4101
|
-
* True if the item is a row
|
|
4102
|
-
*/
|
|
4103
|
-
isRow: boolean;
|
|
4104
|
-
|
|
4105
|
-
/**
|
|
4106
|
-
* True if the item is a column
|
|
4107
|
-
*/
|
|
4108
|
-
isColumn: boolean;
|
|
4109
|
-
|
|
4110
|
-
/**
|
|
4111
|
-
* True if the item is a stack
|
|
4112
|
-
*/
|
|
4113
|
-
isStack: boolean;
|
|
4114
|
-
|
|
4115
|
-
/**
|
|
4116
|
-
* True if the item is a component
|
|
4117
|
-
*/
|
|
4118
|
-
isComponent: boolean;
|
|
4119
|
-
|
|
4120
|
-
/**
|
|
4121
|
-
* A reference to the layoutManager that controls this item
|
|
4122
|
-
*/
|
|
4123
|
-
layoutManager: any;
|
|
4124
|
-
|
|
4125
|
-
/**
|
|
4126
|
-
* The item's outer element
|
|
4127
|
-
*/
|
|
4128
|
-
element: JQuery;
|
|
4129
|
-
|
|
4130
|
-
/**
|
|
4131
|
-
* The item's inner element. Can be the same as the outer element.
|
|
4132
|
-
*/
|
|
4133
|
-
childElementContainer: Container;
|
|
4134
|
-
|
|
4135
|
-
/**
|
|
4136
|
-
* Adds an item as a child to this item. If the item is already a part of a layout it will be removed
|
|
4137
|
-
* from its original position before adding it to this item.
|
|
4138
|
-
* @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4139
|
-
* @param index last index An optional index that determines at which position the new item should be added. Default: last index.
|
|
4140
|
-
*/
|
|
4141
|
-
addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
|
|
4142
|
-
|
|
4143
|
-
/**
|
|
4144
|
-
* Destroys the item and all it's children
|
|
4145
|
-
* @param contentItem The contentItem that should be removed
|
|
4146
|
-
* @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.
|
|
4147
|
-
*/
|
|
4148
|
-
removeChild(contentItem: ContentItem, keepChild?: boolean): void;
|
|
4149
|
-
|
|
4150
|
-
/**
|
|
4151
|
-
* The contentItem that should be removed
|
|
4152
|
-
* @param oldChild ContentItem The contentItem that should be removed
|
|
4153
|
-
* @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
|
|
4154
|
-
*/
|
|
4155
|
-
replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
|
|
4156
|
-
|
|
4157
|
-
/**
|
|
4158
|
-
* Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
|
|
4159
|
-
*/
|
|
4160
|
-
setSize(): void;
|
|
4161
|
-
|
|
4162
|
-
/**
|
|
4163
|
-
* Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
|
|
4164
|
-
* @param title the new title
|
|
4165
|
-
*/
|
|
4166
|
-
setTitle(title: string): void;
|
|
4167
|
-
|
|
4168
|
-
/**
|
|
4169
|
-
* A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
|
|
4170
|
-
* to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
|
|
4171
|
-
* @param functionName The name of the method to invoke
|
|
4172
|
-
* @param functionArguments An array of arguments to pass to every function
|
|
4173
|
-
* @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
|
|
4174
|
-
* @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
|
|
4175
|
-
*/
|
|
4176
|
-
callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
|
|
4177
|
-
|
|
4178
|
-
/**
|
|
4179
|
-
* 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.
|
|
4180
|
-
*/
|
|
4181
|
-
emitBubblingEvent(name: string): void;
|
|
4182
|
-
|
|
4183
|
-
/**
|
|
4184
|
-
* Convenience method for item.parent.removeChild( item )
|
|
4185
|
-
*/
|
|
4186
|
-
remove(): void;
|
|
4187
|
-
|
|
4188
|
-
/**
|
|
4189
|
-
* Removes the item from its current position in the layout and opens it in a window
|
|
4190
|
-
*/
|
|
4191
|
-
popout(): BrowserWindow;
|
|
4192
|
-
|
|
4193
|
-
/**
|
|
4194
|
-
* Maximises the item or minimises it if it's already maximised
|
|
4195
|
-
*/
|
|
4196
|
-
toggleMaximise(): void;
|
|
4197
|
-
|
|
4198
|
-
/**
|
|
4199
|
-
* Selects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4200
|
-
*/
|
|
4201
|
-
select(): void;
|
|
4202
|
-
|
|
4203
|
-
/**
|
|
4204
|
-
* Unselects the item. Only relevant if settings.selectionEnabled is set to true
|
|
4205
|
-
*/
|
|
4206
|
-
deselect(): void;
|
|
4207
|
-
|
|
4208
|
-
/**
|
|
4209
|
-
* Returns true if the item has the specified id or false if not
|
|
4210
|
-
* @param id An id to check for
|
|
4211
|
-
*/
|
|
4212
|
-
hasId(id: string): boolean;
|
|
4213
|
-
|
|
4214
|
-
/**
|
|
4215
|
-
* Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
|
|
4216
|
-
* @param contentItem The new active content item
|
|
4217
|
-
* @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
|
|
4218
|
-
*/
|
|
4219
|
-
// (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
|
|
4220
|
-
setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
|
|
4221
|
-
|
|
4222
|
-
/**
|
|
4223
|
-
* Only Stacks have this method! Returns the currently selected contentItem.
|
|
4224
|
-
*/
|
|
4225
|
-
getActiveContentItem(): ContentItem;
|
|
4226
|
-
|
|
4227
|
-
/**
|
|
4228
|
-
* Adds an id to an item or does nothing if the id is already present
|
|
4229
|
-
* @param id The id to be added
|
|
4230
|
-
*/
|
|
4231
|
-
addId(id: string): void;
|
|
4232
|
-
|
|
4233
|
-
/**
|
|
4234
|
-
* Removes an id from an item or throws an error if the id couldn't be found
|
|
4235
|
-
* @param id The id to be removed
|
|
4236
|
-
*/
|
|
4237
|
-
removeId(id: string): void;
|
|
4238
|
-
|
|
4239
|
-
/**
|
|
4240
|
-
* Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
|
|
4241
|
-
* @param filterFunction A function that determines whether an item matches certain criteria
|
|
4242
|
-
*/
|
|
4243
|
-
getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
|
|
4244
|
-
|
|
4245
|
-
/**
|
|
4246
|
-
* Returns all items with the specified id.
|
|
4247
|
-
* @param id An id specified in the itemConfig
|
|
4248
|
-
*/
|
|
4249
|
-
getItemsById(id: string | string[]): ContentItem[];
|
|
4250
|
-
|
|
4251
|
-
/**
|
|
4252
|
-
* Returns all items with the specified type
|
|
4253
|
-
* @param type 'row', 'column', 'stack', 'component' or 'root'
|
|
4254
|
-
*/
|
|
4255
|
-
getItemsByType(type: string): ContentItem[];
|
|
4256
|
-
|
|
4257
|
-
/**
|
|
4258
|
-
* Returns all instances of the component with the specified componentName
|
|
4259
|
-
* @param componentName a componentName as specified in the itemConfig
|
|
4260
|
-
*/
|
|
4261
|
-
getComponentsByName(componentName: string): any;
|
|
4262
|
-
|
|
4263
|
-
_contentAreaDimensions: any;
|
|
4264
|
-
_$getArea: () => any;
|
|
4265
|
-
}
|
|
4266
|
-
|
|
4267
3906
|
/**
|
|
4268
3907
|
* Restrict navigation to URLs that match an allowed pattern.
|
|
4269
3908
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
|
@@ -4748,46 +4387,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
|
|
|
4748
4387
|
type: 'did-finish-load';
|
|
4749
4388
|
};
|
|
4750
4389
|
|
|
4751
|
-
declare interface Dimensions {
|
|
4752
|
-
/**
|
|
4753
|
-
* The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
|
|
4754
|
-
* than the visible one, making it safe to set this to small values without affecting usability.
|
|
4755
|
-
* Default: 5
|
|
4756
|
-
*/
|
|
4757
|
-
borderWidth?: number;
|
|
4758
|
-
|
|
4759
|
-
/**
|
|
4760
|
-
* The minimum height an item can be resized to (in pixel).
|
|
4761
|
-
* Default: 10
|
|
4762
|
-
*/
|
|
4763
|
-
minItemHeight?: number;
|
|
4764
|
-
|
|
4765
|
-
/**
|
|
4766
|
-
* The minimum width an item can be resized to (in pixel).
|
|
4767
|
-
* Default: 10
|
|
4768
|
-
*/
|
|
4769
|
-
minItemWidth?: number;
|
|
4770
|
-
|
|
4771
|
-
/**
|
|
4772
|
-
* The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
|
|
4773
|
-
* adjusted accordingly.
|
|
4774
|
-
* Default: 20
|
|
4775
|
-
*/
|
|
4776
|
-
headerHeight?: number;
|
|
4777
|
-
|
|
4778
|
-
/**
|
|
4779
|
-
* The width of the element that appears when an item is dragged (in pixel).
|
|
4780
|
-
* Default: 300
|
|
4781
|
-
*/
|
|
4782
|
-
dragProxyWidth?: number;
|
|
4783
|
-
|
|
4784
|
-
/**
|
|
4785
|
-
* The height of the element that appears when an item is dragged (in pixel).
|
|
4786
|
-
* Default: 200
|
|
4787
|
-
*/
|
|
4788
|
-
dragProxyHeight?: number;
|
|
4789
|
-
}
|
|
4790
|
-
|
|
4791
4390
|
/**
|
|
4792
4391
|
* @interface
|
|
4793
4392
|
*/
|
|
@@ -5084,8 +4683,6 @@ declare type Dpi = {
|
|
|
5084
4683
|
vertical?: number;
|
|
5085
4684
|
};
|
|
5086
4685
|
|
|
5087
|
-
declare interface DragSource {}
|
|
5088
|
-
|
|
5089
4686
|
/**
|
|
5090
4687
|
* Generated when a window has been embedded.
|
|
5091
4688
|
* @interface
|
|
@@ -5358,7 +4955,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
|
|
|
5358
4955
|
*/
|
|
5359
4956
|
declare type Event_4 = (WebContentsEvents.Event<'view'> & {
|
|
5360
4957
|
target: OpenFin.Identity;
|
|
5361
|
-
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
|
|
4958
|
+
}) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
|
|
5362
4959
|
|
|
5363
4960
|
/**
|
|
5364
4961
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
|
|
@@ -5402,51 +4999,12 @@ declare class EventAggregator extends EmitterMap {
|
|
|
5402
4999
|
dispatchEvent: (message: Message<any>) => boolean;
|
|
5403
5000
|
}
|
|
5404
5001
|
|
|
5405
|
-
declare interface EventEmitter_2 {
|
|
5406
|
-
[x: string]: any;
|
|
5407
|
-
/**
|
|
5408
|
-
* Subscribe to an event
|
|
5409
|
-
* @param eventName The name of the event to describe to
|
|
5410
|
-
* @param callback The function that should be invoked when the event occurs
|
|
5411
|
-
* @param context The value of the this pointer in the callback function
|
|
5412
|
-
*/
|
|
5413
|
-
on(eventName: string, callback: Function, context?: any): void;
|
|
5414
|
-
|
|
5415
|
-
/**
|
|
5416
|
-
* Notify listeners of an event and pass arguments along
|
|
5417
|
-
* @param eventName The name of the event to emit
|
|
5418
|
-
*/
|
|
5419
|
-
emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5420
|
-
|
|
5421
|
-
/**
|
|
5422
|
-
* Alias for emit
|
|
5423
|
-
*/
|
|
5424
|
-
trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
|
|
5425
|
-
|
|
5426
|
-
/**
|
|
5427
|
-
* Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
|
|
5428
|
-
* eventName and callback or just a specific callback with a specific context if invoked with all three
|
|
5429
|
-
* arguments.
|
|
5430
|
-
* @param eventName The name of the event to unsubscribe from
|
|
5431
|
-
* @param callback The function that should be invoked when the event occurs
|
|
5432
|
-
* @param context The value of the this pointer in the callback function
|
|
5433
|
-
*/
|
|
5434
|
-
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
5435
|
-
|
|
5436
|
-
/**
|
|
5437
|
-
* Alias for unbind
|
|
5438
|
-
*/
|
|
5439
|
-
off(eventName: string, callback?: Function, context?: any): void;
|
|
5440
|
-
}
|
|
5441
|
-
|
|
5442
5002
|
/**
|
|
5443
5003
|
* Handler for an event on an EventEmitter.
|
|
5444
5004
|
* @remarks Selects the correct type for the event
|
|
5445
5005
|
* payload from the provided union based on the provided string literal type.
|
|
5446
5006
|
*/
|
|
5447
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
5448
|
-
type: EventType;
|
|
5449
|
-
}>, ...args: any[]) => void;
|
|
5007
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
|
|
5450
5008
|
|
|
5451
5009
|
declare namespace Events {
|
|
5452
5010
|
export {
|
|
@@ -5598,7 +5156,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5598
5156
|
ExternalApplicationEvent,
|
|
5599
5157
|
EventType_4 as EventType,
|
|
5600
5158
|
ExternalApplicationEventType,
|
|
5601
|
-
|
|
5159
|
+
Payload_6 as Payload,
|
|
5602
5160
|
ByType_4 as ByType
|
|
5603
5161
|
}
|
|
5604
5162
|
}
|
|
@@ -6381,7 +5939,7 @@ declare namespace FrameEvents {
|
|
|
6381
5939
|
FrameEvent,
|
|
6382
5940
|
EventType_5 as EventType,
|
|
6383
5941
|
FrameEventType,
|
|
6384
|
-
|
|
5942
|
+
Payload_7 as Payload,
|
|
6385
5943
|
ByType_5 as ByType
|
|
6386
5944
|
}
|
|
6387
5945
|
}
|
|
@@ -6578,297 +6136,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
|
|
|
6578
6136
|
*
|
|
6579
6137
|
* @remarks Raises the `unregistered` event for each hotkey unregistered.
|
|
6580
6138
|
*
|
|
6581
|
-
* @example
|
|
6582
|
-
* ```js
|
|
6583
|
-
* fin.GlobalHotkey.unregisterAll()
|
|
6584
|
-
* .then(() => {
|
|
6585
|
-
* console.log('Success');
|
|
6586
|
-
* })
|
|
6587
|
-
* .catch(err => {
|
|
6588
|
-
* console.log('Error unregistering all hotkeys for this application', err);
|
|
6589
|
-
* });
|
|
6590
|
-
* ```
|
|
6591
|
-
*/
|
|
6592
|
-
unregisterAll(): Promise<void>;
|
|
6593
|
-
/**
|
|
6594
|
-
* Checks if a given hotkey has been registered by an application within the current runtime.
|
|
6595
|
-
* @param hotkey a hotkey string
|
|
6596
|
-
*
|
|
6597
|
-
* @example
|
|
6598
|
-
* ```js
|
|
6599
|
-
* const hotkey = 'CommandOrControl+X';
|
|
6600
|
-
*
|
|
6601
|
-
* fin.GlobalHotkey.isRegistered(hotkey)
|
|
6602
|
-
* .then((registered) => {
|
|
6603
|
-
* console.log(`hotkey ${hotkey} is registered ? ${registered}`);
|
|
6604
|
-
* })
|
|
6605
|
-
* .catch(err => {
|
|
6606
|
-
* console.log('Error unregistering the hotkey', err);
|
|
6607
|
-
* });
|
|
6608
|
-
* ```
|
|
6609
|
-
*/
|
|
6610
|
-
isRegistered(hotkey: string): Promise<boolean>;
|
|
6611
|
-
}
|
|
6612
|
-
|
|
6613
|
-
/**
|
|
6614
|
-
* @deprecated Renamed to {@link Event}.
|
|
6615
|
-
*/
|
|
6616
|
-
declare type GlobalHotkeyEvent = Event_9;
|
|
6617
|
-
|
|
6618
|
-
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6619
|
-
|
|
6620
|
-
declare namespace GlobalHotkeyEvents {
|
|
6621
|
-
export {
|
|
6622
|
-
BaseEvent_8 as BaseEvent,
|
|
6623
|
-
RegisteredEvent,
|
|
6624
|
-
UnregisteredEvent,
|
|
6625
|
-
Event_9 as Event,
|
|
6626
|
-
GlobalHotkeyEvent,
|
|
6627
|
-
EventType_6 as EventType,
|
|
6628
|
-
GlobalHotkeyEventType,
|
|
6629
|
-
Payload_7 as Payload,
|
|
6630
|
-
ByType_6 as ByType
|
|
6631
|
-
}
|
|
6632
|
-
}
|
|
6633
|
-
|
|
6634
|
-
/**
|
|
6635
|
-
* @deprecated Renamed to {@link EventType}.
|
|
6636
|
-
*/
|
|
6637
|
-
declare type GlobalHotkeyEventType = EventType_6;
|
|
6638
|
-
|
|
6639
|
-
declare namespace GoldenLayout {
|
|
6640
|
-
export {
|
|
6641
|
-
GoldenLayout_2 as GoldenLayout,
|
|
6642
|
-
ItemConfigType,
|
|
6643
|
-
Settings,
|
|
6644
|
-
Dimensions,
|
|
6645
|
-
Labels,
|
|
6646
|
-
ItemType,
|
|
6647
|
-
ItemConfig,
|
|
6648
|
-
ComponentConfig,
|
|
6649
|
-
ReactComponentConfig,
|
|
6650
|
-
Config,
|
|
6651
|
-
ContentItem,
|
|
6652
|
-
Container,
|
|
6653
|
-
DragSource,
|
|
6654
|
-
BrowserWindow,
|
|
6655
|
-
Header,
|
|
6656
|
-
TabDragListener,
|
|
6657
|
-
Tab,
|
|
6658
|
-
EventEmitter_2 as EventEmitter
|
|
6659
|
-
}
|
|
6660
|
-
}
|
|
6661
|
-
|
|
6662
|
-
declare class GoldenLayout_2 implements EventEmitter_2 {
|
|
6663
|
-
/**
|
|
6664
|
-
* The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
|
|
6665
|
-
* object and of goldenLayout.root as the document.
|
|
6666
|
-
*/
|
|
6667
|
-
root: ContentItem;
|
|
6668
|
-
|
|
6669
|
-
/**
|
|
6670
|
-
* A reference to the (jQuery) DOM element containing the layout
|
|
6671
|
-
*/
|
|
6672
|
-
container: JQuery;
|
|
6673
|
-
|
|
6674
|
-
/**
|
|
6675
|
-
* True once the layout item tree has been created and the initialised event has been fired
|
|
6676
|
-
*/
|
|
6677
|
-
isInitialised: boolean;
|
|
6678
|
-
|
|
6679
|
-
/**
|
|
6680
|
-
* A reference to the current, extended top level config.
|
|
6681
|
-
*
|
|
6682
|
-
* Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
|
|
6683
|
-
*/
|
|
6684
|
-
config: Config;
|
|
6685
|
-
|
|
6686
|
-
/**
|
|
6687
|
-
* The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
|
|
6688
|
-
* to true.
|
|
6689
|
-
*/
|
|
6690
|
-
selectedItem: ContentItem;
|
|
6691
|
-
|
|
6692
|
-
/**
|
|
6693
|
-
* The current outer width of the layout in pixels.
|
|
6694
|
-
*/
|
|
6695
|
-
width: number;
|
|
6696
|
-
|
|
6697
|
-
/**
|
|
6698
|
-
* The current outer height of the layout in pixels.
|
|
6699
|
-
*/
|
|
6700
|
-
height: number;
|
|
6701
|
-
|
|
6702
|
-
/**
|
|
6703
|
-
* An array of BrowserWindow instances
|
|
6704
|
-
*/
|
|
6705
|
-
openPopouts: BrowserWindow[];
|
|
6706
|
-
|
|
6707
|
-
/**
|
|
6708
|
-
* True if the layout has been opened as a popout by another layout.
|
|
6709
|
-
*/
|
|
6710
|
-
isSubWindow: boolean;
|
|
6711
|
-
|
|
6712
|
-
/**
|
|
6713
|
-
* A singleton instance of EventEmitter that works across windows
|
|
6714
|
-
*/
|
|
6715
|
-
eventHub: EventEmitter_2;
|
|
6716
|
-
|
|
6717
|
-
_dragProxy: any;
|
|
6718
|
-
|
|
6719
|
-
dropTargetIndicator: any;
|
|
6720
|
-
|
|
6721
|
-
/**
|
|
6722
|
-
* @param config A GoldenLayout configuration object
|
|
6723
|
-
* @param container The DOM element the layout will be initialised in. Default: document.body
|
|
6724
|
-
*/
|
|
6725
|
-
constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
|
|
6726
|
-
|
|
6727
|
-
/*
|
|
6728
|
-
* @param name The name of the component, as referred to by componentName in the component configuration.
|
|
6729
|
-
* @param component A constructor or factory function. Will be invoked with new and two arguments, a
|
|
6730
|
-
* containerobject and a component state
|
|
6731
|
-
*/
|
|
6732
|
-
registerComponent(name: String, component: any): void;
|
|
6733
|
-
|
|
6734
|
-
/**
|
|
6735
|
-
* Renders the layout into the container. If init() is called before the document is ready it attaches itself as
|
|
6736
|
-
* a listener to the document and executes once it becomes ready.
|
|
6737
|
-
*/
|
|
6738
|
-
init(): void;
|
|
6739
|
-
|
|
6740
|
-
/**
|
|
6741
|
-
* Returns the current state of the layout and its components as a serialisable object.
|
|
6742
|
-
*/
|
|
6743
|
-
toConfig(): Config;
|
|
6744
|
-
|
|
6745
|
-
/**
|
|
6746
|
-
* Returns a component that was previously registered with layout.registerComponent().
|
|
6747
|
-
* @param name The name of a previously registered component
|
|
6748
|
-
*/
|
|
6749
|
-
getComponent(name: string): any;
|
|
6750
|
-
|
|
6751
|
-
/**
|
|
6752
|
-
* Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
|
|
6753
|
-
* @param width The outer width the layout should be resized to. Default: The container elements width
|
|
6754
|
-
* @param height The outer height the layout should be resized to. Default: The container elements height
|
|
6755
|
-
*/
|
|
6756
|
-
updateSize(width?: number, height?: number): void;
|
|
6757
|
-
|
|
6758
|
-
/**
|
|
6759
|
-
* Destroys the layout. Recursively calls destroy on all components and content items, removes all event
|
|
6760
|
-
* listeners and finally removes itself from the DOM.
|
|
6761
|
-
*/
|
|
6762
|
-
destroy(): void;
|
|
6763
|
-
|
|
6764
|
-
/**
|
|
6765
|
-
* Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
|
|
6766
|
-
* directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
|
|
6767
|
-
* all call this method implicitly.
|
|
6768
|
-
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6769
|
-
* @param parent A parent item
|
|
6770
|
-
*/
|
|
6771
|
-
createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
|
|
6772
|
-
|
|
6773
|
-
/**
|
|
6774
|
-
* Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
|
|
6775
|
-
* @param configOrContentItem The content item or config that will be created in the new window. If a item is
|
|
6776
|
-
* provided its config will be read, if config is provided, only the content key
|
|
6777
|
-
* will be used
|
|
6778
|
-
* @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
|
|
6779
|
-
* place the window in another screen.
|
|
6780
|
-
* @param parentId The id of the item within the current layout the child window's content will be appended to
|
|
6781
|
-
* when popIn is clicked
|
|
6782
|
-
* @param indexInParent The index at which the child window's contents will be appended to. Default: null
|
|
6783
|
-
*/
|
|
6784
|
-
createPopout(
|
|
6785
|
-
configOrContentItem: ItemConfigType | ContentItem,
|
|
6786
|
-
dimensions: {
|
|
6787
|
-
width: number;
|
|
6788
|
-
height: number;
|
|
6789
|
-
left: number;
|
|
6790
|
-
top: number;
|
|
6791
|
-
},
|
|
6792
|
-
parentId?: string,
|
|
6793
|
-
indexInParent?: number
|
|
6794
|
-
): void;
|
|
6795
|
-
|
|
6796
|
-
/**
|
|
6797
|
-
* Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
|
|
6798
|
-
* where it turns into a contentItem.
|
|
6799
|
-
* @param element The DOM element that will be turned into a dragSource
|
|
6800
|
-
* @param itemConfiguration An item configuration (can be an entire tree of items)
|
|
6801
|
-
* @return the dragSource that was created. This can be used to remove the
|
|
6802
|
-
* dragSource from the layout later.
|
|
6803
|
-
*/
|
|
6804
|
-
createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
|
|
6805
|
-
|
|
6806
|
-
/**
|
|
6807
|
-
* Removes a dragSource from the layout.
|
|
6808
|
-
*
|
|
6809
|
-
* @param dragSource The dragSource to remove
|
|
6810
|
-
*/
|
|
6811
|
-
removeDragSource(dragSource: DragSource): void;
|
|
6812
|
-
|
|
6813
|
-
/**
|
|
6814
|
-
* If settings.selectionEnabled is set to true, this allows to select items programmatically.
|
|
6815
|
-
* @param contentItem A ContentItem instance
|
|
6816
|
-
*/
|
|
6817
|
-
selectItem(contentItem: ContentItem): void;
|
|
6818
|
-
|
|
6819
|
-
/**
|
|
6820
|
-
* Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
|
|
6821
|
-
* and replace frequent keys and values with single letter substitutes.
|
|
6822
|
-
* @param config A GoldenLayout configuration object
|
|
6823
|
-
*/
|
|
6824
|
-
static minifyConfig(config: any): any;
|
|
6825
|
-
|
|
6826
|
-
/**
|
|
6827
|
-
* Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
|
|
6828
|
-
* @param minifiedConfig A minified GoldenLayout configuration object
|
|
6829
|
-
*/
|
|
6830
|
-
static unminifyConfig(minifiedConfig: any): any;
|
|
6831
|
-
|
|
6832
|
-
/**
|
|
6833
|
-
* Subscribe to an event
|
|
6834
|
-
* @param eventName The name of the event to describe to
|
|
6835
|
-
* @param callback The function that should be invoked when the event occurs
|
|
6836
|
-
* @param context The value of the this pointer in the callback function
|
|
6837
|
-
*/
|
|
6838
|
-
on(eventName: string, callback: Function, context?: any): void;
|
|
6839
|
-
|
|
6840
|
-
/**
|
|
6841
|
-
* Notify listeners of an event and pass arguments along
|
|
6842
|
-
* @param eventName The name of the event to emit
|
|
6139
|
+
* @example
|
|
6140
|
+
* ```js
|
|
6141
|
+
* fin.GlobalHotkey.unregisterAll()
|
|
6142
|
+
* .then(() => {
|
|
6143
|
+
* console.log('Success');
|
|
6144
|
+
* })
|
|
6145
|
+
* .catch(err => {
|
|
6146
|
+
* console.log('Error unregistering all hotkeys for this application', err);
|
|
6147
|
+
* });
|
|
6148
|
+
* ```
|
|
6843
6149
|
*/
|
|
6844
|
-
|
|
6845
|
-
|
|
6150
|
+
unregisterAll(): Promise<void>;
|
|
6846
6151
|
/**
|
|
6847
|
-
*
|
|
6152
|
+
* Checks if a given hotkey has been registered by an application within the current runtime.
|
|
6153
|
+
* @param hotkey a hotkey string
|
|
6154
|
+
*
|
|
6155
|
+
* @example
|
|
6156
|
+
* ```js
|
|
6157
|
+
* const hotkey = 'CommandOrControl+X';
|
|
6158
|
+
*
|
|
6159
|
+
* fin.GlobalHotkey.isRegistered(hotkey)
|
|
6160
|
+
* .then((registered) => {
|
|
6161
|
+
* console.log(`hotkey ${hotkey} is registered ? ${registered}`);
|
|
6162
|
+
* })
|
|
6163
|
+
* .catch(err => {
|
|
6164
|
+
* console.log('Error unregistering the hotkey', err);
|
|
6165
|
+
* });
|
|
6166
|
+
* ```
|
|
6848
6167
|
*/
|
|
6849
|
-
|
|
6168
|
+
isRegistered(hotkey: string): Promise<boolean>;
|
|
6169
|
+
}
|
|
6850
6170
|
|
|
6851
|
-
|
|
6852
|
-
|
|
6853
|
-
|
|
6854
|
-
|
|
6855
|
-
* @param eventName The name of the event to unsubscribe from
|
|
6856
|
-
* @param callback The function that should be invoked when the event occurs
|
|
6857
|
-
* @param context The value of the this pointer in the callback function
|
|
6858
|
-
*/
|
|
6859
|
-
unbind(eventName: string, callback?: Function, context?: any): void;
|
|
6171
|
+
/**
|
|
6172
|
+
* @deprecated Renamed to {@link Event}.
|
|
6173
|
+
*/
|
|
6174
|
+
declare type GlobalHotkeyEvent = Event_9;
|
|
6860
6175
|
|
|
6861
|
-
|
|
6862
|
-
* Alias for unbind
|
|
6863
|
-
*/
|
|
6864
|
-
off(eventName: string, callback?: Function, context?: any): void;
|
|
6176
|
+
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
|
6865
6177
|
|
|
6866
|
-
|
|
6867
|
-
|
|
6868
|
-
|
|
6869
|
-
|
|
6178
|
+
declare namespace GlobalHotkeyEvents {
|
|
6179
|
+
export {
|
|
6180
|
+
BaseEvent_8 as BaseEvent,
|
|
6181
|
+
RegisteredEvent,
|
|
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
|
+
}
|
|
6870
6190
|
}
|
|
6871
6191
|
|
|
6192
|
+
/**
|
|
6193
|
+
* @deprecated Renamed to {@link EventType}.
|
|
6194
|
+
*/
|
|
6195
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
|
6196
|
+
|
|
6872
6197
|
/**
|
|
6873
6198
|
* @interface
|
|
6874
6199
|
*/
|
|
@@ -6876,62 +6201,6 @@ declare type GpuInfo = {
|
|
|
6876
6201
|
name: string;
|
|
6877
6202
|
};
|
|
6878
6203
|
|
|
6879
|
-
declare interface Header {
|
|
6880
|
-
/**
|
|
6881
|
-
* A reference to the LayoutManager instance
|
|
6882
|
-
*/
|
|
6883
|
-
layoutManager: GoldenLayout_2;
|
|
6884
|
-
|
|
6885
|
-
/**
|
|
6886
|
-
* A reference to the Stack this Header belongs to
|
|
6887
|
-
*/
|
|
6888
|
-
parent: ContentItem;
|
|
6889
|
-
|
|
6890
|
-
/**
|
|
6891
|
-
* An array of the Tabs within this header
|
|
6892
|
-
*/
|
|
6893
|
-
tabs: Tab[];
|
|
6894
|
-
|
|
6895
|
-
/**
|
|
6896
|
-
* The currently selected activeContentItem
|
|
6897
|
-
*/
|
|
6898
|
-
activeContentItem: ContentItem;
|
|
6899
|
-
|
|
6900
|
-
/**
|
|
6901
|
-
* The outer (jQuery) DOM element of this Header
|
|
6902
|
-
*/
|
|
6903
|
-
element: JQuery;
|
|
6904
|
-
|
|
6905
|
-
/**
|
|
6906
|
-
* The (jQuery) DOM element containing the tabs
|
|
6907
|
-
*/
|
|
6908
|
-
tabsContainer: JQuery;
|
|
6909
|
-
|
|
6910
|
-
/**
|
|
6911
|
-
* The (jQuery) DOM element containing the close, maximise and popout button
|
|
6912
|
-
*/
|
|
6913
|
-
controlsContainer: JQuery;
|
|
6914
|
-
|
|
6915
|
-
/**
|
|
6916
|
-
* Hides the currently selected contentItem, shows the specified one and highlights its tab.
|
|
6917
|
-
* @param contentItem The content item that will be selected
|
|
6918
|
-
*/
|
|
6919
|
-
setActiveContentItem(contentItem: ContentItem): void;
|
|
6920
|
-
|
|
6921
|
-
/**
|
|
6922
|
-
* Creates a new tab and associates it with a content item
|
|
6923
|
-
* @param contentItem The content item the tab will be associated with
|
|
6924
|
-
* @param index A zero based index, specifying the position of the new tab
|
|
6925
|
-
*/
|
|
6926
|
-
createTab(contentItem: ContentItem, index?: number): void;
|
|
6927
|
-
|
|
6928
|
-
/**
|
|
6929
|
-
* Finds a tab by its contentItem and removes it
|
|
6930
|
-
* @param contentItem The content item the tab is associated with
|
|
6931
|
-
*/
|
|
6932
|
-
removeTab(contentItem: ContentItem): void;
|
|
6933
|
-
}
|
|
6934
|
-
|
|
6935
6204
|
/**
|
|
6936
6205
|
* Generated when a View is hidden.
|
|
6937
6206
|
* @interface
|
|
@@ -8626,50 +7895,6 @@ declare class InteropModule extends Base {
|
|
|
8626
7895
|
connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
|
|
8627
7896
|
}
|
|
8628
7897
|
|
|
8629
|
-
declare interface ItemConfig {
|
|
8630
|
-
/**
|
|
8631
|
-
* The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
|
|
8632
|
-
*/
|
|
8633
|
-
type: ItemType;
|
|
8634
|
-
|
|
8635
|
-
/**
|
|
8636
|
-
* An array of configurations for items that will be created as children of this item.
|
|
8637
|
-
*/
|
|
8638
|
-
content?: ItemConfigType[];
|
|
8639
|
-
|
|
8640
|
-
/**
|
|
8641
|
-
* The width of this item, relative to the other children of its parent in percent
|
|
8642
|
-
*/
|
|
8643
|
-
width?: number;
|
|
8644
|
-
|
|
8645
|
-
/**
|
|
8646
|
-
* The height of this item, relative to the other children of its parent in percent
|
|
8647
|
-
*/
|
|
8648
|
-
height?: number;
|
|
8649
|
-
|
|
8650
|
-
/**
|
|
8651
|
-
* A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
|
|
8652
|
-
*/
|
|
8653
|
-
id?: string | string[];
|
|
8654
|
-
|
|
8655
|
-
/**
|
|
8656
|
-
* Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
|
|
8657
|
-
* will return false
|
|
8658
|
-
* Default: true
|
|
8659
|
-
*/
|
|
8660
|
-
isClosable?: boolean;
|
|
8661
|
-
|
|
8662
|
-
/**
|
|
8663
|
-
* The title of the item as displayed on its tab and on popout windows
|
|
8664
|
-
* Default: componentName or ''
|
|
8665
|
-
*/
|
|
8666
|
-
title?: string;
|
|
8667
|
-
}
|
|
8668
|
-
|
|
8669
|
-
declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
|
|
8670
|
-
|
|
8671
|
-
declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
|
|
8672
|
-
|
|
8673
7898
|
/**
|
|
8674
7899
|
* @interface
|
|
8675
7900
|
*/
|
|
@@ -8727,32 +7952,6 @@ declare type JumpListTask = {
|
|
|
8727
7952
|
iconIndex?: number;
|
|
8728
7953
|
};
|
|
8729
7954
|
|
|
8730
|
-
declare interface Labels {
|
|
8731
|
-
/**
|
|
8732
|
-
* The tooltip text that appears when hovering over the close icon.
|
|
8733
|
-
* Default: 'close'
|
|
8734
|
-
*/
|
|
8735
|
-
close?: string;
|
|
8736
|
-
|
|
8737
|
-
/**
|
|
8738
|
-
* The tooltip text that appears when hovering over the maximise icon.
|
|
8739
|
-
* Default: 'maximise'
|
|
8740
|
-
*/
|
|
8741
|
-
maximise?: string;
|
|
8742
|
-
|
|
8743
|
-
/**
|
|
8744
|
-
* The tooltip text that appears when hovering over the minimise icon.
|
|
8745
|
-
* Default: 'minimise'
|
|
8746
|
-
*/
|
|
8747
|
-
minimise?: string;
|
|
8748
|
-
|
|
8749
|
-
/**
|
|
8750
|
-
* The tooltip text that appears when hovering over the popout icon.
|
|
8751
|
-
* Default: 'open in new window'
|
|
8752
|
-
*/
|
|
8753
|
-
popout?: string;
|
|
8754
|
-
}
|
|
8755
|
-
|
|
8756
7955
|
/**
|
|
8757
7956
|
* The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
|
|
8758
7957
|
*
|
|
@@ -9184,7 +8383,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
|
|
|
9184
8383
|
entityId: string;
|
|
9185
8384
|
};
|
|
9186
8385
|
|
|
9187
|
-
declare type LayoutEntityTypes =
|
|
8386
|
+
declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
9188
8387
|
|
|
9189
8388
|
/**
|
|
9190
8389
|
* @interface
|
|
@@ -10984,76 +10183,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
10984
10183
|
};
|
|
10985
10184
|
|
|
10986
10185
|
/**
|
|
10987
|
-
* Extracts a single event type matching the given key from the
|
|
10186
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10187
|
+
*
|
|
10188
|
+
* @see {@link ByType}
|
|
10988
10189
|
*
|
|
10989
10190
|
* @typeParam Type String key specifying the event to extract
|
|
10990
10191
|
*/
|
|
10991
|
-
declare type
|
|
10992
|
-
|
|
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;
|
|
10993
10216
|
}>;
|
|
10994
10217
|
|
|
10218
|
+
/**
|
|
10219
|
+
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
10220
|
+
*
|
|
10221
|
+
* @see {@link ByType}
|
|
10222
|
+
*
|
|
10223
|
+
* @typeParam Type String key specifying the event to extract
|
|
10224
|
+
*/
|
|
10225
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
|
10226
|
+
|
|
10995
10227
|
/**
|
|
10996
10228
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
10997
10229
|
*
|
|
10230
|
+
* @see {@link ByType}
|
|
10231
|
+
*
|
|
10998
10232
|
* @typeParam Type String key specifying the event to extract
|
|
10999
10233
|
*/
|
|
11000
|
-
declare type
|
|
11001
|
-
type: Type;
|
|
11002
|
-
}>;
|
|
10234
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
|
11003
10235
|
|
|
11004
10236
|
/**
|
|
11005
10237
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
11006
10238
|
*
|
|
10239
|
+
* @see {@link ByType}
|
|
10240
|
+
*
|
|
11007
10241
|
* @typeParam Type String key specifying the event to extract
|
|
11008
10242
|
*/
|
|
11009
|
-
declare type
|
|
11010
|
-
type: Type;
|
|
11011
|
-
}>;
|
|
10243
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
|
11012
10244
|
|
|
11013
10245
|
/**
|
|
11014
10246
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
11015
10247
|
*
|
|
10248
|
+
* @see {@link ByType}
|
|
10249
|
+
*
|
|
11016
10250
|
* @typeParam Type String key specifying the event to extract
|
|
11017
10251
|
*/
|
|
11018
|
-
declare type
|
|
11019
|
-
type: Type;
|
|
11020
|
-
}>;
|
|
10252
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
|
11021
10253
|
|
|
11022
10254
|
/**
|
|
11023
10255
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
11024
10256
|
*
|
|
10257
|
+
* @see {@link ByType}
|
|
10258
|
+
*
|
|
11025
10259
|
* @typeParam Type String key specifying the event to extract
|
|
11026
10260
|
*/
|
|
11027
|
-
declare type
|
|
11028
|
-
type: Type;
|
|
11029
|
-
}>;
|
|
10261
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
|
11030
10262
|
|
|
11031
10263
|
/**
|
|
11032
10264
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
11033
10265
|
*
|
|
10266
|
+
* @see {@link ByType}
|
|
10267
|
+
*
|
|
11034
10268
|
* @typeParam Type String key specifying the event to extract
|
|
11035
10269
|
*/
|
|
11036
|
-
declare type
|
|
11037
|
-
type: Type;
|
|
11038
|
-
}>;
|
|
10270
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
|
11039
10271
|
|
|
11040
10272
|
/**
|
|
11041
10273
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
11042
10274
|
*
|
|
11043
|
-
* @
|
|
11044
|
-
*/
|
|
11045
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
11046
|
-
type: Type;
|
|
11047
|
-
}>;
|
|
11048
|
-
|
|
11049
|
-
/**
|
|
11050
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
10275
|
+
* @see {@link ByType}
|
|
11051
10276
|
*
|
|
11052
10277
|
* @typeParam Type String key specifying the event to extract
|
|
11053
10278
|
*/
|
|
11054
|
-
declare type Payload_9<Type extends
|
|
11055
|
-
type: Type;
|
|
11056
|
-
}>;
|
|
10279
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
|
11057
10280
|
|
|
11058
10281
|
declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
|
|
11059
10282
|
|
|
@@ -11747,7 +10970,7 @@ declare namespace PlatformEvents {
|
|
|
11747
10970
|
PlatformEvent,
|
|
11748
10971
|
EventType_7 as EventType,
|
|
11749
10972
|
PlatformEventType,
|
|
11750
|
-
|
|
10973
|
+
Payload_9 as Payload,
|
|
11751
10974
|
ByType_7 as ByType
|
|
11752
10975
|
}
|
|
11753
10976
|
}
|
|
@@ -13379,18 +12602,6 @@ declare type QueryPermissionResult = {
|
|
|
13379
12602
|
rawValue?: unknown;
|
|
13380
12603
|
};
|
|
13381
12604
|
|
|
13382
|
-
declare interface ReactComponentConfig extends ItemConfig {
|
|
13383
|
-
/**
|
|
13384
|
-
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
|
|
13385
|
-
*/
|
|
13386
|
-
component: string;
|
|
13387
|
-
|
|
13388
|
-
/**
|
|
13389
|
-
* Properties that will be passed to the component and accessible using this.props.
|
|
13390
|
-
*/
|
|
13391
|
-
props?: any;
|
|
13392
|
-
}
|
|
13393
|
-
|
|
13394
12605
|
/**
|
|
13395
12606
|
* @interface
|
|
13396
12607
|
*/
|
|
@@ -13478,6 +12689,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
|
|
|
13478
12689
|
token: string;
|
|
13479
12690
|
}
|
|
13480
12691
|
|
|
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
|
+
|
|
13481
12701
|
/**
|
|
13482
12702
|
* @interface
|
|
13483
12703
|
*/
|
|
@@ -13897,97 +13117,6 @@ declare type SessionContextGroup = {
|
|
|
13897
13117
|
}>;
|
|
13898
13118
|
};
|
|
13899
13119
|
|
|
13900
|
-
declare interface Settings {
|
|
13901
|
-
preventSplitterResize?: boolean;
|
|
13902
|
-
|
|
13903
|
-
newTabButton?: {
|
|
13904
|
-
url?: string;
|
|
13905
|
-
};
|
|
13906
|
-
|
|
13907
|
-
/**
|
|
13908
|
-
* If true, tabs can't be dragged into the window.
|
|
13909
|
-
* Default: false
|
|
13910
|
-
*/
|
|
13911
|
-
preventDragIn?: boolean;
|
|
13912
|
-
|
|
13913
|
-
/**
|
|
13914
|
-
* If true, tabs can't be dragged out of the window.
|
|
13915
|
-
* Default: false
|
|
13916
|
-
*/
|
|
13917
|
-
preventDragOut?: boolean;
|
|
13918
|
-
|
|
13919
|
-
/**
|
|
13920
|
-
* If true, stack headers are the only areas where tabs can be dropped.
|
|
13921
|
-
* Default: false
|
|
13922
|
-
*/
|
|
13923
|
-
constrainDragToHeaders?: boolean;
|
|
13924
|
-
/**
|
|
13925
|
-
* Turns headers on or off. If false, the layout will be displayed with splitters only.
|
|
13926
|
-
* Default: true
|
|
13927
|
-
*/
|
|
13928
|
-
hasHeaders?: boolean;
|
|
13929
|
-
|
|
13930
|
-
/**
|
|
13931
|
-
* (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
|
|
13932
|
-
* automatically when layout.createDragSource() is called.
|
|
13933
|
-
* Default: true
|
|
13934
|
-
*/
|
|
13935
|
-
constrainDragToContainer?: boolean;
|
|
13936
|
-
|
|
13937
|
-
/**
|
|
13938
|
-
* If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
|
|
13939
|
-
* Default: true
|
|
13940
|
-
*/
|
|
13941
|
-
reorderEnabled?: boolean;
|
|
13942
|
-
|
|
13943
|
-
/**
|
|
13944
|
-
* If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
|
|
13945
|
-
* the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
|
|
13946
|
-
* Default: false
|
|
13947
|
-
*/
|
|
13948
|
-
selectionEnabled?: boolean;
|
|
13949
|
-
|
|
13950
|
-
/**
|
|
13951
|
-
* Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
|
|
13952
|
-
* be transferred to the new window, if false only the active component will be opened.
|
|
13953
|
-
* Default: false
|
|
13954
|
-
*/
|
|
13955
|
-
popoutWholeStack?: boolean;
|
|
13956
|
-
|
|
13957
|
-
/**
|
|
13958
|
-
* Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
|
|
13959
|
-
* If false, the popout call will fail silently.
|
|
13960
|
-
* Default: true
|
|
13961
|
-
*/
|
|
13962
|
-
blockedPopoutsThrowError?: boolean;
|
|
13963
|
-
|
|
13964
|
-
/**
|
|
13965
|
-
* Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
|
|
13966
|
-
* strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
|
|
13967
|
-
* addition, any changes made to popouts won't be stored after the parent is closed.
|
|
13968
|
-
* Default: true
|
|
13969
|
-
*/
|
|
13970
|
-
closePopoutsOnUnload?: boolean;
|
|
13971
|
-
|
|
13972
|
-
/**
|
|
13973
|
-
* Specifies if the popout icon should be displayed in the header-bar.
|
|
13974
|
-
* Default: true
|
|
13975
|
-
*/
|
|
13976
|
-
showPopoutIcon?: boolean;
|
|
13977
|
-
|
|
13978
|
-
/**
|
|
13979
|
-
* Specifies if the maximise icon should be displayed in the header-bar.
|
|
13980
|
-
* Default: true
|
|
13981
|
-
*/
|
|
13982
|
-
showMaximiseIcon?: boolean;
|
|
13983
|
-
|
|
13984
|
-
/**
|
|
13985
|
-
* Specifies if the close icon should be displayed in the header-bar.
|
|
13986
|
-
* Default: true
|
|
13987
|
-
*/
|
|
13988
|
-
showCloseIcon?: boolean;
|
|
13989
|
-
}
|
|
13990
|
-
|
|
13991
13120
|
/**
|
|
13992
13121
|
* @interface
|
|
13993
13122
|
*/
|
|
@@ -14211,7 +13340,7 @@ declare type Snapshot = {
|
|
|
14211
13340
|
* _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.
|
|
14212
13341
|
* @interface
|
|
14213
13342
|
*/
|
|
14214
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
13343
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
14215
13344
|
topic: 'application';
|
|
14216
13345
|
type: 'platform-snapshot-applied';
|
|
14217
13346
|
};
|
|
@@ -15823,7 +14952,7 @@ declare namespace SystemEvents {
|
|
|
15823
14952
|
SystemEvent,
|
|
15824
14953
|
EventType_8 as EventType,
|
|
15825
14954
|
SystemEventType,
|
|
15826
|
-
|
|
14955
|
+
Payload_10 as Payload,
|
|
15827
14956
|
ByType_8 as ByType
|
|
15828
14957
|
}
|
|
15829
14958
|
}
|
|
@@ -15896,59 +15025,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
|
|
|
15896
15025
|
proceed: () => void;
|
|
15897
15026
|
}) => void;
|
|
15898
15027
|
|
|
15899
|
-
declare interface Tab {
|
|
15900
|
-
_dragListener: TabDragListener;
|
|
15901
|
-
|
|
15902
|
-
/**
|
|
15903
|
-
* True if this tab is the selected tab
|
|
15904
|
-
*/
|
|
15905
|
-
isActive: boolean;
|
|
15906
|
-
|
|
15907
|
-
/**
|
|
15908
|
-
* A reference to the header this tab is a child of
|
|
15909
|
-
*/
|
|
15910
|
-
header: Header;
|
|
15911
|
-
|
|
15912
|
-
/**
|
|
15913
|
-
* A reference to the content item this tab relates to
|
|
15914
|
-
*/
|
|
15915
|
-
contentItem: ContentItem;
|
|
15916
|
-
|
|
15917
|
-
/**
|
|
15918
|
-
* The tabs outer (jQuery) DOM element
|
|
15919
|
-
*/
|
|
15920
|
-
element: JQuery;
|
|
15921
|
-
|
|
15922
|
-
/**
|
|
15923
|
-
* The (jQuery) DOM element containing the title
|
|
15924
|
-
*/
|
|
15925
|
-
titleElement: JQuery;
|
|
15926
|
-
|
|
15927
|
-
/**
|
|
15928
|
-
* The (jQuery) DOM element that closes the tab
|
|
15929
|
-
*/
|
|
15930
|
-
closeElement: JQuery;
|
|
15931
|
-
|
|
15932
|
-
/**
|
|
15933
|
-
* Sets the tab's title. Does not affect the contentItem's title!
|
|
15934
|
-
* @param title The new title
|
|
15935
|
-
*/
|
|
15936
|
-
setTitle(title: string): void;
|
|
15937
|
-
|
|
15938
|
-
/**
|
|
15939
|
-
* Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
|
|
15940
|
-
* @param isActive Whether the tab is active
|
|
15941
|
-
*/
|
|
15942
|
-
setActive(isActive: boolean): void;
|
|
15943
|
-
}
|
|
15944
|
-
|
|
15945
|
-
declare interface TabDragListener extends EventEmitter_2 {
|
|
15946
|
-
/**
|
|
15947
|
-
* A reference to the content item this tab relates to
|
|
15948
|
-
*/
|
|
15949
|
-
contentItem: ContentItem;
|
|
15950
|
-
}
|
|
15951
|
-
|
|
15952
15028
|
/**
|
|
15953
15029
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
|
15954
15030
|
*/
|
|
@@ -16926,6 +16002,8 @@ declare namespace ViewEvents {
|
|
|
16926
16002
|
BaseEvent_4 as BaseEvent,
|
|
16927
16003
|
BaseViewEvent,
|
|
16928
16004
|
TargetChangedEvent,
|
|
16005
|
+
AddedToLayoutEvent,
|
|
16006
|
+
RemovedFromLayoutEvent,
|
|
16929
16007
|
NonPropagatedViewEvent,
|
|
16930
16008
|
CreatedEvent,
|
|
16931
16009
|
DestroyedEvent,
|
|
@@ -16942,7 +16020,7 @@ declare namespace ViewEvents {
|
|
|
16942
16020
|
PropagatedViewEvent,
|
|
16943
16021
|
PropagatedEventType_2 as PropagatedEventType,
|
|
16944
16022
|
PropagatedViewEventType,
|
|
16945
|
-
|
|
16023
|
+
Payload_3 as Payload,
|
|
16946
16024
|
ByType
|
|
16947
16025
|
}
|
|
16948
16026
|
}
|
|
@@ -19421,7 +18499,7 @@ declare namespace WindowEvents {
|
|
|
19421
18499
|
PropagatedEvent_3 as PropagatedEvent,
|
|
19422
18500
|
PropagatedWindowEvent,
|
|
19423
18501
|
PropagatedWindowEventType,
|
|
19424
|
-
|
|
18502
|
+
Payload_4 as Payload,
|
|
19425
18503
|
ByType_2 as ByType
|
|
19426
18504
|
}
|
|
19427
18505
|
}
|