@openfin/core 40.105.3 → 40.105.6
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/mock-alpha.d.ts +208 -199
- package/out/mock-beta.d.ts +208 -199
- package/out/mock-public.d.ts +208 -199
- package/out/stub.d.ts +209 -200
- package/out/stub.js +3799 -3830
- package/package.json +1 -5
package/out/mock-alpha.d.ts
CHANGED
|
@@ -129,13 +129,13 @@ declare type ApiSettings = {
|
|
|
129
129
|
/**
|
|
130
130
|
* Inject OpenFin API into cross-origin iframes
|
|
131
131
|
*
|
|
132
|
-
* @
|
|
132
|
+
* @default false
|
|
133
133
|
*/
|
|
134
134
|
crossOriginInjection?: boolean;
|
|
135
135
|
/**
|
|
136
136
|
* Inject OpenFin API into same-origin iframes
|
|
137
137
|
*
|
|
138
|
-
* @
|
|
138
|
+
* @default true
|
|
139
139
|
*/
|
|
140
140
|
sameOriginInjection?: boolean;
|
|
141
141
|
/**
|
|
@@ -1174,19 +1174,19 @@ declare class ApplicationModule extends Base {
|
|
|
1174
1174
|
*/
|
|
1175
1175
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1176
1176
|
/**
|
|
1177
|
-
* @defaultValue false
|
|
1178
|
-
*
|
|
1179
1177
|
* Disables IAB secure logging for the app.
|
|
1178
|
+
*
|
|
1179
|
+
* @default false
|
|
1180
1180
|
*/
|
|
1181
1181
|
disableIabSecureLogging: boolean;
|
|
1182
1182
|
/**
|
|
1183
|
-
* @defaultValue 'There was an error loading the application.'
|
|
1184
|
-
*
|
|
1185
1183
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1186
1184
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1187
1185
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1188
1186
|
* will trigger this dialog.
|
|
1189
1187
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1188
|
+
*
|
|
1189
|
+
* @default 'There was an error loading the application.'
|
|
1190
1190
|
*/
|
|
1191
1191
|
loadErrorMessage: string;
|
|
1192
1192
|
/**
|
|
@@ -1205,28 +1205,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1205
1205
|
*/
|
|
1206
1206
|
name: string;
|
|
1207
1207
|
/**
|
|
1208
|
-
* @defaultValue false
|
|
1209
|
-
*
|
|
1210
1208
|
* A flag to configure the application as non-persistent.
|
|
1211
1209
|
* Runtime exits when there are no persistent apps running.
|
|
1210
|
+
*
|
|
1211
|
+
* @default false
|
|
1212
1212
|
*/
|
|
1213
1213
|
nonPersistent: boolean;
|
|
1214
1214
|
/**
|
|
1215
|
-
* @defaultValue false
|
|
1216
|
-
*
|
|
1217
1215
|
* Enable Flash at the application level.
|
|
1216
|
+
*
|
|
1217
|
+
* @default false
|
|
1218
1218
|
*/
|
|
1219
1219
|
plugins: boolean;
|
|
1220
1220
|
/**
|
|
1221
|
-
* @defaultValue false
|
|
1222
|
-
*
|
|
1223
1221
|
* Enable spell check at the application level.
|
|
1222
|
+
*
|
|
1223
|
+
* @default false
|
|
1224
1224
|
*/
|
|
1225
1225
|
spellCheck: boolean;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @defaultValue 'about:blank'
|
|
1228
|
-
*
|
|
1229
1227
|
* The url to the application (specifically the application's main window).
|
|
1228
|
+
*
|
|
1229
|
+
* @default 'about:blank'
|
|
1230
1230
|
*/
|
|
1231
1231
|
url: string;
|
|
1232
1232
|
/**
|
|
@@ -1235,9 +1235,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1235
1235
|
*/
|
|
1236
1236
|
uuid: string;
|
|
1237
1237
|
/**
|
|
1238
|
-
* @defaultValue true
|
|
1239
|
-
*
|
|
1240
1238
|
* When set to `false` it will disable the same-origin policy for the app.
|
|
1239
|
+
*
|
|
1240
|
+
* @default true
|
|
1241
1241
|
*/
|
|
1242
1242
|
webSecurity: boolean;
|
|
1243
1243
|
/**
|
|
@@ -1247,10 +1247,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1247
1247
|
commands: ShortcutOverride[];
|
|
1248
1248
|
isPlatformController: boolean;
|
|
1249
1249
|
/**
|
|
1250
|
-
* @defaultValue 1000
|
|
1251
|
-
*
|
|
1252
1250
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1253
1251
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1252
|
+
*
|
|
1253
|
+
* @default 1000
|
|
1254
1254
|
*/
|
|
1255
1255
|
maxViewPoolSize: number;
|
|
1256
1256
|
/**
|
|
@@ -1266,12 +1266,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
snapshot: Snapshot;
|
|
1268
1268
|
/**
|
|
1269
|
-
* @defaultValue false
|
|
1270
|
-
*
|
|
1271
1269
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1272
1270
|
*
|
|
1273
1271
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1274
1272
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1273
|
+
*
|
|
1274
|
+
* @default false
|
|
1275
1275
|
*/
|
|
1276
1276
|
preventQuitOnLastWindowClosed: boolean;
|
|
1277
1277
|
/**
|
|
@@ -1279,9 +1279,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1279
1279
|
*/
|
|
1280
1280
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1281
1281
|
/**
|
|
1282
|
-
* @defaultValue true
|
|
1283
|
-
*
|
|
1284
1282
|
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1283
|
+
*
|
|
1284
|
+
* @default true
|
|
1285
1285
|
*/
|
|
1286
1286
|
apiDiagnostics: boolean;
|
|
1287
1287
|
/**
|
|
@@ -1297,16 +1297,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1297
1297
|
*/
|
|
1298
1298
|
permissions?: Partial<Permissions_2>;
|
|
1299
1299
|
/**
|
|
1300
|
-
* @defaultValue false
|
|
1301
|
-
*
|
|
1302
1300
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1303
1301
|
* Only relevant in Windows.
|
|
1302
|
+
*
|
|
1303
|
+
* @default false
|
|
1304
1304
|
*/
|
|
1305
1305
|
enableJumpList: boolean;
|
|
1306
1306
|
/**
|
|
1307
|
-
* @defaultValue false
|
|
1308
|
-
*
|
|
1309
1307
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1308
|
+
*
|
|
1309
|
+
* @default false
|
|
1310
1310
|
*/
|
|
1311
1311
|
enableBeforeUnload: boolean;
|
|
1312
1312
|
/**
|
|
@@ -1387,25 +1387,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1387
1387
|
*/
|
|
1388
1388
|
declare type ApplySnapshotOptions = {
|
|
1389
1389
|
/**
|
|
1390
|
-
* @defaultValue false
|
|
1391
|
-
*
|
|
1392
1390
|
* When true, applySnapshot will close existing windows,
|
|
1393
1391
|
* replacing current Platform state with the given snapshot.
|
|
1392
|
+
*
|
|
1393
|
+
* @default false
|
|
1394
1394
|
*/
|
|
1395
1395
|
closeExistingWindows?: boolean;
|
|
1396
1396
|
/**
|
|
1397
|
-
* @defaultValue false
|
|
1398
|
-
*
|
|
1399
1397
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1400
1398
|
* replacing current Platform state with the given snapshot.
|
|
1399
|
+
*
|
|
1400
|
+
* @default false
|
|
1401
1401
|
*/
|
|
1402
1402
|
closeSnapshotWindows?: boolean;
|
|
1403
1403
|
/**
|
|
1404
|
-
* @defaultValue false
|
|
1405
|
-
*
|
|
1406
1404
|
* When true, applySnapshot will not check whether any windows in a
|
|
1407
1405
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1408
1406
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1407
|
+
*
|
|
1408
|
+
* @default false
|
|
1409
1409
|
*/
|
|
1410
1410
|
skipOutOfBoundsCheck?: boolean;
|
|
1411
1411
|
};
|
|
@@ -2062,15 +2062,15 @@ declare type CapturePageOptions = {
|
|
|
2062
2062
|
*/
|
|
2063
2063
|
area?: Rectangle;
|
|
2064
2064
|
/**
|
|
2065
|
-
* @defaultValue 'png'
|
|
2066
|
-
*
|
|
2067
2065
|
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2066
|
+
*
|
|
2067
|
+
* @default 'png'
|
|
2068
2068
|
*/
|
|
2069
2069
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2070
2070
|
/**
|
|
2071
|
-
* @defaultValue 100
|
|
2072
|
-
*
|
|
2073
2071
|
* Quality of JPEG image. Between 0 - 100.
|
|
2072
|
+
*
|
|
2073
|
+
* @default 100
|
|
2074
2074
|
*/
|
|
2075
2075
|
quality?: number;
|
|
2076
2076
|
};
|
|
@@ -2703,9 +2703,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2703
2703
|
*/
|
|
2704
2704
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2705
2705
|
/**
|
|
2706
|
-
* @defaultValue true
|
|
2707
|
-
*
|
|
2708
2706
|
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2707
|
+
*
|
|
2708
|
+
* @default true
|
|
2709
2709
|
*/
|
|
2710
2710
|
wait?: boolean;
|
|
2711
2711
|
/**
|
|
@@ -3364,9 +3364,9 @@ declare interface CloseWindowPayload {
|
|
|
3364
3364
|
windowId: Identity_4;
|
|
3365
3365
|
options: {
|
|
3366
3366
|
/**
|
|
3367
|
-
* @defaultValue false
|
|
3368
|
-
*
|
|
3369
3367
|
* When set to true skips any before handler set on views that are part of the window
|
|
3368
|
+
*
|
|
3369
|
+
* @default false
|
|
3370
3370
|
*/
|
|
3371
3371
|
skipBeforeUnload?: boolean;
|
|
3372
3372
|
};
|
|
@@ -3471,9 +3471,9 @@ declare type ConstViewOptions = {
|
|
|
3471
3471
|
*/
|
|
3472
3472
|
name: string;
|
|
3473
3473
|
/**
|
|
3474
|
-
* @defaultValue "about:blank"
|
|
3475
|
-
*
|
|
3476
3474
|
* The URL of the window
|
|
3475
|
+
*
|
|
3476
|
+
* @default "about:blank"
|
|
3477
3477
|
*/
|
|
3478
3478
|
url: string;
|
|
3479
3479
|
/**
|
|
@@ -3531,9 +3531,9 @@ declare type ConstViewOptions = {
|
|
|
3531
3531
|
experimental: any;
|
|
3532
3532
|
fdc3InteropApi?: string;
|
|
3533
3533
|
/**
|
|
3534
|
-
* @defaultValue false
|
|
3535
|
-
*
|
|
3536
3534
|
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3535
|
+
*
|
|
3536
|
+
* @default false
|
|
3537
3537
|
*/
|
|
3538
3538
|
enableBeforeUnload: boolean;
|
|
3539
3539
|
/**
|
|
@@ -3614,13 +3614,12 @@ declare type ConstWindowOptions = {
|
|
|
3614
3614
|
*/
|
|
3615
3615
|
backgroundColor: string;
|
|
3616
3616
|
/**
|
|
3617
|
-
* @defaultValue false
|
|
3618
|
-
*
|
|
3619
3617
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3620
3618
|
* This also affects the Page Visibility API.
|
|
3621
3619
|
*
|
|
3622
3620
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3623
3621
|
*
|
|
3622
|
+
* @default false
|
|
3624
3623
|
*/
|
|
3625
3624
|
backgroundThrottling: boolean;
|
|
3626
3625
|
/**
|
|
@@ -3644,21 +3643,21 @@ declare type ConstWindowOptions = {
|
|
|
3644
3643
|
*/
|
|
3645
3644
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3646
3645
|
/**
|
|
3647
|
-
* @defaultValue true
|
|
3648
|
-
*
|
|
3649
3646
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3650
3647
|
* This is meant for advanced users and should be used with caution.
|
|
3651
3648
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3652
3649
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3653
3650
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3651
|
+
*
|
|
3652
|
+
* @default true
|
|
3654
3653
|
*/
|
|
3655
3654
|
closeOnLastViewRemoved: boolean;
|
|
3656
3655
|
/**
|
|
3657
|
-
* @defaultValue 'all'
|
|
3658
|
-
*
|
|
3659
3656
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3660
|
-
|
|
3657
|
+
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3661
3658
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3659
|
+
*
|
|
3660
|
+
* @default 'all'
|
|
3662
3661
|
*/
|
|
3663
3662
|
viewsPreventingClose: 'all' | 'layout';
|
|
3664
3663
|
/**
|
|
@@ -3669,31 +3668,31 @@ declare type ConstWindowOptions = {
|
|
|
3669
3668
|
*/
|
|
3670
3669
|
defaultCentered: boolean;
|
|
3671
3670
|
/**
|
|
3672
|
-
* @defaultValue 500
|
|
3673
|
-
*
|
|
3674
3671
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3675
3672
|
* in favor of the cached value.
|
|
3673
|
+
*
|
|
3674
|
+
* @default 500
|
|
3676
3675
|
*/
|
|
3677
3676
|
defaultHeight: number;
|
|
3678
3677
|
/**
|
|
3679
|
-
* @defaultValue 100
|
|
3680
|
-
*
|
|
3681
3678
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3682
3679
|
* launches in favor of the cached value.
|
|
3680
|
+
*
|
|
3681
|
+
* @default 100
|
|
3683
3682
|
*/
|
|
3684
3683
|
defaultLeft: number;
|
|
3685
3684
|
/**
|
|
3686
|
-
* @defaultValue 100
|
|
3687
|
-
*
|
|
3688
3685
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3689
3686
|
* launches in favor of the cached value.
|
|
3687
|
+
*
|
|
3688
|
+
* @default 100
|
|
3690
3689
|
*/
|
|
3691
3690
|
defaultTop: number;
|
|
3692
3691
|
/**
|
|
3693
|
-
* @defaultValue 800
|
|
3694
|
-
*
|
|
3695
3692
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3696
3693
|
* launches in favor of the cached value.
|
|
3694
|
+
*
|
|
3695
|
+
* @default 800
|
|
3697
3696
|
*/
|
|
3698
3697
|
defaultWidth: number;
|
|
3699
3698
|
/**
|
|
@@ -3739,19 +3738,19 @@ declare type ConstWindowOptions = {
|
|
|
3739
3738
|
*/
|
|
3740
3739
|
processAffinity: string;
|
|
3741
3740
|
/**
|
|
3742
|
-
* @defaultValue false
|
|
3743
|
-
*
|
|
3744
3741
|
* Displays a shadow on frameless windows.
|
|
3745
3742
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3746
3743
|
* On Windows 7, Aero theme is required.
|
|
3744
|
+
*
|
|
3745
|
+
* @default false
|
|
3747
3746
|
*/
|
|
3748
3747
|
shadow: boolean;
|
|
3749
3748
|
/**
|
|
3750
|
-
* @defaultValue true
|
|
3751
|
-
*
|
|
3752
3749
|
* Caches the location of the window.
|
|
3753
3750
|
*
|
|
3754
3751
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3752
|
+
*
|
|
3753
|
+
* @default true
|
|
3755
3754
|
*/
|
|
3756
3755
|
saveWindowState: boolean;
|
|
3757
3756
|
/**
|
|
@@ -3760,22 +3759,22 @@ declare type ConstWindowOptions = {
|
|
|
3760
3759
|
*/
|
|
3761
3760
|
ignoreSavedWindowState: boolean;
|
|
3762
3761
|
/**
|
|
3763
|
-
* @defaultValue false
|
|
3764
|
-
*
|
|
3765
3762
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3766
3763
|
*
|
|
3767
3764
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3768
3765
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3766
|
+
*
|
|
3767
|
+
* @default false
|
|
3769
3768
|
*/
|
|
3770
3769
|
smallWindow: boolean;
|
|
3771
3770
|
/**
|
|
3772
|
-
* @defaultValue "normal"
|
|
3773
|
-
*
|
|
3774
3771
|
* The visible state of the window on creation.
|
|
3775
3772
|
* One of:
|
|
3776
3773
|
* * `"maximized"`
|
|
3777
3774
|
* * `"minimized"`
|
|
3778
3775
|
* * `"normal"`
|
|
3776
|
+
*
|
|
3777
|
+
* @default "normal"
|
|
3779
3778
|
*/
|
|
3780
3779
|
state: WindowState;
|
|
3781
3780
|
/**
|
|
@@ -3789,20 +3788,20 @@ declare type ConstWindowOptions = {
|
|
|
3789
3788
|
*/
|
|
3790
3789
|
url: string;
|
|
3791
3790
|
/**
|
|
3792
|
-
* @defaultValue <application UUID>
|
|
3793
|
-
*
|
|
3794
3791
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3795
3792
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3796
3793
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3797
3794
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3798
3795
|
* really no need to provide it.
|
|
3796
|
+
*
|
|
3797
|
+
* @default <application UUID>
|
|
3799
3798
|
*/
|
|
3800
3799
|
uuid: string;
|
|
3801
3800
|
/**
|
|
3802
|
-
* @defaultValue false
|
|
3803
|
-
*
|
|
3804
3801
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3805
3802
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3803
|
+
*
|
|
3804
|
+
* @default false
|
|
3806
3805
|
*/
|
|
3807
3806
|
waitForPageLoad: boolean;
|
|
3808
3807
|
width: number;
|
|
@@ -4074,13 +4073,13 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4074
4073
|
*/
|
|
4075
4074
|
declare type CopyPermissions = {
|
|
4076
4075
|
/**
|
|
4077
|
-
* @defaultValue 'allowed'
|
|
4078
|
-
*
|
|
4079
4076
|
* Controls the behavior for copy operations for a matched URL.
|
|
4080
4077
|
*
|
|
4081
4078
|
* allow: Enables all copy operations.
|
|
4082
4079
|
* block: Disables all copy operations.
|
|
4083
4080
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4081
|
+
*
|
|
4082
|
+
* @default 'allowed'
|
|
4084
4083
|
*/
|
|
4085
4084
|
behavior: 'allow' | 'block' | 'protect';
|
|
4086
4085
|
/**
|
|
@@ -4088,9 +4087,9 @@ declare type CopyPermissions = {
|
|
|
4088
4087
|
*/
|
|
4089
4088
|
options?: {
|
|
4090
4089
|
/**
|
|
4091
|
-
* @defaultValue ''
|
|
4092
|
-
*
|
|
4093
4090
|
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4091
|
+
*
|
|
4092
|
+
* @default ''
|
|
4094
4093
|
*/
|
|
4095
4094
|
replacementText: string;
|
|
4096
4095
|
};
|
|
@@ -4104,15 +4103,15 @@ declare type CopyPermissions = {
|
|
|
4104
4103
|
*/
|
|
4105
4104
|
declare type CornerRounding = {
|
|
4106
4105
|
/**
|
|
4107
|
-
* @defaultValue 0
|
|
4108
|
-
*
|
|
4109
4106
|
* The height in pixels.
|
|
4107
|
+
*
|
|
4108
|
+
* @default 0
|
|
4110
4109
|
*/
|
|
4111
4110
|
height: number;
|
|
4112
4111
|
/**
|
|
4113
|
-
* @defaultValue 0
|
|
4114
|
-
*
|
|
4115
4112
|
* The width in pixels.
|
|
4113
|
+
*
|
|
4114
|
+
* @default 0
|
|
4116
4115
|
*/
|
|
4117
4116
|
width: number;
|
|
4118
4117
|
};
|
|
@@ -4202,8 +4201,6 @@ declare type CreateLayoutOptions = {
|
|
|
4202
4201
|
layoutName: string;
|
|
4203
4202
|
layout: LayoutOptions;
|
|
4204
4203
|
/**
|
|
4205
|
-
* @defaultValue 'default'
|
|
4206
|
-
*
|
|
4207
4204
|
* Controls the View behavior for the given `layout` property. Note
|
|
4208
4205
|
* that the selected behavior only applies to unnamed Views or
|
|
4209
4206
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4225,6 +4222,8 @@ declare type CreateLayoutOptions = {
|
|
|
4225
4222
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4226
4223
|
* attached to the Provider while the Window is being created, so it's
|
|
4227
4224
|
* important to not 'duplicate' Views in this workflow.
|
|
4225
|
+
*
|
|
4226
|
+
* @default 'default'
|
|
4228
4227
|
*/
|
|
4229
4228
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4230
4229
|
};
|
|
@@ -4484,7 +4483,7 @@ declare type DomainApiSettings = {
|
|
|
4484
4483
|
* * 'none': The `fin` API will be not available.
|
|
4485
4484
|
* * 'global': The entire `fin` API will be available.
|
|
4486
4485
|
*
|
|
4487
|
-
* @
|
|
4486
|
+
* @default 'global'
|
|
4488
4487
|
*/
|
|
4489
4488
|
fin?: InjectionType;
|
|
4490
4489
|
/**
|
|
@@ -5062,9 +5061,9 @@ declare type EventType_9 = Event_12['type'];
|
|
|
5062
5061
|
*/
|
|
5063
5062
|
declare type ExcludeOptions = {
|
|
5064
5063
|
/**
|
|
5065
|
-
* @defaultValue false
|
|
5066
|
-
*
|
|
5067
5064
|
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5065
|
+
*
|
|
5066
|
+
* @default false
|
|
5068
5067
|
*/
|
|
5069
5068
|
preloadScripts: boolean;
|
|
5070
5069
|
};
|
|
@@ -5372,6 +5371,10 @@ declare namespace FDC3 {
|
|
|
5372
5371
|
}
|
|
5373
5372
|
}
|
|
5374
5373
|
|
|
5374
|
+
declare type FDC3Factory = typeof fdc3Factory;
|
|
5375
|
+
|
|
5376
|
+
declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin_2.InteropClient, wire: Transport<'unknown'>) => OpenFin_2.FDC3.v2_0.DesktopAgent | OpenFin_2.FDC3.v1_2.DesktopAgent;
|
|
5377
|
+
|
|
5375
5378
|
/**
|
|
5376
5379
|
* @interface
|
|
5377
5380
|
*/
|
|
@@ -5534,34 +5537,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
5534
5537
|
*/
|
|
5535
5538
|
declare type FindInPageOptions = {
|
|
5536
5539
|
/**
|
|
5537
|
-
* @defaultValue true
|
|
5538
|
-
*
|
|
5539
5540
|
* Searches in the forward direction (backward otherwise)
|
|
5541
|
+
*
|
|
5542
|
+
* @default true
|
|
5540
5543
|
*/
|
|
5541
5544
|
forward?: boolean;
|
|
5542
5545
|
/**
|
|
5543
|
-
* @defaultValue false
|
|
5544
|
-
*
|
|
5545
5546
|
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5547
|
+
*
|
|
5548
|
+
* @default false
|
|
5546
5549
|
*/
|
|
5547
5550
|
findNext?: boolean;
|
|
5548
5551
|
/**
|
|
5549
|
-
* @defaultValue false
|
|
5550
|
-
*
|
|
5551
5552
|
* Enables case-sensitive searching.
|
|
5553
|
+
*
|
|
5554
|
+
* @default false
|
|
5552
5555
|
*/
|
|
5553
5556
|
matchCase?: boolean;
|
|
5554
5557
|
/**
|
|
5555
|
-
* @defaultValue false
|
|
5556
|
-
*
|
|
5557
5558
|
* Only searches from the start of words.
|
|
5559
|
+
*
|
|
5560
|
+
* @default false
|
|
5558
5561
|
*/
|
|
5559
5562
|
wordStart?: boolean;
|
|
5560
5563
|
/**
|
|
5561
|
-
* @defaultValue false
|
|
5562
|
-
*
|
|
5563
5564
|
* When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
|
|
5564
5565
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5566
|
+
*
|
|
5567
|
+
* @default false
|
|
5565
5568
|
*/
|
|
5566
5569
|
medialCapitalAsWordStart?: boolean;
|
|
5567
5570
|
};
|
|
@@ -6069,9 +6072,9 @@ declare type Hotkey = {
|
|
|
6069
6072
|
*/
|
|
6070
6073
|
keys: string;
|
|
6071
6074
|
/**
|
|
6072
|
-
* @defaultValue false
|
|
6073
|
-
*
|
|
6074
6075
|
* Prevent default key handling before emitting the event.
|
|
6076
|
+
*
|
|
6077
|
+
* @default false
|
|
6075
6078
|
*/
|
|
6076
6079
|
preventDefault?: boolean;
|
|
6077
6080
|
};
|
|
@@ -7024,7 +7027,7 @@ declare class InteropBroker extends Base {
|
|
|
7024
7027
|
};
|
|
7025
7028
|
private getClientState;
|
|
7026
7029
|
private static toObject;
|
|
7027
|
-
static checkContextIntegrity(context: OpenFin_2.Context)
|
|
7030
|
+
static checkContextIntegrity: (context: OpenFin_2.Context) => {
|
|
7028
7031
|
isValid: true;
|
|
7029
7032
|
} | {
|
|
7030
7033
|
isValid: false;
|
|
@@ -8407,77 +8410,79 @@ declare type LayoutOptions = {
|
|
|
8407
8410
|
*/
|
|
8408
8411
|
settings?: {
|
|
8409
8412
|
/**
|
|
8410
|
-
* @defaultValue false
|
|
8411
|
-
*
|
|
8412
8413
|
* When true the splitters will not be draggable and the layout will not resize.
|
|
8414
|
+
*
|
|
8415
|
+
* @default false
|
|
8413
8416
|
*/
|
|
8414
8417
|
preventSplitterResize?: boolean;
|
|
8415
8418
|
/**
|
|
8416
|
-
* @defaultValue false
|
|
8417
|
-
*
|
|
8418
8419
|
* Whether the popout button will only act on the entire stack,
|
|
8419
8420
|
* as opposed to only the active tab.
|
|
8421
|
+
*
|
|
8422
|
+
* @default false
|
|
8420
8423
|
*/
|
|
8421
8424
|
popoutWholeStack?: boolean;
|
|
8422
8425
|
/**
|
|
8423
|
-
* @defaultValue false
|
|
8424
|
-
*
|
|
8425
8426
|
* Limits the area to which tabs can be dragged.
|
|
8426
8427
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8428
|
+
*
|
|
8429
|
+
* @default false
|
|
8427
8430
|
*/
|
|
8428
8431
|
constrainDragToContainer?: boolean;
|
|
8429
8432
|
/**
|
|
8430
|
-
* @defaultValue false
|
|
8431
|
-
*
|
|
8432
8433
|
* Whether to show the popout button on stack header.
|
|
8433
8434
|
* The button will create a new window with current tab as its content.
|
|
8434
8435
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8436
|
+
*
|
|
8437
|
+
* @default false
|
|
8435
8438
|
*/
|
|
8436
8439
|
showPopoutIcon?: boolean;
|
|
8437
8440
|
/**
|
|
8438
|
-
* @defaultValue false
|
|
8439
|
-
*
|
|
8440
8441
|
* Whether to show the maximize button on stack header.
|
|
8441
8442
|
* The button will maximize the current tab to fill the entire window.
|
|
8443
|
+
*
|
|
8444
|
+
* @default false
|
|
8442
8445
|
*/
|
|
8443
8446
|
showMaximiseIcon?: boolean;
|
|
8444
8447
|
/**
|
|
8445
|
-
* @defaultValue false
|
|
8446
|
-
*
|
|
8447
8448
|
* Whether to show the close button on stack header
|
|
8448
8449
|
* (not to be confused with close button on every tab).
|
|
8450
|
+
*
|
|
8451
|
+
* @default false
|
|
8449
8452
|
*/
|
|
8450
8453
|
showCloseIcon?: boolean;
|
|
8451
8454
|
/**
|
|
8452
|
-
* @defaultValue false
|
|
8453
|
-
*
|
|
8454
8455
|
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8456
|
+
*
|
|
8457
|
+
* @default false
|
|
8455
8458
|
*/
|
|
8456
8459
|
constrainDragToHeaders?: boolean;
|
|
8457
8460
|
/**
|
|
8458
|
-
* @defaultValue true
|
|
8459
|
-
*
|
|
8460
8461
|
* Turns tab headers on or off.
|
|
8461
8462
|
* If false, the layout will be displayed with splitters only.
|
|
8463
|
+
*
|
|
8464
|
+
* @default true
|
|
8462
8465
|
*/
|
|
8463
8466
|
hasHeaders?: boolean;
|
|
8464
8467
|
/**
|
|
8465
|
-
* @defaultValue true
|
|
8466
|
-
*
|
|
8467
8468
|
* If true, the user can re-arrange the layout by
|
|
8468
8469
|
* dragging items by their tabs to the desired location.
|
|
8470
|
+
*
|
|
8471
|
+
* @default true
|
|
8469
8472
|
*/
|
|
8470
8473
|
reorderEnabled?: boolean;
|
|
8471
8474
|
/**
|
|
8472
|
-
* @defaultValue false
|
|
8473
|
-
*
|
|
8474
8475
|
* If true, tabs can't be dragged out of the window.
|
|
8476
|
+
*
|
|
8477
|
+
* @default false
|
|
8475
8478
|
*/
|
|
8476
8479
|
preventDragOut?: boolean;
|
|
8477
8480
|
/**
|
|
8478
8481
|
* @defaultValue=false
|
|
8479
8482
|
*
|
|
8480
8483
|
* If true, tabs can't be dragged into the window.
|
|
8484
|
+
*
|
|
8485
|
+
* @default false
|
|
8481
8486
|
*/
|
|
8482
8487
|
preventDragIn?: boolean;
|
|
8483
8488
|
};
|
|
@@ -8920,10 +8925,10 @@ declare type MutableViewOptions = {
|
|
|
8920
8925
|
/**
|
|
8921
8926
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
8922
8927
|
*
|
|
8923
|
-
* @defaultValue true
|
|
8924
|
-
*
|
|
8925
8928
|
* Show the context menu when right-clicking on the view.
|
|
8926
8929
|
* Gives access to the devtools for the view.
|
|
8930
|
+
*
|
|
8931
|
+
* @default true
|
|
8927
8932
|
*/
|
|
8928
8933
|
contextMenu: boolean;
|
|
8929
8934
|
/**
|
|
@@ -8970,24 +8975,25 @@ declare type MutableViewOptions = {
|
|
|
8970
8975
|
contentNavigation: ContentNavigation;
|
|
8971
8976
|
contentRedirect: ContentRedirect;
|
|
8972
8977
|
/**
|
|
8973
|
-
* @defaultValue false
|
|
8974
8978
|
* @deprecated
|
|
8975
8979
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
8976
8980
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
8981
|
+
*
|
|
8982
|
+
* @default false
|
|
8977
8983
|
*/
|
|
8978
8984
|
detachOnClose: boolean;
|
|
8979
8985
|
/**
|
|
8980
|
-
* @defaultValue true
|
|
8981
|
-
*
|
|
8982
8986
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
8983
8987
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
8984
8988
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
8989
|
+
*
|
|
8990
|
+
* @default true
|
|
8985
8991
|
*/
|
|
8986
8992
|
isClosable: boolean;
|
|
8987
8993
|
/**
|
|
8988
|
-
* @defaultValue false
|
|
8989
|
-
*
|
|
8990
8994
|
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
8995
|
+
*
|
|
8996
|
+
* @default false
|
|
8991
8997
|
*/
|
|
8992
8998
|
preventDragOut: boolean;
|
|
8993
8999
|
interop?: InteropConfig;
|
|
@@ -8995,7 +9001,7 @@ declare type MutableViewOptions = {
|
|
|
8995
9001
|
/**
|
|
8996
9002
|
* {@inheritDoc ViewThrottling}
|
|
8997
9003
|
*
|
|
8998
|
-
* @
|
|
9004
|
+
* @default 'enabled'
|
|
8999
9005
|
*/
|
|
9000
9006
|
throttling: ViewThrottling;
|
|
9001
9007
|
/**
|
|
@@ -9014,7 +9020,7 @@ declare type MutableWindowOptions = {
|
|
|
9014
9020
|
* Turns anything of matching RGB value transparent.
|
|
9015
9021
|
*
|
|
9016
9022
|
* Caveats:
|
|
9017
|
-
* *
|
|
9023
|
+
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
9018
9024
|
* * User cannot click-through transparent regions
|
|
9019
9025
|
* * Not supported on Mac
|
|
9020
9026
|
* * Windows Aero must be enabled
|
|
@@ -9023,25 +9029,25 @@ declare type MutableWindowOptions = {
|
|
|
9023
9029
|
*/
|
|
9024
9030
|
alphaMask: RGB;
|
|
9025
9031
|
/**
|
|
9026
|
-
* @defaultValue false
|
|
9027
|
-
*
|
|
9028
9032
|
* Always position the window at the top of the window stack.
|
|
9033
|
+
*
|
|
9034
|
+
* @default false
|
|
9029
9035
|
*/
|
|
9030
9036
|
alwaysOnTop: boolean;
|
|
9031
9037
|
/**
|
|
9032
|
-
* @defaultValue 0
|
|
9033
|
-
*
|
|
9034
9038
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9035
9039
|
* an aspect ratio will not be enforced.
|
|
9040
|
+
*
|
|
9041
|
+
* @default 0
|
|
9036
9042
|
*/
|
|
9037
9043
|
aspectRatio: number;
|
|
9038
9044
|
/**
|
|
9039
9045
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9040
9046
|
*
|
|
9041
|
-
* @defaultValue true
|
|
9042
|
-
*
|
|
9043
9047
|
* Show the context menu when right-clicking on the window.
|
|
9044
9048
|
* Gives access to the devtools for the window.
|
|
9049
|
+
*
|
|
9050
|
+
* @default true
|
|
9045
9051
|
*/
|
|
9046
9052
|
contextMenu: boolean;
|
|
9047
9053
|
/**
|
|
@@ -9111,12 +9117,14 @@ declare type MutableWindowOptions = {
|
|
|
9111
9117
|
* @defaultValue true
|
|
9112
9118
|
*
|
|
9113
9119
|
* Show the window's frame.
|
|
9120
|
+
*
|
|
9121
|
+
* @default true
|
|
9114
9122
|
*/
|
|
9115
9123
|
frame: boolean;
|
|
9116
9124
|
/**
|
|
9117
|
-
* @defaultValue false
|
|
9118
|
-
*
|
|
9119
9125
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9126
|
+
*
|
|
9127
|
+
* @default false
|
|
9120
9128
|
*/
|
|
9121
9129
|
hideOnClose: boolean;
|
|
9122
9130
|
/**
|
|
@@ -9169,60 +9177,61 @@ declare type MutableWindowOptions = {
|
|
|
9169
9177
|
*/
|
|
9170
9178
|
icon: string;
|
|
9171
9179
|
/**
|
|
9172
|
-
* @defaultValue true
|
|
9173
|
-
*
|
|
9174
9180
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9175
9181
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9182
|
+
*
|
|
9183
|
+
* @default true
|
|
9176
9184
|
*/
|
|
9177
9185
|
includeInSnapshots: boolean;
|
|
9178
9186
|
/**
|
|
9179
|
-
* @defaultValue -1
|
|
9180
|
-
*
|
|
9181
9187
|
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9188
|
+
*
|
|
9189
|
+
* @default -1
|
|
9182
9190
|
*/
|
|
9183
9191
|
maxHeight: number;
|
|
9184
9192
|
/**
|
|
9185
|
-
* @defaultValue true
|
|
9186
|
-
*
|
|
9187
9193
|
* Allows the window to be maximized.
|
|
9194
|
+
*
|
|
9195
|
+
* @default true
|
|
9188
9196
|
*/
|
|
9189
9197
|
maximizable: boolean;
|
|
9190
9198
|
/**
|
|
9191
|
-
* @defaultValue -1
|
|
9192
|
-
*
|
|
9193
9199
|
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9200
|
+
*
|
|
9201
|
+
* @default -1
|
|
9194
9202
|
*/
|
|
9195
9203
|
maxWidth: number;
|
|
9196
9204
|
/**
|
|
9197
|
-
* @defaultValue 0
|
|
9198
|
-
*
|
|
9199
9205
|
* The minimum height of the window.
|
|
9206
|
+
*
|
|
9207
|
+
* @default 0
|
|
9200
9208
|
*/
|
|
9201
9209
|
minHeight: number;
|
|
9202
9210
|
/**
|
|
9203
|
-
* @defaultValue true
|
|
9204
|
-
*
|
|
9205
9211
|
* Allows the window to be minimized.
|
|
9212
|
+
*
|
|
9213
|
+
* @default true
|
|
9206
9214
|
*/
|
|
9207
9215
|
minimizable: boolean;
|
|
9208
9216
|
/**
|
|
9209
|
-
* @defaultValue true
|
|
9210
|
-
*
|
|
9211
9217
|
* The minimum width of the window.
|
|
9218
|
+
*
|
|
9219
|
+
* @default true
|
|
9212
9220
|
*/
|
|
9213
9221
|
minWidth: number;
|
|
9214
9222
|
/**
|
|
9215
|
-
* @defaultValue 1
|
|
9216
|
-
*
|
|
9217
9223
|
* A flag that specifies how transparent the window will be.
|
|
9218
9224
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9219
9225
|
* This value is clamped between `0.0` and `1.0`.
|
|
9226
|
+
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9227
|
+
*
|
|
9228
|
+
* @default 1
|
|
9220
9229
|
*/
|
|
9221
9230
|
opacity: number;
|
|
9222
9231
|
/**
|
|
9223
|
-
* @defaultValue true
|
|
9224
|
-
*
|
|
9225
9232
|
* A flag to allow the user to resize the window.
|
|
9233
|
+
*
|
|
9234
|
+
* @default true
|
|
9226
9235
|
*/
|
|
9227
9236
|
resizable: boolean;
|
|
9228
9237
|
/**
|
|
@@ -9230,16 +9239,16 @@ declare type MutableWindowOptions = {
|
|
|
9230
9239
|
*/
|
|
9231
9240
|
resizeRegion: ResizeRegion;
|
|
9232
9241
|
/**
|
|
9233
|
-
* @defaultValue false
|
|
9234
|
-
*
|
|
9235
9242
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9236
9243
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9244
|
+
*
|
|
9245
|
+
* @default false
|
|
9237
9246
|
*/
|
|
9238
9247
|
showBackgroundImages: boolean;
|
|
9239
9248
|
/**
|
|
9240
|
-
* @defaultValue true
|
|
9241
|
-
*
|
|
9242
9249
|
* Shows the window's icon in the taskbar.
|
|
9250
|
+
*
|
|
9251
|
+
* @default true
|
|
9243
9252
|
*/
|
|
9244
9253
|
showTaskbarIcon: boolean;
|
|
9245
9254
|
/**
|
|
@@ -9254,7 +9263,7 @@ declare type MutableWindowOptions = {
|
|
|
9254
9263
|
/**
|
|
9255
9264
|
* {@inheritDoc WindowThrottling}
|
|
9256
9265
|
*
|
|
9257
|
-
* @
|
|
9266
|
+
* @default 'enabled'
|
|
9258
9267
|
*
|
|
9259
9268
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9260
9269
|
*/
|
|
@@ -9863,12 +9872,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
9863
9872
|
*/
|
|
9864
9873
|
declare type PastePermissions = {
|
|
9865
9874
|
/**
|
|
9866
|
-
* @defaultValue 'non-protected-content'
|
|
9867
|
-
*
|
|
9868
9875
|
* Controls the behavior for paste operations for a matched URL.
|
|
9869
9876
|
*
|
|
9870
9877
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
9871
9878
|
* all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
|
|
9879
|
+
*
|
|
9880
|
+
* @default 'non-protected-content'
|
|
9872
9881
|
*/
|
|
9873
9882
|
behavior: 'non-protected-content' | 'all-content';
|
|
9874
9883
|
};
|
|
@@ -10895,11 +10904,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
10895
10904
|
*/
|
|
10896
10905
|
providerUrl?: string;
|
|
10897
10906
|
/**
|
|
10898
|
-
* @defaultValue true
|
|
10899
|
-
*
|
|
10900
10907
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
10901
10908
|
*
|
|
10902
10909
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
10910
|
+
*
|
|
10911
|
+
* @default true
|
|
10903
10912
|
*/
|
|
10904
10913
|
allowLaunchIntoPlatform?: boolean;
|
|
10905
10914
|
};
|
|
@@ -11543,22 +11552,22 @@ declare type PopupOptions = {
|
|
|
11543
11552
|
url?: string;
|
|
11544
11553
|
/**
|
|
11545
11554
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11546
|
-
* @
|
|
11555
|
+
* @default 300
|
|
11547
11556
|
*/
|
|
11548
11557
|
height?: number;
|
|
11549
11558
|
/**
|
|
11550
11559
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11551
|
-
* @
|
|
11560
|
+
* @default 300
|
|
11552
11561
|
*/
|
|
11553
11562
|
width?: number;
|
|
11554
11563
|
/**
|
|
11555
11564
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11556
|
-
* @
|
|
11565
|
+
* @default 0
|
|
11557
11566
|
*/
|
|
11558
11567
|
x?: number;
|
|
11559
11568
|
/**
|
|
11560
11569
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11561
|
-
* @
|
|
11570
|
+
* @default 0
|
|
11562
11571
|
*/
|
|
11563
11572
|
y?: number;
|
|
11564
11573
|
/**
|
|
@@ -11566,7 +11575,7 @@ declare type PopupOptions = {
|
|
|
11566
11575
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
11567
11576
|
* * 'hide' hides the popup window on blur.
|
|
11568
11577
|
* * 'close' closes the popup window on blur.
|
|
11569
|
-
* @
|
|
11578
|
+
* @default 'close'
|
|
11570
11579
|
*/
|
|
11571
11580
|
blurBehavior?: PopupBlurBehavior;
|
|
11572
11581
|
/**
|
|
@@ -11574,19 +11583,19 @@ declare type PopupOptions = {
|
|
|
11574
11583
|
* * 'none' will do nothing.
|
|
11575
11584
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
11576
11585
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
11577
|
-
* @
|
|
11586
|
+
* @default 'close'
|
|
11578
11587
|
*/
|
|
11579
11588
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
11580
11589
|
/**
|
|
11581
11590
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
11582
11591
|
*
|
|
11583
11592
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
11584
|
-
* @
|
|
11593
|
+
* @default false
|
|
11585
11594
|
*/
|
|
11586
11595
|
hideOnClose?: boolean;
|
|
11587
11596
|
/**
|
|
11588
11597
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
11589
|
-
* @
|
|
11598
|
+
* @default true
|
|
11590
11599
|
*/
|
|
11591
11600
|
focus?: boolean;
|
|
11592
11601
|
/**
|
|
@@ -11680,9 +11689,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
11680
11689
|
*/
|
|
11681
11690
|
declare type PreloadScript = {
|
|
11682
11691
|
/**
|
|
11683
|
-
* @defaultValue false
|
|
11684
|
-
*
|
|
11685
11692
|
* Fail to load the window if this preload script fails
|
|
11693
|
+
*
|
|
11694
|
+
* @default false
|
|
11686
11695
|
*/
|
|
11687
11696
|
mandatory?: boolean;
|
|
11688
11697
|
/**
|
|
@@ -11778,15 +11787,15 @@ declare type PrinterInfo = {
|
|
|
11778
11787
|
declare type PrintOptions = {
|
|
11779
11788
|
content?: 'self';
|
|
11780
11789
|
/**
|
|
11781
|
-
* @defaultValue false
|
|
11782
|
-
*
|
|
11783
11790
|
* Disables prompting the user for print settings.
|
|
11791
|
+
*
|
|
11792
|
+
* @default false
|
|
11784
11793
|
*/
|
|
11785
11794
|
silent?: boolean;
|
|
11786
11795
|
/**
|
|
11787
|
-
* @defaultValue false
|
|
11788
|
-
*
|
|
11789
11796
|
* Includes the webpage background color and image when printing.
|
|
11797
|
+
*
|
|
11798
|
+
* @default false
|
|
11790
11799
|
*/
|
|
11791
11800
|
printBackground?: boolean;
|
|
11792
11801
|
/**
|
|
@@ -11794,9 +11803,9 @@ declare type PrintOptions = {
|
|
|
11794
11803
|
*/
|
|
11795
11804
|
deviceName?: string;
|
|
11796
11805
|
/**
|
|
11797
|
-
* @defaultValue true
|
|
11798
|
-
*
|
|
11799
11806
|
* Prints in full color (greyscale otherwise).
|
|
11807
|
+
*
|
|
11808
|
+
* @default true
|
|
11800
11809
|
*/
|
|
11801
11810
|
color?: boolean;
|
|
11802
11811
|
/**
|
|
@@ -11804,9 +11813,9 @@ declare type PrintOptions = {
|
|
|
11804
11813
|
*/
|
|
11805
11814
|
margins?: Margins;
|
|
11806
11815
|
/**
|
|
11807
|
-
* @defaultValue true
|
|
11808
|
-
*
|
|
11809
11816
|
* Prints in landscape mode (portrait otherwise).
|
|
11817
|
+
*
|
|
11818
|
+
* @default true
|
|
11810
11819
|
*/
|
|
11811
11820
|
landscape?: boolean;
|
|
11812
11821
|
/**
|
|
@@ -12977,15 +12986,15 @@ declare type ReplaceViewPayload = {
|
|
|
12977
12986
|
*/
|
|
12978
12987
|
declare type ResizeRegion = {
|
|
12979
12988
|
/**
|
|
12980
|
-
* @defaultValue 7
|
|
12981
|
-
*
|
|
12982
12989
|
* The size of the resize region in pixels.
|
|
12990
|
+
*
|
|
12991
|
+
* @default 7
|
|
12983
12992
|
*/
|
|
12984
12993
|
size?: number;
|
|
12985
12994
|
/**
|
|
12986
|
-
* @defaultValue 9
|
|
12987
|
-
*
|
|
12988
12995
|
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
12996
|
+
*
|
|
12997
|
+
* @default 9
|
|
12989
12998
|
*/
|
|
12990
12999
|
bottomRightCorner?: number;
|
|
12991
13000
|
/**
|
|
@@ -12993,27 +13002,27 @@ declare type ResizeRegion = {
|
|
|
12993
13002
|
*/
|
|
12994
13003
|
sides?: {
|
|
12995
13004
|
/**
|
|
12996
|
-
* @defaultValue true
|
|
12997
|
-
*
|
|
12998
13005
|
* Enables resizing from the top of the window.
|
|
13006
|
+
*
|
|
13007
|
+
* @default true
|
|
12999
13008
|
*/
|
|
13000
13009
|
top?: boolean;
|
|
13001
13010
|
/**
|
|
13002
|
-
* @defaultValue true
|
|
13003
|
-
*
|
|
13004
13011
|
* Enables resizing from the bottom of the window.
|
|
13012
|
+
*
|
|
13013
|
+
* @default true
|
|
13005
13014
|
*/
|
|
13006
13015
|
bottom?: boolean;
|
|
13007
13016
|
/**
|
|
13008
|
-
* @defaultValue true
|
|
13009
|
-
*
|
|
13010
13017
|
* Enables resizing from the left side of the window.
|
|
13018
|
+
*
|
|
13019
|
+
* @default true
|
|
13011
13020
|
*/
|
|
13012
13021
|
left?: boolean;
|
|
13013
13022
|
/**
|
|
13014
|
-
* @defaultValue true
|
|
13015
|
-
*
|
|
13016
13023
|
* Enables resizing from the right side of the window.
|
|
13024
|
+
*
|
|
13025
|
+
* @default true
|
|
13017
13026
|
*/
|
|
13018
13027
|
right?: boolean;
|
|
13019
13028
|
};
|
|
@@ -13557,9 +13566,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13557
13566
|
*/
|
|
13558
13567
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
13559
13568
|
/**
|
|
13560
|
-
* @defaultValue 0
|
|
13561
|
-
*
|
|
13562
13569
|
* Number of milliseconds to wait between view repaints.
|
|
13570
|
+
*
|
|
13571
|
+
* @default 0
|
|
13563
13572
|
*/
|
|
13564
13573
|
paintIntervalMs?: number;
|
|
13565
13574
|
};
|
|
@@ -15597,9 +15606,9 @@ declare type TransitionBase = {
|
|
|
15597
15606
|
*/
|
|
15598
15607
|
duration: number;
|
|
15599
15608
|
/**
|
|
15600
|
-
* @defaultValue false
|
|
15601
|
-
*
|
|
15602
15609
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
15610
|
+
*
|
|
15611
|
+
* @default false
|
|
15603
15612
|
*/
|
|
15604
15613
|
relative?: boolean;
|
|
15605
15614
|
};
|
|
@@ -15615,9 +15624,9 @@ declare type TransitionOptions = {
|
|
|
15615
15624
|
*/
|
|
15616
15625
|
interrupt: boolean;
|
|
15617
15626
|
/**
|
|
15618
|
-
* @defaultValue false
|
|
15619
|
-
*
|
|
15620
15627
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
15628
|
+
*
|
|
15629
|
+
* @default false
|
|
15621
15630
|
*/
|
|
15622
15631
|
relative?: boolean;
|
|
15623
15632
|
tween?: tween;
|
|
@@ -16539,9 +16548,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
|
16539
16548
|
*/
|
|
16540
16549
|
declare type ViewVisibilityOption = {
|
|
16541
16550
|
/**
|
|
16542
|
-
* @defaultValue false
|
|
16543
|
-
*
|
|
16544
16551
|
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
16552
|
+
*
|
|
16553
|
+
* @default false
|
|
16545
16554
|
*/
|
|
16546
16555
|
enabled?: boolean;
|
|
16547
16556
|
};
|