@openfin/fdc3-api 36.79.12 → 36.79.15

package/out/fdc3-api-alpha.d.ts

@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -9737,6 +9763,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10457,6 +10490,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

package/out/fdc3-api-beta.d.ts

@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -9737,6 +9763,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10457,6 +10490,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

package/out/fdc3-api-public.d.ts

@@ -4466,6 +4466,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -9737,6 +9763,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10457,6 +10490,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

package/out/fdc3-api.d.ts

@@ -4509,6 +4509,32 @@ declare type CreateLayoutOptions = {
     container: HTMLElement;
     layoutName: string;
     layout: LayoutOptions;
+    /**
+     * @defaultValue 'default'
+     *
+     * Controls the View behavior for the given `layout` property. Note
+     * that the selected behavior only applies to unnamed Views or
+     * Views with the prefix `internal-generated-`. In all cases, if any
+     * View in the `layout` does not already exist, it will be created
+     * with a name that starts with `internal-generated-`.
+     *
+     * When set to `reparent`, Views prefixed with `internal-generated-` will
+     * be reparented to the current Window and added to this new Layout.
+     * Use this option when you need to transfer an existing Layout between Windows.
+     *
+     * When set to 'duplicate', Views prefixed with `internal-generated-` will
+     * be duplicated with new generated names. Use this option when you need
+     * to clone a Layout to any Window.
+     *
+     * When set to `default` or omitted, the Layout will attempt to re-use
+     * existing Views only if they are attached to the current Window or
+     * the Provider Window. Set to `default` or omit this option when creating
+     * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
+     * override. Note that during applyLayoutSnapshot, Views are created and
+     * attached to the Provider while the Window is being created, so it's
+     * important to not 'duplicate' Views in this workflow.
+     */
+    multiInstanceViewBehavior?: MultiInstanceViewBehavior;
 };
 
 /**
@@ -10014,6 +10040,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
     type: 'monitor-info-changed';
 };
 
+/**
+ * @experimental
+ *
+ * Used to control view behavior for Layout.create API
+ */
+declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
+
 /**
  * @interface
  */
@@ -10756,6 +10789,7 @@ declare namespace OpenFin {
         LayoutManagerOverride,
         LayoutManager,
         CreateLayoutOptions,
+        MultiInstanceViewBehavior,
         PresetLayoutOptions_2 as PresetLayoutOptions,
         ResultBehavior,
         PopupBaseBehavior,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "36.79.12",
+    "version": "36.79.15",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,