@openfin/fdc3-api 43.100.45 → 43.100.49
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 +205 -201
- package/out/fdc3-api-beta.d.ts +205 -201
- package/out/fdc3-api-public.d.ts +205 -201
- package/out/fdc3-api.d.ts +205 -201
- package/package.json +1 -1
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -136,13 +136,13 @@ declare type ApiSettings = {
|
|
|
136
136
|
/**
|
|
137
137
|
* Inject OpenFin API into cross-origin iframes
|
|
138
138
|
*
|
|
139
|
-
* @
|
|
139
|
+
* @default false
|
|
140
140
|
*/
|
|
141
141
|
crossOriginInjection?: boolean;
|
|
142
142
|
/**
|
|
143
143
|
* Inject OpenFin API into same-origin iframes
|
|
144
144
|
*
|
|
145
|
-
* @
|
|
145
|
+
* @default true
|
|
146
146
|
*/
|
|
147
147
|
sameOriginInjection?: boolean;
|
|
148
148
|
/**
|
|
@@ -1181,19 +1181,19 @@ declare class ApplicationModule extends Base {
|
|
|
1181
1181
|
*/
|
|
1182
1182
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1183
1183
|
/**
|
|
1184
|
-
* @defaultValue false
|
|
1185
|
-
*
|
|
1186
1184
|
* Disables IAB secure logging for the app.
|
|
1185
|
+
*
|
|
1186
|
+
* @default false
|
|
1187
1187
|
*/
|
|
1188
1188
|
disableIabSecureLogging: boolean;
|
|
1189
1189
|
/**
|
|
1190
|
-
* @defaultValue 'There was an error loading the application.'
|
|
1191
|
-
*
|
|
1192
1190
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1193
1191
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1194
1192
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1195
1193
|
* will trigger this dialog.
|
|
1196
1194
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1195
|
+
*
|
|
1196
|
+
* @default 'There was an error loading the application.'
|
|
1197
1197
|
*/
|
|
1198
1198
|
loadErrorMessage: string;
|
|
1199
1199
|
/**
|
|
@@ -1212,28 +1212,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1212
1212
|
*/
|
|
1213
1213
|
name: string;
|
|
1214
1214
|
/**
|
|
1215
|
-
* @defaultValue false
|
|
1216
|
-
*
|
|
1217
1215
|
* A flag to configure the application as non-persistent.
|
|
1218
1216
|
* Runtime exits when there are no persistent apps running.
|
|
1217
|
+
*
|
|
1218
|
+
* @default false
|
|
1219
1219
|
*/
|
|
1220
1220
|
nonPersistent: boolean;
|
|
1221
1221
|
/**
|
|
1222
|
-
* @defaultValue false
|
|
1223
|
-
*
|
|
1224
1222
|
* Enable Flash at the application level.
|
|
1223
|
+
*
|
|
1224
|
+
* @default false
|
|
1225
1225
|
*/
|
|
1226
1226
|
plugins: boolean;
|
|
1227
1227
|
/**
|
|
1228
|
-
* @defaultValue false
|
|
1229
|
-
*
|
|
1230
1228
|
* Enable spell check at the application level.
|
|
1229
|
+
*
|
|
1230
|
+
* @default false
|
|
1231
1231
|
*/
|
|
1232
1232
|
spellCheck: boolean;
|
|
1233
1233
|
/**
|
|
1234
|
-
* @defaultValue 'about:blank'
|
|
1235
|
-
*
|
|
1236
1234
|
* The url to the application (specifically the application's main window).
|
|
1235
|
+
*
|
|
1236
|
+
* @default 'about:blank'
|
|
1237
1237
|
*/
|
|
1238
1238
|
url: string;
|
|
1239
1239
|
/**
|
|
@@ -1242,9 +1242,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1242
1242
|
*/
|
|
1243
1243
|
uuid: string;
|
|
1244
1244
|
/**
|
|
1245
|
-
* @defaultValue true
|
|
1246
|
-
*
|
|
1247
1245
|
* When set to `false` it will disable the same-origin policy for the app.
|
|
1246
|
+
*
|
|
1247
|
+
* @default true
|
|
1248
1248
|
*/
|
|
1249
1249
|
webSecurity: boolean;
|
|
1250
1250
|
/**
|
|
@@ -1254,10 +1254,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1254
1254
|
commands: ShortcutOverride[];
|
|
1255
1255
|
isPlatformController: boolean;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @defaultValue 1000
|
|
1258
|
-
*
|
|
1259
1257
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1260
1258
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1259
|
+
*
|
|
1260
|
+
* @default 1000
|
|
1261
1261
|
*/
|
|
1262
1262
|
maxViewPoolSize: number;
|
|
1263
1263
|
/**
|
|
@@ -1273,12 +1273,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1273
1273
|
*/
|
|
1274
1274
|
snapshot: Snapshot;
|
|
1275
1275
|
/**
|
|
1276
|
-
* @defaultValue false
|
|
1277
|
-
*
|
|
1278
1276
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1279
1277
|
*
|
|
1280
1278
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1281
1279
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1280
|
+
*
|
|
1281
|
+
* @default false
|
|
1282
1282
|
*/
|
|
1283
1283
|
preventQuitOnLastWindowClosed: boolean;
|
|
1284
1284
|
/**
|
|
@@ -1286,9 +1286,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1286
1286
|
*/
|
|
1287
1287
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1288
1288
|
/**
|
|
1289
|
-
* @defaultValue true
|
|
1290
|
-
*
|
|
1291
1289
|
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1290
|
+
*
|
|
1291
|
+
* @default true
|
|
1292
1292
|
*/
|
|
1293
1293
|
apiDiagnostics: boolean;
|
|
1294
1294
|
/**
|
|
@@ -1304,16 +1304,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1304
1304
|
*/
|
|
1305
1305
|
permissions?: Partial<Permissions_2>;
|
|
1306
1306
|
/**
|
|
1307
|
-
* @defaultValue false
|
|
1308
|
-
*
|
|
1309
1307
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1310
1308
|
* Only relevant in Windows.
|
|
1309
|
+
*
|
|
1310
|
+
* @default false
|
|
1311
1311
|
*/
|
|
1312
1312
|
enableJumpList: boolean;
|
|
1313
1313
|
/**
|
|
1314
|
-
* @defaultValue false
|
|
1315
|
-
*
|
|
1316
1314
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1315
|
+
*
|
|
1316
|
+
* @default false
|
|
1317
1317
|
*/
|
|
1318
1318
|
enableBeforeUnload: boolean;
|
|
1319
1319
|
/**
|
|
@@ -1394,25 +1394,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1394
1394
|
*/
|
|
1395
1395
|
declare type ApplySnapshotOptions = {
|
|
1396
1396
|
/**
|
|
1397
|
-
* @defaultValue false
|
|
1398
|
-
*
|
|
1399
1397
|
* When true, applySnapshot will close existing windows,
|
|
1400
1398
|
* replacing current Platform state with the given snapshot.
|
|
1399
|
+
*
|
|
1400
|
+
* @default false
|
|
1401
1401
|
*/
|
|
1402
1402
|
closeExistingWindows?: boolean;
|
|
1403
1403
|
/**
|
|
1404
|
-
* @defaultValue false
|
|
1405
|
-
*
|
|
1406
1404
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1407
1405
|
* replacing current Platform state with the given snapshot.
|
|
1406
|
+
*
|
|
1407
|
+
* @default false
|
|
1408
1408
|
*/
|
|
1409
1409
|
closeSnapshotWindows?: boolean;
|
|
1410
1410
|
/**
|
|
1411
|
-
* @defaultValue false
|
|
1412
|
-
*
|
|
1413
1411
|
* When true, applySnapshot will not check whether any windows in a
|
|
1414
1412
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1415
1413
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1414
|
+
*
|
|
1415
|
+
* @default false
|
|
1416
1416
|
*/
|
|
1417
1417
|
skipOutOfBoundsCheck?: boolean;
|
|
1418
1418
|
};
|
|
@@ -2069,15 +2069,15 @@ declare type CapturePageOptions = {
|
|
|
2069
2069
|
*/
|
|
2070
2070
|
area?: Rectangle;
|
|
2071
2071
|
/**
|
|
2072
|
-
* @defaultValue 'png'
|
|
2073
|
-
*
|
|
2074
2072
|
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2073
|
+
*
|
|
2074
|
+
* @default 'png'
|
|
2075
2075
|
*/
|
|
2076
2076
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2077
2077
|
/**
|
|
2078
|
-
* @defaultValue 100
|
|
2079
|
-
*
|
|
2080
2078
|
* Quality of JPEG image. Between 0 - 100.
|
|
2079
|
+
*
|
|
2080
|
+
* @default 100
|
|
2081
2081
|
*/
|
|
2082
2082
|
quality?: number;
|
|
2083
2083
|
};
|
|
@@ -2710,9 +2710,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2710
2710
|
*/
|
|
2711
2711
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2712
2712
|
/**
|
|
2713
|
-
* @defaultValue true
|
|
2714
|
-
*
|
|
2715
2713
|
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2714
|
+
*
|
|
2715
|
+
* @default true
|
|
2716
2716
|
*/
|
|
2717
2717
|
wait?: boolean;
|
|
2718
2718
|
/**
|
|
@@ -3371,9 +3371,9 @@ declare interface CloseWindowPayload {
|
|
|
3371
3371
|
windowId: Identity_4;
|
|
3372
3372
|
options: {
|
|
3373
3373
|
/**
|
|
3374
|
-
* @defaultValue false
|
|
3375
|
-
*
|
|
3376
3374
|
* When set to true skips any before handler set on views that are part of the window
|
|
3375
|
+
*
|
|
3376
|
+
* @default false
|
|
3377
3377
|
*/
|
|
3378
3378
|
skipBeforeUnload?: boolean;
|
|
3379
3379
|
};
|
|
@@ -3478,9 +3478,9 @@ declare type ConstViewOptions = {
|
|
|
3478
3478
|
*/
|
|
3479
3479
|
name: string;
|
|
3480
3480
|
/**
|
|
3481
|
-
* @defaultValue "about:blank"
|
|
3482
|
-
*
|
|
3483
3481
|
* The URL of the window
|
|
3482
|
+
*
|
|
3483
|
+
* @default "about:blank"
|
|
3484
3484
|
*/
|
|
3485
3485
|
url: string;
|
|
3486
3486
|
/**
|
|
@@ -3541,9 +3541,9 @@ declare type ConstViewOptions = {
|
|
|
3541
3541
|
experimental: any;
|
|
3542
3542
|
fdc3InteropApi?: string;
|
|
3543
3543
|
/**
|
|
3544
|
-
* @defaultValue false
|
|
3545
|
-
*
|
|
3546
3544
|
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3545
|
+
*
|
|
3546
|
+
* @default false
|
|
3547
3547
|
*/
|
|
3548
3548
|
enableBeforeUnload: boolean;
|
|
3549
3549
|
/**
|
|
@@ -3624,13 +3624,12 @@ declare type ConstWindowOptions = {
|
|
|
3624
3624
|
*/
|
|
3625
3625
|
backgroundColor: string;
|
|
3626
3626
|
/**
|
|
3627
|
-
* @defaultValue false
|
|
3628
|
-
*
|
|
3629
3627
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3630
3628
|
* This also affects the Page Visibility API.
|
|
3631
3629
|
*
|
|
3632
3630
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3633
3631
|
*
|
|
3632
|
+
* @default false
|
|
3634
3633
|
*/
|
|
3635
3634
|
backgroundThrottling: boolean;
|
|
3636
3635
|
/**
|
|
@@ -3654,21 +3653,21 @@ declare type ConstWindowOptions = {
|
|
|
3654
3653
|
*/
|
|
3655
3654
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3656
3655
|
/**
|
|
3657
|
-
* @defaultValue true
|
|
3658
|
-
*
|
|
3659
3656
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3660
3657
|
* This is meant for advanced users and should be used with caution.
|
|
3661
3658
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3662
3659
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3663
3660
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3661
|
+
*
|
|
3662
|
+
* @default true
|
|
3664
3663
|
*/
|
|
3665
3664
|
closeOnLastViewRemoved: boolean;
|
|
3666
3665
|
/**
|
|
3667
|
-
* @defaultValue 'all'
|
|
3668
|
-
*
|
|
3669
3666
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3670
|
-
|
|
3667
|
+
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3671
3668
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3669
|
+
*
|
|
3670
|
+
* @default 'all'
|
|
3672
3671
|
*/
|
|
3673
3672
|
viewsPreventingClose: 'all' | 'layout';
|
|
3674
3673
|
/**
|
|
@@ -3679,31 +3678,31 @@ declare type ConstWindowOptions = {
|
|
|
3679
3678
|
*/
|
|
3680
3679
|
defaultCentered: boolean;
|
|
3681
3680
|
/**
|
|
3682
|
-
* @defaultValue 500
|
|
3683
|
-
*
|
|
3684
3681
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3685
3682
|
* in favor of the cached value.
|
|
3683
|
+
*
|
|
3684
|
+
* @default 500
|
|
3686
3685
|
*/
|
|
3687
3686
|
defaultHeight: number;
|
|
3688
3687
|
/**
|
|
3689
|
-
* @defaultValue 100
|
|
3690
|
-
*
|
|
3691
3688
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3692
3689
|
* launches in favor of the cached value.
|
|
3690
|
+
*
|
|
3691
|
+
* @default 100
|
|
3693
3692
|
*/
|
|
3694
3693
|
defaultLeft: number;
|
|
3695
3694
|
/**
|
|
3696
|
-
* @defaultValue 100
|
|
3697
|
-
*
|
|
3698
3695
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3699
3696
|
* launches in favor of the cached value.
|
|
3697
|
+
*
|
|
3698
|
+
* @default 100
|
|
3700
3699
|
*/
|
|
3701
3700
|
defaultTop: number;
|
|
3702
3701
|
/**
|
|
3703
|
-
* @defaultValue 800
|
|
3704
|
-
*
|
|
3705
3702
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3706
3703
|
* launches in favor of the cached value.
|
|
3704
|
+
*
|
|
3705
|
+
* @default 800
|
|
3707
3706
|
*/
|
|
3708
3707
|
defaultWidth: number;
|
|
3709
3708
|
/**
|
|
@@ -3749,19 +3748,19 @@ declare type ConstWindowOptions = {
|
|
|
3749
3748
|
*/
|
|
3750
3749
|
processAffinity: string;
|
|
3751
3750
|
/**
|
|
3752
|
-
* @defaultValue false
|
|
3753
|
-
*
|
|
3754
3751
|
* Displays a shadow on frameless windows.
|
|
3755
3752
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3756
3753
|
* On Windows 7, Aero theme is required.
|
|
3754
|
+
*
|
|
3755
|
+
* @default false
|
|
3757
3756
|
*/
|
|
3758
3757
|
shadow: boolean;
|
|
3759
3758
|
/**
|
|
3760
|
-
* @defaultValue true
|
|
3761
|
-
*
|
|
3762
3759
|
* Caches the location of the window.
|
|
3763
3760
|
*
|
|
3764
3761
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3762
|
+
*
|
|
3763
|
+
* @default true
|
|
3765
3764
|
*/
|
|
3766
3765
|
saveWindowState: boolean;
|
|
3767
3766
|
/**
|
|
@@ -3770,22 +3769,22 @@ declare type ConstWindowOptions = {
|
|
|
3770
3769
|
*/
|
|
3771
3770
|
ignoreSavedWindowState: boolean;
|
|
3772
3771
|
/**
|
|
3773
|
-
* @defaultValue false
|
|
3774
|
-
*
|
|
3775
3772
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3776
3773
|
*
|
|
3777
3774
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3778
3775
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3776
|
+
*
|
|
3777
|
+
* @default false
|
|
3779
3778
|
*/
|
|
3780
3779
|
smallWindow: boolean;
|
|
3781
3780
|
/**
|
|
3782
|
-
* @defaultValue "normal"
|
|
3783
|
-
*
|
|
3784
3781
|
* The visible state of the window on creation.
|
|
3785
3782
|
* One of:
|
|
3786
3783
|
* * `"maximized"`
|
|
3787
3784
|
* * `"minimized"`
|
|
3788
3785
|
* * `"normal"`
|
|
3786
|
+
*
|
|
3787
|
+
* @default "normal"
|
|
3789
3788
|
*/
|
|
3790
3789
|
state: WindowState;
|
|
3791
3790
|
/**
|
|
@@ -3800,26 +3799,26 @@ declare type ConstWindowOptions = {
|
|
|
3800
3799
|
*/
|
|
3801
3800
|
taskbarIconGroup: string;
|
|
3802
3801
|
/**
|
|
3803
|
-
* @defaultValue "about:blank"
|
|
3804
|
-
*
|
|
3805
3802
|
* The URL of the window
|
|
3803
|
+
*
|
|
3804
|
+
* @default "about:blank"
|
|
3806
3805
|
*/
|
|
3807
3806
|
url: string;
|
|
3808
3807
|
/**
|
|
3809
|
-
* @defaultValue <application UUID>
|
|
3810
|
-
*
|
|
3811
3808
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3812
3809
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3813
3810
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3814
3811
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3815
3812
|
* really no need to provide it.
|
|
3813
|
+
*
|
|
3814
|
+
* @default <application UUID>
|
|
3816
3815
|
*/
|
|
3817
3816
|
uuid: string;
|
|
3818
3817
|
/**
|
|
3819
|
-
* @defaultValue false
|
|
3820
|
-
*
|
|
3821
3818
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3822
3819
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3820
|
+
*
|
|
3821
|
+
* @default false
|
|
3823
3822
|
*/
|
|
3824
3823
|
waitForPageLoad: boolean;
|
|
3825
3824
|
width: number;
|
|
@@ -4101,13 +4100,13 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4101
4100
|
*/
|
|
4102
4101
|
declare type CopyPermissions = {
|
|
4103
4102
|
/**
|
|
4104
|
-
* @defaultValue 'allowed'
|
|
4105
|
-
*
|
|
4106
4103
|
* Controls the behavior for copy operations for a matched URL.
|
|
4107
4104
|
*
|
|
4108
4105
|
* allow: Enables all copy operations.
|
|
4109
4106
|
* block: Disables all copy operations.
|
|
4110
4107
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4108
|
+
*
|
|
4109
|
+
* @default 'allowed'
|
|
4111
4110
|
*/
|
|
4112
4111
|
behavior: 'allow' | 'block' | 'protect';
|
|
4113
4112
|
/**
|
|
@@ -4115,9 +4114,9 @@ declare type CopyPermissions = {
|
|
|
4115
4114
|
*/
|
|
4116
4115
|
options?: {
|
|
4117
4116
|
/**
|
|
4118
|
-
* @defaultValue ''
|
|
4119
|
-
*
|
|
4120
4117
|
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4118
|
+
*
|
|
4119
|
+
* @default ''
|
|
4121
4120
|
*/
|
|
4122
4121
|
replacementText: string;
|
|
4123
4122
|
};
|
|
@@ -4131,15 +4130,15 @@ declare type CopyPermissions = {
|
|
|
4131
4130
|
*/
|
|
4132
4131
|
declare type CornerRounding = {
|
|
4133
4132
|
/**
|
|
4134
|
-
* @defaultValue 0
|
|
4135
|
-
*
|
|
4136
4133
|
* The height in pixels.
|
|
4134
|
+
*
|
|
4135
|
+
* @default 0
|
|
4137
4136
|
*/
|
|
4138
4137
|
height: number;
|
|
4139
4138
|
/**
|
|
4140
|
-
* @defaultValue 0
|
|
4141
|
-
*
|
|
4142
4139
|
* The width in pixels.
|
|
4140
|
+
*
|
|
4141
|
+
* @default 0
|
|
4143
4142
|
*/
|
|
4144
4143
|
width: number;
|
|
4145
4144
|
};
|
|
@@ -4229,8 +4228,6 @@ declare type CreateLayoutOptions = {
|
|
|
4229
4228
|
layoutName: string;
|
|
4230
4229
|
layout: LayoutOptions;
|
|
4231
4230
|
/**
|
|
4232
|
-
* @defaultValue 'default'
|
|
4233
|
-
*
|
|
4234
4231
|
* Controls the View behavior for the given `layout` property. Note
|
|
4235
4232
|
* that the selected behavior only applies to unnamed Views or
|
|
4236
4233
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4252,6 +4249,8 @@ declare type CreateLayoutOptions = {
|
|
|
4252
4249
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4253
4250
|
* attached to the Provider while the Window is being created, so it's
|
|
4254
4251
|
* important to not 'duplicate' Views in this workflow.
|
|
4252
|
+
*
|
|
4253
|
+
* @default 'default'
|
|
4255
4254
|
*/
|
|
4256
4255
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4257
4256
|
};
|
|
@@ -4510,7 +4509,7 @@ declare type DomainApiSettings = {
|
|
|
4510
4509
|
* * 'none': The `fin` API will be not available.
|
|
4511
4510
|
* * 'global': The entire `fin` API will be available.
|
|
4512
4511
|
*
|
|
4513
|
-
* @
|
|
4512
|
+
* @default 'global'
|
|
4514
4513
|
*/
|
|
4515
4514
|
fin?: InjectionType;
|
|
4516
4515
|
/**
|
|
@@ -5095,9 +5094,9 @@ declare type EventType_9 = Event_12['type'];
|
|
|
5095
5094
|
*/
|
|
5096
5095
|
declare type ExcludeOptions = {
|
|
5097
5096
|
/**
|
|
5098
|
-
* @defaultValue false
|
|
5099
|
-
*
|
|
5100
5097
|
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5098
|
+
*
|
|
5099
|
+
* @default false
|
|
5101
5100
|
*/
|
|
5102
5101
|
preloadScripts: boolean;
|
|
5103
5102
|
};
|
|
@@ -5930,34 +5929,34 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
5930
5929
|
*/
|
|
5931
5930
|
declare type FindInPageOptions = {
|
|
5932
5931
|
/**
|
|
5933
|
-
* @defaultValue true
|
|
5934
|
-
*
|
|
5935
5932
|
* Searches in the forward direction (backward otherwise)
|
|
5933
|
+
*
|
|
5934
|
+
* @default true
|
|
5936
5935
|
*/
|
|
5937
5936
|
forward?: boolean;
|
|
5938
5937
|
/**
|
|
5939
|
-
* @defaultValue false
|
|
5940
|
-
*
|
|
5941
5938
|
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5939
|
+
*
|
|
5940
|
+
* @default false
|
|
5942
5941
|
*/
|
|
5943
5942
|
findNext?: boolean;
|
|
5944
5943
|
/**
|
|
5945
|
-
* @defaultValue false
|
|
5946
|
-
*
|
|
5947
5944
|
* Enables case-sensitive searching.
|
|
5945
|
+
*
|
|
5946
|
+
* @default false
|
|
5948
5947
|
*/
|
|
5949
5948
|
matchCase?: boolean;
|
|
5950
5949
|
/**
|
|
5951
|
-
* @defaultValue false
|
|
5952
|
-
*
|
|
5953
5950
|
* Only searches from the start of words.
|
|
5951
|
+
*
|
|
5952
|
+
* @default false
|
|
5954
5953
|
*/
|
|
5955
5954
|
wordStart?: boolean;
|
|
5956
5955
|
/**
|
|
5957
|
-
* @defaultValue false
|
|
5958
|
-
*
|
|
5959
5956
|
* 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>
|
|
5960
5957
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5958
|
+
*
|
|
5959
|
+
* @default false
|
|
5961
5960
|
*/
|
|
5962
5961
|
medialCapitalAsWordStart?: boolean;
|
|
5963
5962
|
};
|
|
@@ -6465,9 +6464,9 @@ declare type Hotkey = {
|
|
|
6465
6464
|
*/
|
|
6466
6465
|
keys: string;
|
|
6467
6466
|
/**
|
|
6468
|
-
* @defaultValue false
|
|
6469
|
-
*
|
|
6470
6467
|
* Prevent default key handling before emitting the event.
|
|
6468
|
+
*
|
|
6469
|
+
* @default false
|
|
6471
6470
|
*/
|
|
6472
6471
|
preventDefault?: boolean;
|
|
6473
6472
|
};
|
|
@@ -8824,77 +8823,79 @@ declare type LayoutOptions = {
|
|
|
8824
8823
|
*/
|
|
8825
8824
|
newTabButtonUrl?: string;
|
|
8826
8825
|
/**
|
|
8827
|
-
* @defaultValue false
|
|
8828
|
-
*
|
|
8829
8826
|
* When true the splitters will not be draggable and the layout will not resize.
|
|
8827
|
+
*
|
|
8828
|
+
* @default false
|
|
8830
8829
|
*/
|
|
8831
8830
|
preventSplitterResize?: boolean;
|
|
8832
8831
|
/**
|
|
8833
|
-
* @defaultValue false
|
|
8834
|
-
*
|
|
8835
8832
|
* Whether the popout button will only act on the entire stack,
|
|
8836
8833
|
* as opposed to only the active tab.
|
|
8834
|
+
*
|
|
8835
|
+
* @default false
|
|
8837
8836
|
*/
|
|
8838
8837
|
popoutWholeStack?: boolean;
|
|
8839
8838
|
/**
|
|
8840
|
-
* @defaultValue false
|
|
8841
|
-
*
|
|
8842
8839
|
* Limits the area to which tabs can be dragged.
|
|
8843
8840
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8841
|
+
*
|
|
8842
|
+
* @default false
|
|
8844
8843
|
*/
|
|
8845
8844
|
constrainDragToContainer?: boolean;
|
|
8846
8845
|
/**
|
|
8847
|
-
* @defaultValue false
|
|
8848
|
-
*
|
|
8849
8846
|
* Whether to show the popout button on stack header.
|
|
8850
8847
|
* The button will create a new window with current tab as its content.
|
|
8851
8848
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8849
|
+
*
|
|
8850
|
+
* @default false
|
|
8852
8851
|
*/
|
|
8853
8852
|
showPopoutIcon?: boolean;
|
|
8854
8853
|
/**
|
|
8855
|
-
* @defaultValue false
|
|
8856
|
-
*
|
|
8857
8854
|
* Whether to show the maximize button on stack header.
|
|
8858
8855
|
* The button will maximize the current tab to fill the entire window.
|
|
8856
|
+
*
|
|
8857
|
+
* @default false
|
|
8859
8858
|
*/
|
|
8860
8859
|
showMaximiseIcon?: boolean;
|
|
8861
8860
|
/**
|
|
8862
|
-
* @defaultValue false
|
|
8863
|
-
*
|
|
8864
8861
|
* Whether to show the close button on stack header
|
|
8865
8862
|
* (not to be confused with close button on every tab).
|
|
8863
|
+
*
|
|
8864
|
+
* @default false
|
|
8866
8865
|
*/
|
|
8867
8866
|
showCloseIcon?: boolean;
|
|
8868
8867
|
/**
|
|
8869
|
-
* @defaultValue false
|
|
8870
|
-
*
|
|
8871
8868
|
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8869
|
+
*
|
|
8870
|
+
* @default false
|
|
8872
8871
|
*/
|
|
8873
8872
|
constrainDragToHeaders?: boolean;
|
|
8874
8873
|
/**
|
|
8875
|
-
* @defaultValue true
|
|
8876
|
-
*
|
|
8877
8874
|
* Turns tab headers on or off.
|
|
8878
8875
|
* If false, the layout will be displayed with splitters only.
|
|
8876
|
+
*
|
|
8877
|
+
* @default true
|
|
8879
8878
|
*/
|
|
8880
8879
|
hasHeaders?: boolean;
|
|
8881
8880
|
/**
|
|
8882
|
-
* @defaultValue true
|
|
8883
|
-
*
|
|
8884
8881
|
* If true, the user can re-arrange the layout by
|
|
8885
8882
|
* dragging items by their tabs to the desired location.
|
|
8883
|
+
*
|
|
8884
|
+
* @default true
|
|
8886
8885
|
*/
|
|
8887
8886
|
reorderEnabled?: boolean;
|
|
8888
8887
|
/**
|
|
8889
|
-
* @defaultValue false
|
|
8890
|
-
*
|
|
8891
8888
|
* If true, tabs can't be dragged out of the window.
|
|
8889
|
+
*
|
|
8890
|
+
* @default false
|
|
8892
8891
|
*/
|
|
8893
8892
|
preventDragOut?: boolean;
|
|
8894
8893
|
/**
|
|
8895
|
-
* @defaultValue
|
|
8894
|
+
* @defaultValue=false
|
|
8896
8895
|
*
|
|
8897
8896
|
* If true, tabs can't be dragged into the window.
|
|
8897
|
+
*
|
|
8898
|
+
* @default false
|
|
8898
8899
|
*/
|
|
8899
8900
|
preventDragIn?: boolean;
|
|
8900
8901
|
/* Excluded from this release type: disableTabOverflowDropdown */
|
|
@@ -9402,10 +9403,10 @@ declare type MutableViewOptions = {
|
|
|
9402
9403
|
/**
|
|
9403
9404
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9404
9405
|
*
|
|
9405
|
-
* @defaultValue true
|
|
9406
|
-
*
|
|
9407
9406
|
* Show the context menu when right-clicking on the view.
|
|
9408
9407
|
* Gives access to the devtools for the view.
|
|
9408
|
+
*
|
|
9409
|
+
* @default true
|
|
9409
9410
|
*/
|
|
9410
9411
|
contextMenu: boolean;
|
|
9411
9412
|
/**
|
|
@@ -9452,24 +9453,25 @@ declare type MutableViewOptions = {
|
|
|
9452
9453
|
contentNavigation: ContentNavigation;
|
|
9453
9454
|
contentRedirect: ContentRedirect;
|
|
9454
9455
|
/**
|
|
9455
|
-
* @defaultValue false
|
|
9456
9456
|
* @deprecated
|
|
9457
9457
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9458
9458
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9459
|
+
*
|
|
9460
|
+
* @default false
|
|
9459
9461
|
*/
|
|
9460
9462
|
detachOnClose: boolean;
|
|
9461
9463
|
/**
|
|
9462
|
-
* @defaultValue true
|
|
9463
|
-
*
|
|
9464
9464
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9465
9465
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9466
9466
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9467
|
+
*
|
|
9468
|
+
* @default true
|
|
9467
9469
|
*/
|
|
9468
9470
|
isClosable: boolean;
|
|
9469
9471
|
/**
|
|
9470
|
-
* @defaultValue false
|
|
9471
|
-
*
|
|
9472
9472
|
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9473
|
+
*
|
|
9474
|
+
* @default false
|
|
9473
9475
|
*/
|
|
9474
9476
|
preventDragOut: boolean;
|
|
9475
9477
|
interop?: InteropConfig;
|
|
@@ -9477,7 +9479,7 @@ declare type MutableViewOptions = {
|
|
|
9477
9479
|
/**
|
|
9478
9480
|
* {@inheritDoc ViewThrottling}
|
|
9479
9481
|
*
|
|
9480
|
-
* @
|
|
9482
|
+
* @default 'enabled'
|
|
9481
9483
|
*/
|
|
9482
9484
|
throttling: ViewThrottling;
|
|
9483
9485
|
/**
|
|
@@ -9505,25 +9507,25 @@ declare type MutableWindowOptions = {
|
|
|
9505
9507
|
*/
|
|
9506
9508
|
alphaMask: RGB;
|
|
9507
9509
|
/**
|
|
9508
|
-
* @defaultValue false
|
|
9509
|
-
*
|
|
9510
9510
|
* Always position the window at the top of the window stack.
|
|
9511
|
+
*
|
|
9512
|
+
* @default false
|
|
9511
9513
|
*/
|
|
9512
9514
|
alwaysOnTop: boolean;
|
|
9513
9515
|
/**
|
|
9514
|
-
* @defaultValue 0
|
|
9515
|
-
*
|
|
9516
9516
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9517
9517
|
* an aspect ratio will not be enforced.
|
|
9518
|
+
*
|
|
9519
|
+
* @default 0
|
|
9518
9520
|
*/
|
|
9519
9521
|
aspectRatio: number;
|
|
9520
9522
|
/**
|
|
9521
9523
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9522
9524
|
*
|
|
9523
|
-
* @defaultValue true
|
|
9524
|
-
*
|
|
9525
9525
|
* Show the context menu when right-clicking on the window.
|
|
9526
9526
|
* Gives access to the devtools for the window.
|
|
9527
|
+
*
|
|
9528
|
+
* @default true
|
|
9527
9529
|
*/
|
|
9528
9530
|
contextMenu: boolean;
|
|
9529
9531
|
/**
|
|
@@ -9590,16 +9592,17 @@ declare type MutableWindowOptions = {
|
|
|
9590
9592
|
*/
|
|
9591
9593
|
customData: any;
|
|
9592
9594
|
/**
|
|
9593
|
-
* @defaultValue true
|
|
9594
9595
|
* @deprecated Will be removed in runtime version 45
|
|
9595
9596
|
*
|
|
9596
9597
|
* Show the window's frame.
|
|
9598
|
+
*
|
|
9599
|
+
* @default true
|
|
9597
9600
|
*/
|
|
9598
9601
|
frame: boolean;
|
|
9599
9602
|
/**
|
|
9600
|
-
* @defaultValue false
|
|
9601
|
-
*
|
|
9602
9603
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9604
|
+
*
|
|
9605
|
+
* @default false
|
|
9603
9606
|
*/
|
|
9604
9607
|
hideOnClose: boolean;
|
|
9605
9608
|
/**
|
|
@@ -9652,60 +9655,60 @@ declare type MutableWindowOptions = {
|
|
|
9652
9655
|
*/
|
|
9653
9656
|
icon: string;
|
|
9654
9657
|
/**
|
|
9655
|
-
* @defaultValue true
|
|
9656
|
-
*
|
|
9657
9658
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9658
9659
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9660
|
+
*
|
|
9661
|
+
* @default true
|
|
9659
9662
|
*/
|
|
9660
9663
|
includeInSnapshots: boolean;
|
|
9661
9664
|
/**
|
|
9662
|
-
* @defaultValue -1
|
|
9663
|
-
*
|
|
9664
9665
|
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9666
|
+
*
|
|
9667
|
+
* @default -1
|
|
9665
9668
|
*/
|
|
9666
9669
|
maxHeight: number;
|
|
9667
9670
|
/**
|
|
9668
|
-
* @defaultValue true
|
|
9669
|
-
*
|
|
9670
9671
|
* Allows the window to be maximized.
|
|
9672
|
+
*
|
|
9673
|
+
* @default true
|
|
9671
9674
|
*/
|
|
9672
9675
|
maximizable: boolean;
|
|
9673
9676
|
/**
|
|
9674
|
-
* @defaultValue -1
|
|
9675
|
-
*
|
|
9676
9677
|
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9678
|
+
*
|
|
9679
|
+
* @default -1
|
|
9677
9680
|
*/
|
|
9678
9681
|
maxWidth: number;
|
|
9679
9682
|
/**
|
|
9680
|
-
* @defaultValue 0
|
|
9681
|
-
*
|
|
9682
9683
|
* The minimum height of the window.
|
|
9684
|
+
*
|
|
9685
|
+
* @default 0
|
|
9683
9686
|
*/
|
|
9684
9687
|
minHeight: number;
|
|
9685
9688
|
/**
|
|
9686
|
-
* @defaultValue true
|
|
9687
|
-
*
|
|
9688
9689
|
* Allows the window to be minimized.
|
|
9690
|
+
*
|
|
9691
|
+
* @default true
|
|
9689
9692
|
*/
|
|
9690
9693
|
minimizable: boolean;
|
|
9691
9694
|
/**
|
|
9692
|
-
* @defaultValue true
|
|
9693
|
-
*
|
|
9694
9695
|
* The minimum width of the window.
|
|
9696
|
+
*
|
|
9697
|
+
* @default true
|
|
9695
9698
|
*/
|
|
9696
9699
|
minWidth: number;
|
|
9697
9700
|
/**
|
|
9698
|
-
* @defaultValue 1
|
|
9699
|
-
*
|
|
9700
9701
|
* A flag that specifies how transparent the window will be.
|
|
9701
9702
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9702
9703
|
* This value is clamped between `0.0` and `1.0`.
|
|
9704
|
+
*
|
|
9705
|
+
* @default 1
|
|
9703
9706
|
*/
|
|
9704
9707
|
opacity: number;
|
|
9705
9708
|
/**
|
|
9706
|
-
* @defaultValue true
|
|
9707
|
-
*
|
|
9708
9709
|
* A flag to allow the user to resize the window.
|
|
9710
|
+
*
|
|
9711
|
+
* @default true
|
|
9709
9712
|
*/
|
|
9710
9713
|
resizable: boolean;
|
|
9711
9714
|
/**
|
|
@@ -9713,16 +9716,16 @@ declare type MutableWindowOptions = {
|
|
|
9713
9716
|
*/
|
|
9714
9717
|
resizeRegion: ResizeRegion;
|
|
9715
9718
|
/**
|
|
9716
|
-
* @defaultValue false
|
|
9717
|
-
*
|
|
9718
9719
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9719
9720
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9721
|
+
*
|
|
9722
|
+
* @default false
|
|
9720
9723
|
*/
|
|
9721
9724
|
showBackgroundImages: boolean;
|
|
9722
9725
|
/**
|
|
9723
|
-
* @defaultValue true
|
|
9724
|
-
*
|
|
9725
9726
|
* Shows the window's icon in the taskbar.
|
|
9727
|
+
*
|
|
9728
|
+
* @default true
|
|
9726
9729
|
*/
|
|
9727
9730
|
showTaskbarIcon: boolean;
|
|
9728
9731
|
/**
|
|
@@ -9741,7 +9744,7 @@ declare type MutableWindowOptions = {
|
|
|
9741
9744
|
/**
|
|
9742
9745
|
* {@inheritDoc WindowThrottling}
|
|
9743
9746
|
*
|
|
9744
|
-
* @
|
|
9747
|
+
* @default 'enabled'
|
|
9745
9748
|
*
|
|
9746
9749
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9747
9750
|
*/
|
|
@@ -10385,12 +10388,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10385
10388
|
*/
|
|
10386
10389
|
declare type PastePermissions = {
|
|
10387
10390
|
/**
|
|
10388
|
-
* @defaultValue 'non-protected-content'
|
|
10389
|
-
*
|
|
10390
10391
|
* Controls the behavior for paste operations for a matched URL.
|
|
10391
10392
|
*
|
|
10392
10393
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10393
10394
|
* 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.
|
|
10395
|
+
*
|
|
10396
|
+
* @default 'non-protected-content'
|
|
10394
10397
|
*/
|
|
10395
10398
|
behavior: 'non-protected-content' | 'all-content';
|
|
10396
10399
|
};
|
|
@@ -11422,11 +11425,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11422
11425
|
*/
|
|
11423
11426
|
providerUrl?: string;
|
|
11424
11427
|
/**
|
|
11425
|
-
* @defaultValue true
|
|
11426
|
-
*
|
|
11427
11428
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11428
11429
|
*
|
|
11429
11430
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11431
|
+
*
|
|
11432
|
+
* @default true
|
|
11430
11433
|
*/
|
|
11431
11434
|
allowLaunchIntoPlatform?: boolean;
|
|
11432
11435
|
};
|
|
@@ -12074,22 +12077,22 @@ declare type PopupOptions = {
|
|
|
12074
12077
|
url?: string;
|
|
12075
12078
|
/**
|
|
12076
12079
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12077
|
-
* @
|
|
12080
|
+
* @default 300
|
|
12078
12081
|
*/
|
|
12079
12082
|
height?: number;
|
|
12080
12083
|
/**
|
|
12081
12084
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12082
|
-
* @
|
|
12085
|
+
* @default 300
|
|
12083
12086
|
*/
|
|
12084
12087
|
width?: number;
|
|
12085
12088
|
/**
|
|
12086
12089
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12087
|
-
* @
|
|
12090
|
+
* @default 0
|
|
12088
12091
|
*/
|
|
12089
12092
|
x?: number;
|
|
12090
12093
|
/**
|
|
12091
12094
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12092
|
-
* @
|
|
12095
|
+
* @default 0
|
|
12093
12096
|
*/
|
|
12094
12097
|
y?: number;
|
|
12095
12098
|
/**
|
|
@@ -12097,7 +12100,7 @@ declare type PopupOptions = {
|
|
|
12097
12100
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12098
12101
|
* * 'hide' hides the popup window on blur.
|
|
12099
12102
|
* * 'close' closes the popup window on blur.
|
|
12100
|
-
* @
|
|
12103
|
+
* @default 'close'
|
|
12101
12104
|
*/
|
|
12102
12105
|
blurBehavior?: PopupBlurBehavior;
|
|
12103
12106
|
/**
|
|
@@ -12105,19 +12108,19 @@ declare type PopupOptions = {
|
|
|
12105
12108
|
* * 'none' will do nothing.
|
|
12106
12109
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12107
12110
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12108
|
-
* @
|
|
12111
|
+
* @default 'close'
|
|
12109
12112
|
*/
|
|
12110
12113
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12111
12114
|
/**
|
|
12112
12115
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12113
12116
|
*
|
|
12114
12117
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12115
|
-
* @
|
|
12118
|
+
* @default false
|
|
12116
12119
|
*/
|
|
12117
12120
|
hideOnClose?: boolean;
|
|
12118
12121
|
/**
|
|
12119
12122
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12120
|
-
* @
|
|
12123
|
+
* @default true
|
|
12121
12124
|
*/
|
|
12122
12125
|
focus?: boolean;
|
|
12123
12126
|
/**
|
|
@@ -12211,9 +12214,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12211
12214
|
*/
|
|
12212
12215
|
declare type PreloadScript = {
|
|
12213
12216
|
/**
|
|
12214
|
-
* @defaultValue false
|
|
12215
|
-
*
|
|
12216
12217
|
* Fail to load the window if this preload script fails
|
|
12218
|
+
*
|
|
12219
|
+
* @default false
|
|
12217
12220
|
*/
|
|
12218
12221
|
mandatory?: boolean;
|
|
12219
12222
|
/**
|
|
@@ -12305,15 +12308,15 @@ declare type PrinterInfo = {
|
|
|
12305
12308
|
declare type PrintOptions = {
|
|
12306
12309
|
content?: 'self';
|
|
12307
12310
|
/**
|
|
12308
|
-
* @defaultValue false
|
|
12309
|
-
*
|
|
12310
12311
|
* Disables prompting the user for print settings.
|
|
12312
|
+
*
|
|
12313
|
+
* @default false
|
|
12311
12314
|
*/
|
|
12312
12315
|
silent?: boolean;
|
|
12313
12316
|
/**
|
|
12314
|
-
* @defaultValue false
|
|
12315
|
-
*
|
|
12316
12317
|
* Includes the webpage background color and image when printing.
|
|
12318
|
+
*
|
|
12319
|
+
* @default false
|
|
12317
12320
|
*/
|
|
12318
12321
|
printBackground?: boolean;
|
|
12319
12322
|
/**
|
|
@@ -12321,9 +12324,9 @@ declare type PrintOptions = {
|
|
|
12321
12324
|
*/
|
|
12322
12325
|
deviceName?: string;
|
|
12323
12326
|
/**
|
|
12324
|
-
* @defaultValue true
|
|
12325
|
-
*
|
|
12326
12327
|
* Prints in full color (greyscale otherwise).
|
|
12328
|
+
*
|
|
12329
|
+
* @default true
|
|
12327
12330
|
*/
|
|
12328
12331
|
color?: boolean;
|
|
12329
12332
|
/**
|
|
@@ -12331,9 +12334,9 @@ declare type PrintOptions = {
|
|
|
12331
12334
|
*/
|
|
12332
12335
|
margins?: Margins;
|
|
12333
12336
|
/**
|
|
12334
|
-
* @defaultValue true
|
|
12335
|
-
*
|
|
12336
12337
|
* Prints in landscape mode (portrait otherwise).
|
|
12338
|
+
*
|
|
12339
|
+
* @default true
|
|
12337
12340
|
*/
|
|
12338
12341
|
landscape?: boolean;
|
|
12339
12342
|
/**
|
|
@@ -13709,15 +13712,15 @@ declare type ReplaceViewPayload = {
|
|
|
13709
13712
|
*/
|
|
13710
13713
|
declare type ResizeRegion = {
|
|
13711
13714
|
/**
|
|
13712
|
-
* @defaultValue 7
|
|
13713
|
-
*
|
|
13714
13715
|
* The size of the resize region in pixels.
|
|
13716
|
+
*
|
|
13717
|
+
* @default 7
|
|
13715
13718
|
*/
|
|
13716
13719
|
size?: number;
|
|
13717
13720
|
/**
|
|
13718
|
-
* @defaultValue 9
|
|
13719
|
-
*
|
|
13720
13721
|
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13722
|
+
*
|
|
13723
|
+
* @default 9
|
|
13721
13724
|
*/
|
|
13722
13725
|
bottomRightCorner?: number;
|
|
13723
13726
|
/**
|
|
@@ -13725,27 +13728,27 @@ declare type ResizeRegion = {
|
|
|
13725
13728
|
*/
|
|
13726
13729
|
sides?: {
|
|
13727
13730
|
/**
|
|
13728
|
-
* @defaultValue true
|
|
13729
|
-
*
|
|
13730
13731
|
* Enables resizing from the top of the window.
|
|
13732
|
+
*
|
|
13733
|
+
* @default true
|
|
13731
13734
|
*/
|
|
13732
13735
|
top?: boolean;
|
|
13733
13736
|
/**
|
|
13734
|
-
* @defaultValue true
|
|
13735
|
-
*
|
|
13736
13737
|
* Enables resizing from the bottom of the window.
|
|
13738
|
+
*
|
|
13739
|
+
* @default true
|
|
13737
13740
|
*/
|
|
13738
13741
|
bottom?: boolean;
|
|
13739
13742
|
/**
|
|
13740
|
-
* @defaultValue true
|
|
13741
|
-
*
|
|
13742
13743
|
* Enables resizing from the left side of the window.
|
|
13744
|
+
*
|
|
13745
|
+
* @default true
|
|
13743
13746
|
*/
|
|
13744
13747
|
left?: boolean;
|
|
13745
13748
|
/**
|
|
13746
|
-
* @defaultValue true
|
|
13747
|
-
*
|
|
13748
13749
|
* Enables resizing from the right side of the window.
|
|
13750
|
+
*
|
|
13751
|
+
* @default true
|
|
13749
13752
|
*/
|
|
13750
13753
|
right?: boolean;
|
|
13751
13754
|
};
|
|
@@ -14299,9 +14302,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14299
14302
|
*/
|
|
14300
14303
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14301
14304
|
/**
|
|
14302
|
-
* @defaultValue 0
|
|
14303
|
-
*
|
|
14304
14305
|
* Number of milliseconds to wait between view repaints.
|
|
14306
|
+
*
|
|
14307
|
+
* @default 0
|
|
14305
14308
|
*/
|
|
14306
14309
|
paintIntervalMs?: number;
|
|
14307
14310
|
};
|
|
@@ -15988,6 +15991,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
15988
15991
|
serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
|
|
15989
15992
|
/**
|
|
15990
15993
|
* Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
|
|
15994
|
+
* @experimental
|
|
15991
15995
|
*/
|
|
15992
15996
|
launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
|
|
15993
15997
|
}
|
|
@@ -16352,9 +16356,9 @@ declare type TransitionBase = {
|
|
|
16352
16356
|
*/
|
|
16353
16357
|
duration: number;
|
|
16354
16358
|
/**
|
|
16355
|
-
* @defaultValue false
|
|
16356
|
-
*
|
|
16357
16359
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16360
|
+
*
|
|
16361
|
+
* @default false
|
|
16358
16362
|
*/
|
|
16359
16363
|
relative?: boolean;
|
|
16360
16364
|
};
|
|
@@ -16370,9 +16374,9 @@ declare type TransitionOptions = {
|
|
|
16370
16374
|
*/
|
|
16371
16375
|
interrupt: boolean;
|
|
16372
16376
|
/**
|
|
16373
|
-
* @defaultValue false
|
|
16374
|
-
*
|
|
16375
16377
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16378
|
+
*
|
|
16379
|
+
* @default false
|
|
16376
16380
|
*/
|
|
16377
16381
|
relative?: boolean;
|
|
16378
16382
|
tween?: tween;
|
|
@@ -17406,9 +17410,9 @@ declare type ViewTitlePriority = 'document' | 'options';
|
|
|
17406
17410
|
*/
|
|
17407
17411
|
declare type ViewVisibilityOption = {
|
|
17408
17412
|
/**
|
|
17409
|
-
* @defaultValue false
|
|
17410
|
-
*
|
|
17411
17413
|
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17414
|
+
*
|
|
17415
|
+
* @default false
|
|
17412
17416
|
*/
|
|
17413
17417
|
enabled?: boolean;
|
|
17414
17418
|
};
|