@openfin/core 34.78.56 → 34.78.58

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.
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8839,7 +8841,8 @@ declare type LayoutIdentity = Identity_5 & {
8839
8841
  };
8840
8842
 
8841
8843
  /**
8842
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8844
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8845
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8843
8846
  * @interface
8844
8847
  */
8845
8848
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9198,6 +9201,9 @@ declare type LayoutOptions = {
9198
9201
  };
9199
9202
  };
9200
9203
 
9204
+ /**
9205
+ * Represents the position of an item in a layout relative to another.
9206
+ */
9201
9207
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9202
9208
 
9203
9209
  /**
@@ -9916,7 +9922,7 @@ declare type MutableWindowOptions = {
9916
9922
  showTaskbarIcon: boolean;
9917
9923
  interop: InteropConfig;
9918
9924
  /* Excluded from this release type: _internalWorkspaceData */
9919
- workspacePlatform: WorkspacePlatformOptions;
9925
+ workspacePlatform: unknown;
9920
9926
  };
9921
9927
 
9922
9928
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11411,6 +11417,17 @@ declare interface PlatformProvider {
11411
11417
  */
11412
11418
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11413
11419
  /* Excluded from this release type: getInitialLayoutSnapshot */
11420
+ /**
11421
+ * @experimental
11422
+ *
11423
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11424
+ * Gets the current state of a particular window and its views and returns an object that
11425
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11426
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11427
+ * @param identity
11428
+ * @param callerIdentity
11429
+ */
11430
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11414
11431
  /* Excluded from this release type: createViewsForLayout */
11415
11432
  /* Excluded from this release type: getViewSnapshot */
11416
11433
  /**
@@ -15330,20 +15347,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15330
15347
  contentItem: ContentItem;
15331
15348
  }
15332
15349
 
15333
- /**
15334
- * @typedef {string} LayoutPosition
15335
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15336
- */
15337
- /**
15338
- * @typedef {object} StackCreationOptions
15339
- * @summary Stack creation options.
15340
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15341
- */
15342
- /**
15343
- * @typedef {object} TabStack~AddViewOptions
15344
- * @summary Options to use when adding a view to a {@link TabStack}
15345
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15346
- */
15347
15350
  /**
15348
15351
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15349
15352
  */
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8839,7 +8841,8 @@ declare type LayoutIdentity = Identity_5 & {
8839
8841
  };
8840
8842
 
8841
8843
  /**
8842
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8844
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8845
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8843
8846
  * @interface
8844
8847
  */
8845
8848
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9198,6 +9201,9 @@ declare type LayoutOptions = {
9198
9201
  };
9199
9202
  };
9200
9203
 
9204
+ /**
9205
+ * Represents the position of an item in a layout relative to another.
9206
+ */
9201
9207
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9202
9208
 
9203
9209
  /**
@@ -9916,7 +9922,7 @@ declare type MutableWindowOptions = {
9916
9922
  showTaskbarIcon: boolean;
9917
9923
  interop: InteropConfig;
9918
9924
  /* Excluded from this release type: _internalWorkspaceData */
9919
- workspacePlatform: WorkspacePlatformOptions;
9925
+ workspacePlatform: unknown;
9920
9926
  };
9921
9927
 
9922
9928
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11411,6 +11417,17 @@ declare interface PlatformProvider {
11411
11417
  */
11412
11418
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11413
11419
  /* Excluded from this release type: getInitialLayoutSnapshot */
11420
+ /**
11421
+ * @experimental
11422
+ *
11423
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11424
+ * Gets the current state of a particular window and its views and returns an object that
11425
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11426
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11427
+ * @param identity
11428
+ * @param callerIdentity
11429
+ */
11430
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11414
11431
  /* Excluded from this release type: createViewsForLayout */
11415
11432
  /* Excluded from this release type: getViewSnapshot */
11416
11433
  /**
@@ -15330,20 +15347,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15330
15347
  contentItem: ContentItem;
15331
15348
  }
15332
15349
 
15333
- /**
15334
- * @typedef {string} LayoutPosition
15335
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15336
- */
15337
- /**
15338
- * @typedef {object} StackCreationOptions
15339
- * @summary Stack creation options.
15340
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15341
- */
15342
- /**
15343
- * @typedef {object} TabStack~AddViewOptions
15344
- * @summary Options to use when adding a view to a {@link TabStack}
15345
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15346
- */
15347
15350
  /**
15348
15351
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15349
15352
  */
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -8839,7 +8841,8 @@ declare type LayoutIdentity = Identity_5 & {
8839
8841
  };
8840
8842
 
8841
8843
  /**
8842
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8844
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8845
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8843
8846
  * @interface
8844
8847
  */
8845
8848
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9198,6 +9201,9 @@ declare type LayoutOptions = {
9198
9201
  };
9199
9202
  };
9200
9203
 
9204
+ /**
9205
+ * Represents the position of an item in a layout relative to another.
9206
+ */
9201
9207
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9202
9208
 
9203
9209
  /**
@@ -9916,7 +9922,7 @@ declare type MutableWindowOptions = {
9916
9922
  showTaskbarIcon: boolean;
9917
9923
  interop: InteropConfig;
9918
9924
  /* Excluded from this release type: _internalWorkspaceData */
9919
- workspacePlatform: WorkspacePlatformOptions;
9925
+ workspacePlatform: unknown;
9920
9926
  };
9921
9927
 
9922
9928
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11411,6 +11417,17 @@ declare interface PlatformProvider {
11411
11417
  */
11412
11418
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11413
11419
  /* Excluded from this release type: getInitialLayoutSnapshot */
11420
+ /**
11421
+ * @experimental
11422
+ *
11423
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11424
+ * Gets the current state of a particular window and its views and returns an object that
11425
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11426
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11427
+ * @param identity
11428
+ * @param callerIdentity
11429
+ */
11430
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11414
11431
  /* Excluded from this release type: createViewsForLayout */
11415
11432
  /* Excluded from this release type: getViewSnapshot */
11416
11433
  /**
@@ -15330,20 +15347,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15330
15347
  contentItem: ContentItem;
15331
15348
  }
15332
15349
 
15333
- /**
15334
- * @typedef {string} LayoutPosition
15335
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15336
- */
15337
- /**
15338
- * @typedef {object} StackCreationOptions
15339
- * @summary Stack creation options.
15340
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15341
- */
15342
- /**
15343
- * @typedef {object} TabStack~AddViewOptions
15344
- * @summary Options to use when adding a view to a {@link TabStack}
15345
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15346
- */
15347
15350
  /**
15348
15351
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15349
15352
  */
package/out/mock.d.ts CHANGED
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -3411,57 +3413,6 @@ declare type ClosingEvent = BaseEvent_5 & {
3411
3413
  */
3412
3414
  declare class ColumnOrRow extends LayoutNode {
3413
3415
  #private;
3414
- /**
3415
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
3416
- * @function isRoot
3417
- * @memberof ColumnOrRow
3418
- * @instance
3419
- * @tutorial ColumnOrRow.isRoot
3420
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
3421
- */
3422
- /**
3423
- * Determines if this {@link ColumnOrRow} exists.
3424
- * @function exists
3425
- * @instance
3426
- * @memberof ColumnOrRow
3427
- * @tutorial ColumnOrRow.exists
3428
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
3429
- */
3430
- /**
3431
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
3432
- * @function getParent
3433
- * @instance
3434
- * @memberof ColumnOrRow
3435
- * @tutorial ColumnOrRow.getParent
3436
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
3437
- * this {@link ColumnOrRow}does not exist or is the root content item.
3438
- */
3439
- /**
3440
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
3441
- * @function getAdjacentStacks
3442
- * @instance
3443
- * @memberof ColumnOrRow
3444
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
3445
- *
3446
- * @tutorial ColumnOrRow.getAdjacentStacks
3447
- */
3448
- /**
3449
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
3450
- *
3451
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
3452
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
3453
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
3454
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
3455
- *
3456
- * @function createAdjacentStack
3457
- * @instance
3458
- * @memberof ColumnOrRow
3459
- * @param views - List of identities or view creation options of the views to include in the stack
3460
- * @param options - Creation options.
3461
- * @returns The created TabStack
3462
- * @tutorial ColumnOrRow.createAdjacentStack
3463
- * @experimental
3464
- */
3465
3416
  /**
3466
3417
  * @internal
3467
3418
  */
@@ -8992,7 +8943,8 @@ declare type LayoutIdentity = Identity_5 & {
8992
8943
  };
8993
8944
 
8994
8945
  /**
8995
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8946
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8947
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8996
8948
  * @interface
8997
8949
  */
8998
8950
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -9355,6 +9307,15 @@ declare abstract class LayoutNode {
9355
9307
  /**
9356
9308
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
9357
9309
  *
9310
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
9311
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
9312
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
9313
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
9314
+ *
9315
+ * @param views The views that will populate the new TabStack.
9316
+ * @param options Additional options that control new TabStack creation.
9317
+ * @returns The newly-created TabStack.
9318
+ *
9358
9319
  * @example
9359
9320
  * ```js
9360
9321
  * if (!fin.me.isView) {
@@ -9389,12 +9350,15 @@ declare abstract class LayoutNode {
9389
9350
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
9390
9351
  *
9391
9352
  * ```
9353
+ * @experimental
9392
9354
  */
9393
9355
  createAdjacentStack: (views: OpenFin_2.PlatformViewCreationOptions[], options: {
9394
9356
  position?: OpenFin_2.LayoutPosition;
9395
9357
  }) => Promise<TabStack>;
9396
9358
  /**
9397
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
9359
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
9360
+ *
9361
+ * @param edge Edge whose adjacent TabStacks will be returned.
9398
9362
  *
9399
9363
  * @example
9400
9364
  * ```js
@@ -9414,6 +9378,7 @@ declare abstract class LayoutNode {
9414
9378
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
9415
9379
  *
9416
9380
  * ```
9381
+ * @experimental
9417
9382
  */
9418
9383
  getAdjacentStacks: (edge: OpenFin_2.LayoutPosition) => Promise<TabStack[]>;
9419
9384
  }
@@ -9508,6 +9473,9 @@ declare type LayoutOptions = {
9508
9473
  };
9509
9474
  };
9510
9475
 
9476
+ /**
9477
+ * Represents the position of an item in a layout relative to another.
9478
+ */
9511
9479
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9512
9480
 
9513
9481
  /**
@@ -10234,7 +10202,7 @@ declare type MutableWindowOptions = {
10234
10202
  * Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
10235
10203
  */
10236
10204
  _internalWorkspaceData: any;
10237
- workspacePlatform: WorkspacePlatformOptions;
10205
+ workspacePlatform: unknown;
10238
10206
  };
10239
10207
 
10240
10208
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -11781,6 +11749,17 @@ declare interface PlatformProvider {
11781
11749
  * @param callerIdentity
11782
11750
  */
11783
11751
  getInitialLayoutSnapshot(payload: undefined, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.LayoutSnapshot | undefined>;
11752
+ /**
11753
+ * @experimental
11754
+ *
11755
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11756
+ * Gets the current state of a particular window and its views and returns an object that
11757
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11758
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11759
+ * @param identity
11760
+ * @param callerIdentity
11761
+ */
11762
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11784
11763
  /**
11785
11764
  * @experimental @internal
11786
11765
  *
@@ -11795,7 +11774,7 @@ declare interface PlatformProvider {
11795
11774
  */
11796
11775
  createViewsForLayout(payload: {
11797
11776
  layout: GoldenLayout.Config;
11798
- target?: OpenFin_2.Identity;
11777
+ target?: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
11799
11778
  }, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.View>[];
11800
11779
  /**
11801
11780
  * **NOTE**: Internal use only. It is not recommended to manage the state of individual views.
@@ -15763,75 +15742,11 @@ declare interface TabDragListener extends EventEmitter_2 {
15763
15742
  contentItem: ContentItem;
15764
15743
  }
15765
15744
 
15766
- /**
15767
- * @typedef {string} LayoutPosition
15768
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15769
- */
15770
- /**
15771
- * @typedef {object} StackCreationOptions
15772
- * @summary Stack creation options.
15773
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15774
- */
15775
- /**
15776
- * @typedef {object} TabStack~AddViewOptions
15777
- * @summary Options to use when adding a view to a {@link TabStack}
15778
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15779
- */
15780
15745
  /**
15781
15746
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15782
15747
  */
15783
15748
  declare class TabStack extends LayoutNode {
15784
15749
  #private;
15785
- /**
15786
- * Determines if this {@link TabStack} is the top level content item in the current layout.
15787
- * @function isRoot
15788
- * @memberof TabStack
15789
- * @instance
15790
- * @tutorial TabStack.isRoot
15791
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
15792
- */
15793
- /**
15794
- * Determines if this {@link TabStack} exists.
15795
- * @function exists
15796
- * @instance
15797
- * @memberof TabStack
15798
- * @tutorial TabStack.exists
15799
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
15800
- */
15801
- /**
15802
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
15803
- * @function getParent
15804
- * @instance
15805
- * @memberof TabStack
15806
- * @tutorial TabStack.getParent
15807
- * @returns is the root content item or does not exist.
15808
- */
15809
- /**
15810
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
15811
- * @function getAdjacentStacks
15812
- * @instance
15813
- * @memberof TabStack
15814
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
15815
- *
15816
- * @tutorial TabStack.getAdjacentStacks
15817
- */
15818
- /**
15819
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
15820
- *
15821
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
15822
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
15823
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
15824
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
15825
- *
15826
- * @function createAdjacentStack
15827
- * @instance
15828
- * @memberof TabStack
15829
- * @param views - List of identities or view creation options of the views to include in the stack
15830
- * @param options - Creation options.
15831
- * @returns The created TabStack.
15832
- * @tutorial TabStack.createAdjacentStack
15833
- * @experimental
15834
- */
15835
15750
  /** @internal */
15836
15751
  constructor(client: LayoutEntitiesClient, entityId: string);
15837
15752
  /**
package/out/mock.js CHANGED
@@ -1232,6 +1232,15 @@ class LayoutNode {
1232
1232
  /**
1233
1233
  * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
1234
1234
  *
1235
+ * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1236
+ * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1237
+ * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1238
+ * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1239
+ *
1240
+ * @param views The views that will populate the new TabStack.
1241
+ * @param options Additional options that control new TabStack creation.
1242
+ * @returns The newly-created TabStack.
1243
+ *
1235
1244
  * @example
1236
1245
  * ```js
1237
1246
  * if (!fin.me.isView) {
@@ -1266,13 +1275,16 @@ class LayoutNode {
1266
1275
  * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
1267
1276
  *
1268
1277
  * ```
1278
+ * @experimental
1269
1279
  */
1270
1280
  this.createAdjacentStack = async (views, options) => {
1271
1281
  const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
1272
1282
  return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
1273
1283
  };
1274
1284
  /**
1275
- * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
1285
+ * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
1286
+ *
1287
+ * @param edge Edge whose adjacent TabStacks will be returned.
1276
1288
  *
1277
1289
  * @example
1278
1290
  * ```js
@@ -1292,6 +1304,7 @@ class LayoutNode {
1292
1304
  * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
1293
1305
  *
1294
1306
  * ```
1307
+ * @experimental
1295
1308
  */
1296
1309
  this.getAdjacentStacks = async (edge) => {
1297
1310
  const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
@@ -1335,74 +1348,10 @@ LayoutNode.getEntity = (definition, client) => {
1335
1348
  throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
1336
1349
  }
1337
1350
  };
1338
- /**
1339
- * @typedef {string} LayoutPosition
1340
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
1341
- */
1342
- /**
1343
- * @typedef {object} StackCreationOptions
1344
- * @summary Stack creation options.
1345
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
1346
- */
1347
- /**
1348
- * @typedef {object} TabStack~AddViewOptions
1349
- * @summary Options to use when adding a view to a {@link TabStack}
1350
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
1351
- */
1352
1351
  /**
1353
1352
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
1354
1353
  */
1355
1354
  class TabStack extends LayoutNode {
1356
- /**
1357
- * Determines if this {@link TabStack} is the top level content item in the current layout.
1358
- * @function isRoot
1359
- * @memberof TabStack
1360
- * @instance
1361
- * @tutorial TabStack.isRoot
1362
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1363
- */
1364
- /**
1365
- * Determines if this {@link TabStack} exists.
1366
- * @function exists
1367
- * @instance
1368
- * @memberof TabStack
1369
- * @tutorial TabStack.exists
1370
- * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
1371
- */
1372
- /**
1373
- * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
1374
- * @function getParent
1375
- * @instance
1376
- * @memberof TabStack
1377
- * @tutorial TabStack.getParent
1378
- * @returns is the root content item or does not exist.
1379
- */
1380
- /**
1381
- * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
1382
- * @function getAdjacentStacks
1383
- * @instance
1384
- * @memberof TabStack
1385
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1386
- *
1387
- * @tutorial TabStack.getAdjacentStacks
1388
- */
1389
- /**
1390
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
1391
- *
1392
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1393
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1394
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1395
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1396
- *
1397
- * @function createAdjacentStack
1398
- * @instance
1399
- * @memberof TabStack
1400
- * @param views - List of identities or view creation options of the views to include in the stack
1401
- * @param options - Creation options.
1402
- * @returns The created TabStack.
1403
- * @tutorial TabStack.createAdjacentStack
1404
- * @experimental
1405
- */
1406
1355
  /** @internal */
1407
1356
  constructor(client, entityId) {
1408
1357
  super(client, entityId);
@@ -1535,57 +1484,6 @@ _TabStack_client = new WeakMap();
1535
1484
  * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
1536
1485
  */
1537
1486
  class ColumnOrRow extends LayoutNode {
1538
- /**
1539
- * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
1540
- * @function isRoot
1541
- * @memberof ColumnOrRow
1542
- * @instance
1543
- * @tutorial ColumnOrRow.isRoot
1544
- * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
1545
- */
1546
- /**
1547
- * Determines if this {@link ColumnOrRow} exists.
1548
- * @function exists
1549
- * @instance
1550
- * @memberof ColumnOrRow
1551
- * @tutorial ColumnOrRow.exists
1552
- * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
1553
- */
1554
- /**
1555
- * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
1556
- * @function getParent
1557
- * @instance
1558
- * @memberof ColumnOrRow
1559
- * @tutorial ColumnOrRow.getParent
1560
- * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
1561
- * this {@link ColumnOrRow}does not exist or is the root content item.
1562
- */
1563
- /**
1564
- * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
1565
- * @function getAdjacentStacks
1566
- * @instance
1567
- * @memberof ColumnOrRow
1568
- * @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
1569
- *
1570
- * @tutorial ColumnOrRow.getAdjacentStacks
1571
- */
1572
- /**
1573
- * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
1574
- *
1575
- * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
1576
- * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
1577
- * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
1578
- * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
1579
- *
1580
- * @function createAdjacentStack
1581
- * @instance
1582
- * @memberof ColumnOrRow
1583
- * @param views - List of identities or view creation options of the views to include in the stack
1584
- * @param options - Creation options.
1585
- * @returns The created TabStack
1586
- * @tutorial ColumnOrRow.createAdjacentStack
1587
- * @experimental
1588
- */
1589
1487
  /**
1590
1488
  * @internal
1591
1489
  */
@@ -1631,7 +1529,8 @@ var layout_constants = {};
1631
1529
  Object.defineProperty(layout_constants, "__esModule", { value: true });
1632
1530
  layout_constants.DEFAULT_LAYOUT_KEY = layout_constants.LAYOUT_CONTROLLER_ID = void 0;
1633
1531
  layout_constants.LAYOUT_CONTROLLER_ID = 'layout-entities';
1634
- layout_constants.DEFAULT_LAYOUT_KEY = 'default';
1532
+ // TODO: eventually export this somehow
1533
+ layout_constants.DEFAULT_LAYOUT_KEY = '__default__';
1635
1534
 
1636
1535
  var main = {};
1637
1536
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "34.78.56",
3
+ "version": "34.78.58",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "main": "out/mock.js",