@openfin/core 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.
@@ -139,13 +139,13 @@ declare type ApiSettings = {
139
139
  /**
140
140
  * Inject OpenFin API into cross-origin iframes
141
141
  *
142
- * @defaultValue false
142
+ * @default false
143
143
  */
144
144
  crossOriginInjection?: boolean;
145
145
  /**
146
146
  * Inject OpenFin API into same-origin iframes
147
147
  *
148
- * @defaultValue true
148
+ * @default true
149
149
  */
150
150
  sameOriginInjection?: boolean;
151
151
  /**
@@ -1184,19 +1184,19 @@ declare class ApplicationModule extends Base {
1184
1184
  */
1185
1185
  declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1186
1186
  /**
1187
- * @defaultValue false
1188
- *
1189
1187
  * Disables IAB secure logging for the app.
1188
+ *
1189
+ * @default false
1190
1190
  */
1191
1191
  disableIabSecureLogging: boolean;
1192
1192
  /**
1193
- * @defaultValue 'There was an error loading the application.'
1194
- *
1195
1193
  * An error message to display when the application (launched via manifest) fails to load.
1196
1194
  * A dialog box will be launched with the error message just before the runtime exits.
1197
1195
  * Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
1198
1196
  * will trigger this dialog.
1199
1197
  * Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
1198
+ *
1199
+ * @default 'There was an error loading the application.'
1200
1200
  */
1201
1201
  loadErrorMessage: string;
1202
1202
  /**
@@ -1215,28 +1215,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1215
1215
  */
1216
1216
  name: string;
1217
1217
  /**
1218
- * @defaultValue false
1219
- *
1220
1218
  * A flag to configure the application as non-persistent.
1221
1219
  * Runtime exits when there are no persistent apps running.
1220
+ *
1221
+ * @default false
1222
1222
  */
1223
1223
  nonPersistent: boolean;
1224
1224
  /**
1225
- * @defaultValue false
1226
- *
1227
1225
  * Enable Flash at the application level.
1226
+ *
1227
+ * @default false
1228
1228
  */
1229
1229
  plugins: boolean;
1230
1230
  /**
1231
- * @defaultValue false
1232
- *
1233
1231
  * Enable spell check at the application level.
1232
+ *
1233
+ * @default false
1234
1234
  */
1235
1235
  spellCheck: boolean;
1236
1236
  /**
1237
- * @defaultValue 'about:blank'
1238
- *
1239
1237
  * The url to the application (specifically the application's main window).
1238
+ *
1239
+ * @default 'about:blank'
1240
1240
  */
1241
1241
  url: string;
1242
1242
  /**
@@ -1245,9 +1245,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1245
1245
  */
1246
1246
  uuid: string;
1247
1247
  /**
1248
- * @defaultValue true
1249
- *
1250
1248
  * When set to `false` it will disable the same-origin policy for the app.
1249
+ *
1250
+ * @default true
1251
1251
  */
1252
1252
  webSecurity: boolean;
1253
1253
  /**
@@ -1257,10 +1257,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1257
1257
  commands: ShortcutOverride[];
1258
1258
  isPlatformController: boolean;
1259
1259
  /**
1260
- * @defaultValue 1000
1261
- *
1262
1260
  * **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
1263
1261
  * If you do not wish for views to be pooled on your platform, set this property to zero.
1262
+ *
1263
+ * @default 1000
1264
1264
  */
1265
1265
  maxViewPoolSize: number;
1266
1266
  /**
@@ -1276,12 +1276,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1276
1276
  */
1277
1277
  snapshot: Snapshot;
1278
1278
  /**
1279
- * @defaultValue false
1280
- *
1281
1279
  * **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
1282
1280
  *
1283
1281
  * Note: if the Platform Provider is showing, it won't close automatically.
1284
1282
  * If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
1283
+ *
1284
+ * @default false
1285
1285
  */
1286
1286
  preventQuitOnLastWindowClosed: boolean;
1287
1287
  /**
@@ -1289,9 +1289,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1289
1289
  */
1290
1290
  interopBrokerConfiguration: InteropBrokerOptions;
1291
1291
  /**
1292
- * @defaultValue true
1293
- *
1294
1292
  * When set to `false` it will disable OpenFin Diagnostics for the app.
1293
+ *
1294
+ * @default true
1295
1295
  */
1296
1296
  apiDiagnostics: boolean;
1297
1297
  /**
@@ -1307,16 +1307,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1307
1307
  */
1308
1308
  permissions?: Partial<Permissions_2>;
1309
1309
  /**
1310
- * @defaultValue false
1311
- *
1312
1310
  * Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
1313
1311
  * Only relevant in Windows.
1312
+ *
1313
+ * @default false
1314
1314
  */
1315
1315
  enableJumpList: boolean;
1316
1316
  /**
1317
- * @defaultValue false
1318
- *
1319
1317
  * When set to `true`, any `beforeunload` handler set on the app will fire.
1318
+ *
1319
+ * @default false
1320
1320
  */
1321
1321
  enableBeforeUnload: boolean;
1322
1322
  /**
@@ -1397,25 +1397,25 @@ declare type ApplicationWindowInfo = {
1397
1397
  */
1398
1398
  declare type ApplySnapshotOptions = {
1399
1399
  /**
1400
- * @defaultValue false
1401
- *
1402
1400
  * When true, applySnapshot will close existing windows,
1403
1401
  * replacing current Platform state with the given snapshot.
1402
+ *
1403
+ * @default false
1404
1404
  */
1405
1405
  closeExistingWindows?: boolean;
1406
1406
  /**
1407
- * @defaultValue false
1408
- *
1409
1407
  * When true, applySnapshot will close existing includeInSnapshots: true windows,
1410
1408
  * replacing current Platform state with the given snapshot.
1409
+ *
1410
+ * @default false
1411
1411
  */
1412
1412
  closeSnapshotWindows?: boolean;
1413
1413
  /**
1414
- * @defaultValue false
1415
- *
1416
1414
  * When true, applySnapshot will not check whether any windows in a
1417
1415
  * snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
1418
1416
  * as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
1417
+ *
1418
+ * @default false
1419
1419
  */
1420
1420
  skipOutOfBoundsCheck?: boolean;
1421
1421
  };
@@ -2072,15 +2072,15 @@ declare type CapturePageOptions = {
2072
2072
  */
2073
2073
  area?: Rectangle;
2074
2074
  /**
2075
- * @defaultValue 'png'
2076
- *
2077
2075
  * The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
2076
+ *
2077
+ * @default 'png'
2078
2078
  */
2079
2079
  format?: 'bmp' | 'jpg' | 'png';
2080
2080
  /**
2081
- * @defaultValue 100
2082
- *
2083
2081
  * Quality of JPEG image. Between 0 - 100.
2082
+ *
2083
+ * @default 100
2084
2084
  */
2085
2085
  quality?: number;
2086
2086
  };
@@ -2713,9 +2713,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
2713
2713
  */
2714
2714
  declare type ChannelConnectOptions = ChannelCreateOptions & {
2715
2715
  /**
2716
- * @defaultValue true
2717
- *
2718
2716
  * If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
2717
+ *
2718
+ * @default true
2719
2719
  */
2720
2720
  wait?: boolean;
2721
2721
  /**
@@ -3374,9 +3374,9 @@ declare interface CloseWindowPayload {
3374
3374
  windowId: Identity_4;
3375
3375
  options: {
3376
3376
  /**
3377
- * @defaultValue false
3378
- *
3379
3377
  * When set to true skips any before handler set on views that are part of the window
3378
+ *
3379
+ * @default false
3380
3380
  */
3381
3381
  skipBeforeUnload?: boolean;
3382
3382
  };
@@ -3481,9 +3481,9 @@ declare type ConstViewOptions = {
3481
3481
  */
3482
3482
  name: string;
3483
3483
  /**
3484
- * @defaultValue "about:blank"
3485
- *
3486
3484
  * The URL of the window
3485
+ *
3486
+ * @default "about:blank"
3487
3487
  */
3488
3488
  url: string;
3489
3489
  /**
@@ -3544,9 +3544,9 @@ declare type ConstViewOptions = {
3544
3544
  experimental: any;
3545
3545
  fdc3InteropApi?: string;
3546
3546
  /**
3547
- * @defaultValue false
3548
- *
3549
3547
  * When set to `true`, any `beforeunload` handler set on Views will fire.
3548
+ *
3549
+ * @default false
3550
3550
  */
3551
3551
  enableBeforeUnload: boolean;
3552
3552
  /**
@@ -3627,13 +3627,12 @@ declare type ConstWindowOptions = {
3627
3627
  */
3628
3628
  backgroundColor: string;
3629
3629
  /**
3630
- * @defaultValue false
3631
- *
3632
3630
  * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
3633
3631
  * This also affects the Page Visibility API.
3634
3632
  *
3635
3633
  * When `true`, the page is throttled whether it is hidden or not.
3636
3634
  *
3635
+ * @default false
3637
3636
  */
3638
3637
  backgroundThrottling: boolean;
3639
3638
  /**
@@ -3657,21 +3656,21 @@ declare type ConstWindowOptions = {
3657
3656
  */
3658
3657
  customRequestHeaders: CustomRequestHeaders[];
3659
3658
  /**
3660
- * @defaultValue true
3661
- *
3662
3659
  * Setting this to false would keep the Window alive even if all its Views were closed.
3663
3660
  * This is meant for advanced users and should be used with caution.
3664
3661
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3665
3662
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
3666
3663
  * **NOTE:** - This option is ignored in non-Platforms apps.
3664
+ *
3665
+ * @default true
3667
3666
  */
3668
3667
  closeOnLastViewRemoved: boolean;
3669
3668
  /**
3670
- * @defaultValue 'all'
3671
- *
3672
3669
  * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3673
- + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3670
+ * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3674
3671
  * **NOTE:** - This option is ignored in non-Platforms apps.
3672
+ *
3673
+ * @default 'all'
3675
3674
  */
3676
3675
  viewsPreventingClose: 'all' | 'layout';
3677
3676
  /**
@@ -3682,31 +3681,31 @@ declare type ConstWindowOptions = {
3682
3681
  */
3683
3682
  defaultCentered: boolean;
3684
3683
  /**
3685
- * @defaultValue 500
3686
- *
3687
3684
  * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
3688
3685
  * in favor of the cached value.
3686
+ *
3687
+ * @default 500
3689
3688
  */
3690
3689
  defaultHeight: number;
3691
3690
  /**
3692
- * @defaultValue 100
3693
- *
3694
3691
  * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3695
3692
  * launches in favor of the cached value.
3693
+ *
3694
+ * @default 100
3696
3695
  */
3697
3696
  defaultLeft: number;
3698
3697
  /**
3699
- * @defaultValue 100
3700
- *
3701
3698
  * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3702
3699
  * launches in favor of the cached value.
3700
+ *
3701
+ * @default 100
3703
3702
  */
3704
3703
  defaultTop: number;
3705
3704
  /**
3706
- * @defaultValue 800
3707
- *
3708
3705
  * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
3709
3706
  * launches in favor of the cached value.
3707
+ *
3708
+ * @default 800
3710
3709
  */
3711
3710
  defaultWidth: number;
3712
3711
  /**
@@ -3752,19 +3751,19 @@ declare type ConstWindowOptions = {
3752
3751
  */
3753
3752
  processAffinity: string;
3754
3753
  /**
3755
- * @defaultValue false
3756
- *
3757
3754
  * Displays a shadow on frameless windows.
3758
3755
  * `shadow` and `cornerRounding` are mutually exclusive.
3759
3756
  * On Windows 7, Aero theme is required.
3757
+ *
3758
+ * @default false
3760
3759
  */
3761
3760
  shadow: boolean;
3762
3761
  /**
3763
- * @defaultValue true
3764
- *
3765
3762
  * Caches the location of the window.
3766
3763
  *
3767
3764
  * Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
3765
+ *
3766
+ * @default true
3768
3767
  */
3769
3768
  saveWindowState: boolean;
3770
3769
  /**
@@ -3773,22 +3772,22 @@ declare type ConstWindowOptions = {
3773
3772
  */
3774
3773
  ignoreSavedWindowState: boolean;
3775
3774
  /**
3776
- * @defaultValue false
3777
- *
3778
3775
  * Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
3779
3776
  *
3780
3777
  * Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
3781
3778
  * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
3779
+ *
3780
+ * @default false
3782
3781
  */
3783
3782
  smallWindow: boolean;
3784
3783
  /**
3785
- * @defaultValue "normal"
3786
- *
3787
3784
  * The visible state of the window on creation.
3788
3785
  * One of:
3789
3786
  * * `"maximized"`
3790
3787
  * * `"minimized"`
3791
3788
  * * `"normal"`
3789
+ *
3790
+ * @default "normal"
3792
3791
  */
3793
3792
  state: WindowState;
3794
3793
  /**
@@ -3803,26 +3802,26 @@ declare type ConstWindowOptions = {
3803
3802
  */
3804
3803
  taskbarIconGroup: string;
3805
3804
  /**
3806
- * @defaultValue "about:blank"
3807
- *
3808
3805
  * The URL of the window
3806
+ *
3807
+ * @default "about:blank"
3809
3808
  */
3810
3809
  url: string;
3811
3810
  /**
3812
- * @defaultValue <application UUID>
3813
- *
3814
3811
  * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
3815
3812
  * If omitted, defaults to the `uuid` of the application spawning the window.
3816
3813
  * If given, must match the `uuid` of the application spawning the window.
3817
3814
  * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
3818
3815
  * really no need to provide it.
3816
+ *
3817
+ * @default <application UUID>
3819
3818
  */
3820
3819
  uuid: string;
3821
3820
  /**
3822
- * @defaultValue false
3823
- *
3824
3821
  * When set to `true`, the window will not appear until the `window` object's `load` event fires.
3825
3822
  * When set to `false`, the window will appear immediately without waiting for content to be loaded.
3823
+ *
3824
+ * @default false
3826
3825
  */
3827
3826
  waitForPageLoad: boolean;
3828
3827
  width: number;
@@ -4104,13 +4103,13 @@ declare type CopyBlockedEventReason = 'disabled';
4104
4103
  */
4105
4104
  declare type CopyPermissions = {
4106
4105
  /**
4107
- * @defaultValue 'allowed'
4108
- *
4109
4106
  * Controls the behavior for copy operations for a matched URL.
4110
4107
  *
4111
4108
  * allow: Enables all copy operations.
4112
4109
  * block: Disables all copy operations.
4113
4110
  * protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
4111
+ *
4112
+ * @default 'allowed'
4114
4113
  */
4115
4114
  behavior: 'allow' | 'block' | 'protect';
4116
4115
  /**
@@ -4118,9 +4117,9 @@ declare type CopyPermissions = {
4118
4117
  */
4119
4118
  options?: {
4120
4119
  /**
4121
- * @defaultValue ''
4122
- *
4123
4120
  * When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
4121
+ *
4122
+ * @default ''
4124
4123
  */
4125
4124
  replacementText: string;
4126
4125
  };
@@ -4134,15 +4133,15 @@ declare type CopyPermissions = {
4134
4133
  */
4135
4134
  declare type CornerRounding = {
4136
4135
  /**
4137
- * @defaultValue 0
4138
- *
4139
4136
  * The height in pixels.
4137
+ *
4138
+ * @default 0
4140
4139
  */
4141
4140
  height: number;
4142
4141
  /**
4143
- * @defaultValue 0
4144
- *
4145
4142
  * The width in pixels.
4143
+ *
4144
+ * @default 0
4146
4145
  */
4147
4146
  width: number;
4148
4147
  };
@@ -4232,8 +4231,6 @@ declare type CreateLayoutOptions = {
4232
4231
  layoutName: string;
4233
4232
  layout: LayoutOptions;
4234
4233
  /**
4235
- * @defaultValue 'default'
4236
- *
4237
4234
  * Controls the View behavior for the given `layout` property. Note
4238
4235
  * that the selected behavior only applies to unnamed Views or
4239
4236
  * Views with the prefix `internal-generated-`. In all cases, if any
@@ -4255,6 +4252,8 @@ declare type CreateLayoutOptions = {
4255
4252
  * override. Note that during applyLayoutSnapshot, Views are created and
4256
4253
  * attached to the Provider while the Window is being created, so it's
4257
4254
  * important to not 'duplicate' Views in this workflow.
4255
+ *
4256
+ * @default 'default'
4258
4257
  */
4259
4258
  multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4260
4259
  };
@@ -4513,7 +4512,7 @@ declare type DomainApiSettings = {
4513
4512
  * * 'none': The `fin` API will be not available.
4514
4513
  * * 'global': The entire `fin` API will be available.
4515
4514
  *
4516
- * @defaultValue 'global'
4515
+ * @default 'global'
4517
4516
  */
4518
4517
  fin?: InjectionType;
4519
4518
  /**
@@ -5098,9 +5097,9 @@ declare type EventType_9 = Event_12['type'];
5098
5097
  */
5099
5098
  declare type ExcludeOptions = {
5100
5099
  /**
5101
- * @defaultValue false
5102
- *
5103
5100
  * When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
5101
+ *
5102
+ * @default false
5104
5103
  */
5105
5104
  preloadScripts: boolean;
5106
5105
  };
@@ -5588,34 +5587,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5588
5587
  */
5589
5588
  declare type FindInPageOptions = {
5590
5589
  /**
5591
- * @defaultValue true
5592
- *
5593
5590
  * Searches in the forward direction (backward otherwise)
5591
+ *
5592
+ * @default true
5594
5593
  */
5595
5594
  forward?: boolean;
5596
5595
  /**
5597
- * @defaultValue false
5598
- *
5599
5596
  * Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
5597
+ *
5598
+ * @default false
5600
5599
  */
5601
5600
  findNext?: boolean;
5602
5601
  /**
5603
- * @defaultValue false
5604
- *
5605
5602
  * Enables case-sensitive searching.
5603
+ *
5604
+ * @default false
5606
5605
  */
5607
5606
  matchCase?: boolean;
5608
5607
  /**
5609
- * @defaultValue false
5610
- *
5611
5608
  * Only searches from the start of words.
5609
+ *
5610
+ * @default false
5612
5611
  */
5613
5612
  wordStart?: boolean;
5614
5613
  /**
5615
- * @defaultValue false
5616
- *
5617
5614
  * 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>
5618
5615
  * lowercase or non-letter. Accepts several other intra-word matches.
5616
+ *
5617
+ * @default false
5619
5618
  */
5620
5619
  medialCapitalAsWordStart?: boolean;
5621
5620
  };
@@ -6123,9 +6122,9 @@ declare type Hotkey = {
6123
6122
  */
6124
6123
  keys: string;
6125
6124
  /**
6126
- * @defaultValue false
6127
- *
6128
6125
  * Prevent default key handling before emitting the event.
6126
+ *
6127
+ * @default false
6129
6128
  */
6130
6129
  preventDefault?: boolean;
6131
6130
  };
@@ -8482,77 +8481,79 @@ declare type LayoutOptions = {
8482
8481
  */
8483
8482
  newTabButtonUrl?: string;
8484
8483
  /**
8485
- * @defaultValue false
8486
- *
8487
8484
  * When true the splitters will not be draggable and the layout will not resize.
8485
+ *
8486
+ * @default false
8488
8487
  */
8489
8488
  preventSplitterResize?: boolean;
8490
8489
  /**
8491
- * @defaultValue false
8492
- *
8493
8490
  * Whether the popout button will only act on the entire stack,
8494
8491
  * as opposed to only the active tab.
8492
+ *
8493
+ * @default false
8495
8494
  */
8496
8495
  popoutWholeStack?: boolean;
8497
8496
  /**
8498
- * @defaultValue false
8499
- *
8500
8497
  * Limits the area to which tabs can be dragged.
8501
8498
  * If true, the layout container is the only area where tabs can be dropped.
8499
+ *
8500
+ * @default false
8502
8501
  */
8503
8502
  constrainDragToContainer?: boolean;
8504
8503
  /**
8505
- * @defaultValue false
8506
- *
8507
8504
  * Whether to show the popout button on stack header.
8508
8505
  * The button will create a new window with current tab as its content.
8509
8506
  * In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
8507
+ *
8508
+ * @default false
8510
8509
  */
8511
8510
  showPopoutIcon?: boolean;
8512
8511
  /**
8513
- * @defaultValue false
8514
- *
8515
8512
  * Whether to show the maximize button on stack header.
8516
8513
  * The button will maximize the current tab to fill the entire window.
8514
+ *
8515
+ * @default false
8517
8516
  */
8518
8517
  showMaximiseIcon?: boolean;
8519
8518
  /**
8520
- * @defaultValue false
8521
- *
8522
8519
  * Whether to show the close button on stack header
8523
8520
  * (not to be confused with close button on every tab).
8521
+ *
8522
+ * @default false
8524
8523
  */
8525
8524
  showCloseIcon?: boolean;
8526
8525
  /**
8527
- * @defaultValue false
8528
- *
8529
8526
  * Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
8527
+ *
8528
+ * @default false
8530
8529
  */
8531
8530
  constrainDragToHeaders?: boolean;
8532
8531
  /**
8533
- * @defaultValue true
8534
- *
8535
8532
  * Turns tab headers on or off.
8536
8533
  * If false, the layout will be displayed with splitters only.
8534
+ *
8535
+ * @default true
8537
8536
  */
8538
8537
  hasHeaders?: boolean;
8539
8538
  /**
8540
- * @defaultValue true
8541
- *
8542
8539
  * If true, the user can re-arrange the layout by
8543
8540
  * dragging items by their tabs to the desired location.
8541
+ *
8542
+ * @default true
8544
8543
  */
8545
8544
  reorderEnabled?: boolean;
8546
8545
  /**
8547
- * @defaultValue false
8548
- *
8549
8546
  * If true, tabs can't be dragged out of the window.
8547
+ *
8548
+ * @default false
8550
8549
  */
8551
8550
  preventDragOut?: boolean;
8552
8551
  /**
8553
- * @defaultValue false
8552
+ * @defaultValue=false
8554
8553
  *
8555
8554
  * If true, tabs can't be dragged into the window.
8555
+ *
8556
+ * @default false
8556
8557
  */
8557
8558
  preventDragIn?: boolean;
8558
8559
  /* Excluded from this release type: disableTabOverflowDropdown */
@@ -9060,10 +9061,10 @@ declare type MutableViewOptions = {
9060
9061
  /**
9061
9062
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9062
9063
  *
9063
- * @defaultValue true
9064
- *
9065
9064
  * Show the context menu when right-clicking on the view.
9066
9065
  * Gives access to the devtools for the view.
9066
+ *
9067
+ * @default true
9067
9068
  */
9068
9069
  contextMenu: boolean;
9069
9070
  /**
@@ -9110,24 +9111,25 @@ declare type MutableViewOptions = {
9110
9111
  contentNavigation: ContentNavigation;
9111
9112
  contentRedirect: ContentRedirect;
9112
9113
  /**
9113
- * @defaultValue false
9114
9114
  * @deprecated
9115
9115
  * **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
9116
9116
  * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
9117
+ *
9118
+ * @default false
9117
9119
  */
9118
9120
  detachOnClose: boolean;
9119
9121
  /**
9120
- * @defaultValue true
9121
- *
9122
9122
  * **Platforms Only.** If false, the view will be persistent and can't be closed through
9123
9123
  * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
9124
9124
  * if the view isn't part of the new layout when running `Layout.replace`.
9125
+ *
9126
+ * @default true
9125
9127
  */
9126
9128
  isClosable: boolean;
9127
9129
  /**
9128
- * @defaultValue false
9129
- *
9130
9130
  * **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
9131
+ *
9132
+ * @default false
9131
9133
  */
9132
9134
  preventDragOut: boolean;
9133
9135
  interop?: InteropConfig;
@@ -9135,7 +9137,7 @@ declare type MutableViewOptions = {
9135
9137
  /**
9136
9138
  * {@inheritDoc ViewThrottling}
9137
9139
  *
9138
- * @defaultValue 'enabled'
9140
+ * @default 'enabled'
9139
9141
  */
9140
9142
  throttling: ViewThrottling;
9141
9143
  /**
@@ -9163,25 +9165,25 @@ declare type MutableWindowOptions = {
9163
9165
  */
9164
9166
  alphaMask: RGB;
9165
9167
  /**
9166
- * @defaultValue false
9167
- *
9168
9168
  * Always position the window at the top of the window stack.
9169
+ *
9170
+ * @default false
9169
9171
  */
9170
9172
  alwaysOnTop: boolean;
9171
9173
  /**
9172
- * @defaultValue 0
9173
- *
9174
9174
  * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
9175
9175
  * an aspect ratio will not be enforced.
9176
+ *
9177
+ * @default 0
9176
9178
  */
9177
9179
  aspectRatio: number;
9178
9180
  /**
9179
9181
  * @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
9180
9182
  *
9181
- * @defaultValue true
9182
- *
9183
9183
  * Show the context menu when right-clicking on the window.
9184
9184
  * Gives access to the devtools for the window.
9185
+ *
9186
+ * @default true
9185
9187
  */
9186
9188
  contextMenu: boolean;
9187
9189
  /**
@@ -9248,16 +9250,17 @@ declare type MutableWindowOptions = {
9248
9250
  */
9249
9251
  customData: any;
9250
9252
  /**
9251
- * @defaultValue true
9252
9253
  * @deprecated Will be removed in runtime version 45
9253
9254
  *
9254
9255
  * Show the window's frame.
9256
+ *
9257
+ * @default true
9255
9258
  */
9256
9259
  frame: boolean;
9257
9260
  /**
9258
- * @defaultValue false
9259
- *
9260
9261
  * Hides the window instead of closing it when the close button is pressed.
9262
+ *
9263
+ * @default false
9261
9264
  */
9262
9265
  hideOnClose: boolean;
9263
9266
  /**
@@ -9310,60 +9313,60 @@ declare type MutableWindowOptions = {
9310
9313
  */
9311
9314
  icon: string;
9312
9315
  /**
9313
- * @defaultValue true
9314
- *
9315
9316
  * Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
9316
9317
  * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
9318
+ *
9319
+ * @default true
9317
9320
  */
9318
9321
  includeInSnapshots: boolean;
9319
9322
  /**
9320
- * @defaultValue -1
9321
- *
9322
9323
  * The maximum height of a window. Will default to the OS defined value if set to -1.
9324
+ *
9325
+ * @default -1
9323
9326
  */
9324
9327
  maxHeight: number;
9325
9328
  /**
9326
- * @defaultValue true
9327
- *
9328
9329
  * Allows the window to be maximized.
9330
+ *
9331
+ * @default true
9329
9332
  */
9330
9333
  maximizable: boolean;
9331
9334
  /**
9332
- * @defaultValue -1
9333
- *
9334
9335
  * The maximum width of a window. Will default to the OS defined value if set to -1.
9336
+ *
9337
+ * @default -1
9335
9338
  */
9336
9339
  maxWidth: number;
9337
9340
  /**
9338
- * @defaultValue 0
9339
- *
9340
9341
  * The minimum height of the window.
9342
+ *
9343
+ * @default 0
9341
9344
  */
9342
9345
  minHeight: number;
9343
9346
  /**
9344
- * @defaultValue true
9345
- *
9346
9347
  * Allows the window to be minimized.
9348
+ *
9349
+ * @default true
9347
9350
  */
9348
9351
  minimizable: boolean;
9349
9352
  /**
9350
- * @defaultValue true
9351
- *
9352
9353
  * The minimum width of the window.
9354
+ *
9355
+ * @default true
9353
9356
  */
9354
9357
  minWidth: number;
9355
9358
  /**
9356
- * @defaultValue 1
9357
- *
9358
9359
  * A flag that specifies how transparent the window will be.
9359
9360
  * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
9360
9361
  * This value is clamped between `0.0` and `1.0`.
9362
+ *
9363
+ * @default 1
9361
9364
  */
9362
9365
  opacity: number;
9363
9366
  /**
9364
- * @defaultValue true
9365
- *
9366
9367
  * A flag to allow the user to resize the window.
9368
+ *
9369
+ * @default true
9367
9370
  */
9368
9371
  resizable: boolean;
9369
9372
  /**
@@ -9371,16 +9374,16 @@ declare type MutableWindowOptions = {
9371
9374
  */
9372
9375
  resizeRegion: ResizeRegion;
9373
9376
  /**
9374
- * @defaultValue false
9375
- *
9376
9377
  * **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
9377
9378
  * This occurs when the window is resizing or a tab is being dragged within the layout.
9379
+ *
9380
+ * @default false
9378
9381
  */
9379
9382
  showBackgroundImages: boolean;
9380
9383
  /**
9381
- * @defaultValue true
9382
- *
9383
9384
  * Shows the window's icon in the taskbar.
9385
+ *
9386
+ * @default true
9384
9387
  */
9385
9388
  showTaskbarIcon: boolean;
9386
9389
  /**
@@ -9399,7 +9402,7 @@ declare type MutableWindowOptions = {
9399
9402
  /**
9400
9403
  * {@inheritDoc WindowThrottling}
9401
9404
  *
9402
- * @defaultValue 'enabled'
9405
+ * @default 'enabled'
9403
9406
  *
9404
9407
  * @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
9405
9408
  */
@@ -10045,12 +10048,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
10045
10048
  */
10046
10049
  declare type PastePermissions = {
10047
10050
  /**
10048
- * @defaultValue 'non-protected-content'
10049
- *
10050
10051
  * Controls the behavior for paste operations for a matched URL.
10051
10052
  *
10052
10053
  * non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
10053
10054
  * 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.
10055
+ *
10056
+ * @default 'non-protected-content'
10054
10057
  */
10055
10058
  behavior: 'non-protected-content' | 'all-content';
10056
10059
  };
@@ -11082,11 +11085,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11082
11085
  */
11083
11086
  providerUrl?: string;
11084
11087
  /**
11085
- * @defaultValue true
11086
- *
11087
11088
  * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11088
11089
  *
11089
11090
  * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11091
+ *
11092
+ * @default true
11090
11093
  */
11091
11094
  allowLaunchIntoPlatform?: boolean;
11092
11095
  };
@@ -11734,22 +11737,22 @@ declare type PopupOptions = {
11734
11737
  url?: string;
11735
11738
  /**
11736
11739
  * Height of the popup window in pixels (takes priority over `intialOptions` size properties).
11737
- * @defaultValue 300
11740
+ * @default 300
11738
11741
  */
11739
11742
  height?: number;
11740
11743
  /**
11741
11744
  * Width of the popup window in pixels (takes priority over `intialOptions` size properties).
11742
- * @defaultValue 300
11745
+ * @default 300
11743
11746
  */
11744
11747
  width?: number;
11745
11748
  /**
11746
11749
  * Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11747
- * @defaultValue 0
11750
+ * @default 0
11748
11751
  */
11749
11752
  x?: number;
11750
11753
  /**
11751
11754
  * Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
11752
- * @defaultValue 0
11755
+ * @default 0
11753
11756
  */
11754
11757
  y?: number;
11755
11758
  /**
@@ -11757,7 +11760,7 @@ declare type PopupOptions = {
11757
11760
  * * 'modal' restricts resizing and positioning in the caller.
11758
11761
  * * 'hide' hides the popup window on blur.
11759
11762
  * * 'close' closes the popup window on blur.
11760
- * @defaultValue 'close'
11763
+ * @default 'close'
11761
11764
  */
11762
11765
  blurBehavior?: PopupBlurBehavior;
11763
11766
  /**
@@ -11765,19 +11768,19 @@ declare type PopupOptions = {
11765
11768
  * * 'none' will do nothing.
11766
11769
  * * 'hide' hides the popup window on `dispatchPopupResult`.
11767
11770
  * * 'close' closes the popup window on `dispatchPopupResult`.
11768
- * @defaultValue 'close'
11771
+ * @default 'close'
11769
11772
  */
11770
11773
  resultDispatchBehavior?: PopupResultBehavior;
11771
11774
  /**
11772
11775
  * Hide the popup window instead of closing when `close` is called on it.
11773
11776
  *
11774
11777
  * Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
11775
- * @defaultValue false
11778
+ * @default false
11776
11779
  */
11777
11780
  hideOnClose?: boolean;
11778
11781
  /**
11779
11782
  * Determines if the popup window should or should not be focused when it is shown.
11780
- * @defaultValue true
11783
+ * @default true
11781
11784
  */
11782
11785
  focus?: boolean;
11783
11786
  /**
@@ -11871,9 +11874,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
11871
11874
  */
11872
11875
  declare type PreloadScript = {
11873
11876
  /**
11874
- * @defaultValue false
11875
- *
11876
11877
  * Fail to load the window if this preload script fails
11878
+ *
11879
+ * @default false
11877
11880
  */
11878
11881
  mandatory?: boolean;
11879
11882
  /**
@@ -11965,15 +11968,15 @@ declare type PrinterInfo = {
11965
11968
  declare type PrintOptions = {
11966
11969
  content?: 'self';
11967
11970
  /**
11968
- * @defaultValue false
11969
- *
11970
11971
  * Disables prompting the user for print settings.
11972
+ *
11973
+ * @default false
11971
11974
  */
11972
11975
  silent?: boolean;
11973
11976
  /**
11974
- * @defaultValue false
11975
- *
11976
11977
  * Includes the webpage background color and image when printing.
11978
+ *
11979
+ * @default false
11977
11980
  */
11978
11981
  printBackground?: boolean;
11979
11982
  /**
@@ -11981,9 +11984,9 @@ declare type PrintOptions = {
11981
11984
  */
11982
11985
  deviceName?: string;
11983
11986
  /**
11984
- * @defaultValue true
11985
- *
11986
11987
  * Prints in full color (greyscale otherwise).
11988
+ *
11989
+ * @default true
11987
11990
  */
11988
11991
  color?: boolean;
11989
11992
  /**
@@ -11991,9 +11994,9 @@ declare type PrintOptions = {
11991
11994
  */
11992
11995
  margins?: Margins;
11993
11996
  /**
11994
- * @defaultValue true
11995
- *
11996
11997
  * Prints in landscape mode (portrait otherwise).
11998
+ *
11999
+ * @default true
11997
12000
  */
11998
12001
  landscape?: boolean;
11999
12002
  /**
@@ -13369,15 +13372,15 @@ declare type ReplaceViewPayload = {
13369
13372
  */
13370
13373
  declare type ResizeRegion = {
13371
13374
  /**
13372
- * @defaultValue 7
13373
- *
13374
13375
  * The size of the resize region in pixels.
13376
+ *
13377
+ * @default 7
13375
13378
  */
13376
13379
  size?: number;
13377
13380
  /**
13378
- * @defaultValue 9
13379
- *
13380
13381
  * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
13382
+ *
13383
+ * @default 9
13381
13384
  */
13382
13385
  bottomRightCorner?: number;
13383
13386
  /**
@@ -13385,27 +13388,27 @@ declare type ResizeRegion = {
13385
13388
  */
13386
13389
  sides?: {
13387
13390
  /**
13388
- * @defaultValue true
13389
- *
13390
13391
  * Enables resizing from the top of the window.
13392
+ *
13393
+ * @default true
13391
13394
  */
13392
13395
  top?: boolean;
13393
13396
  /**
13394
- * @defaultValue true
13395
- *
13396
13397
  * Enables resizing from the bottom of the window.
13398
+ *
13399
+ * @default true
13397
13400
  */
13398
13401
  bottom?: boolean;
13399
13402
  /**
13400
- * @defaultValue true
13401
- *
13402
13403
  * Enables resizing from the left side of the window.
13404
+ *
13405
+ * @default true
13403
13406
  */
13404
13407
  left?: boolean;
13405
13408
  /**
13406
- * @defaultValue true
13407
- *
13408
13409
  * Enables resizing from the right side of the window.
13410
+ *
13411
+ * @default true
13409
13412
  */
13410
13413
  right?: boolean;
13411
13414
  };
@@ -13959,9 +13962,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
13959
13962
  */
13960
13963
  declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
13961
13964
  /**
13962
- * @defaultValue 0
13963
- *
13964
13965
  * Number of milliseconds to wait between view repaints.
13966
+ *
13967
+ * @default 0
13965
13968
  */
13966
13969
  paintIntervalMs?: number;
13967
13970
  };
@@ -15648,6 +15651,7 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
15648
15651
  serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
15649
15652
  /**
15650
15653
  * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
15654
+ * @experimental
15651
15655
  */
15652
15656
  launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
15653
15657
  }
@@ -16012,9 +16016,9 @@ declare type TransitionBase = {
16012
16016
  */
16013
16017
  duration: number;
16014
16018
  /**
16015
- * @defaultValue false
16016
- *
16017
16019
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16020
+ *
16021
+ * @default false
16018
16022
  */
16019
16023
  relative?: boolean;
16020
16024
  };
@@ -16030,9 +16034,9 @@ declare type TransitionOptions = {
16030
16034
  */
16031
16035
  interrupt: boolean;
16032
16036
  /**
16033
- * @defaultValue false
16034
- *
16035
16037
  * Treats 'opacity' as absolute or as a delta. Defaults to false.
16038
+ *
16039
+ * @default false
16036
16040
  */
16037
16041
  relative?: boolean;
16038
16042
  tween?: tween;
@@ -16960,9 +16964,9 @@ declare type ViewTitlePriority = 'document' | 'options';
16960
16964
  */
16961
16965
  declare type ViewVisibilityOption = {
16962
16966
  /**
16963
- * @defaultValue false
16964
- *
16965
16967
  * Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
16968
+ *
16969
+ * @default false
16966
16970
  */
16967
16971
  enabled?: boolean;
16968
16972
  };