@openfin/core 33.76.36 → 33.76.38

package/src/api/platform/layout/entities/layout-entities.d.ts

@@ -1,427 +0,0 @@
-import type * as OpenFin from '../../../../OpenFin';
-import { LayoutEntitiesClient } from '../shapes';
-/**
- * @ignore
- * @internal
- * Supplies an ApiClient for {@link LayoutEntitiesController} and helper methods
- * for the entities {@link TabStack} AND {@link ColumnOrRow} to use.
- */
-export declare abstract class LayoutNode {
-    #private;
-    /**
-     * @internal
-     * @ignore
-     */
-    protected constructor(client: LayoutEntitiesClient, entityId: string);
-    abstract readonly type: OpenFin.LayoutEntityTypes;
-    /**
-     * @internal
-     * @ignore
-     * This instance's unique id used when calling the layout-entities-controller api client
-     */
-    protected readonly entityId: string;
-    /**
-     * @ignore
-     * @internal
-     * Encapsulates Api consumption of {@link LayoutEntitiesController} with a relayed dispatch
-     * @param client
-     * @param controllerId
-     * @param identity
-     * @returns a new instance of {@link LayoutEntitiesClient} with bound to the controllerId
-     */
-    static newLayoutEntitiesClient: (client: OpenFin.ChannelClient, controllerId: string, identity: OpenFin.Identity) => Promise<LayoutEntitiesClient>;
-    static getEntity: (definition: OpenFin.LayoutEntityDefinition, client: LayoutEntitiesClient) => ColumnOrRow | TabStack;
-    /**
-     * Checks if the TabStack or ColumnOrRow is the root content item
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * const isRoot = await stack.isRoot();
-     * // The TabStack is root: false
-     * console.log(`The TabStack is root: ${isRoot}`);
-     *
-     * // Retrieves the parent ColumnOrRow
-     * const parent = await stack.getParent();
-     * const parentIsRoot = await parent.isRoot();
-     * // The parent ColumnOrRow is root: true
-     * console.log(`The parent ColumnOrRow is root: ${parentIsRoot}`);
-     * ```
-     */
-    isRoot: () => Promise<boolean>;
-    /**
-     * Checks if the TabStack or ColumnOrRow exists
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Retrieves the parent ColumnOrRow
-     * const columnOrRow = await stack.getParent();
-     * let exists = await stack.exists();
-     * // or
-     * let exists = await columnOrRow.exists();
-     * // The entity exists: true
-     * console.log(`The entity exists: ${exists}`);
-     * ```
-     */
-    exists: () => Promise<boolean>;
-    /**
-     * Retrieves the parent of the TabStack or ColumnOrRow
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Retrieves the parent ColumnOrRow
-     * const columnOrRow = await stack.getParent();
-     *
-     * // undefined if entity is the root item
-     * let parent = await columnOrRow.getParent();
-     * // or
-     * let parent = await stack.getParent();
-     * ```
-     */
-    getParent: () => Promise<ColumnOrRow | TabStack | undefined>;
-    /**
-     * Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * const columnOrRow = await stack.getParent();
-     *
-     * // Create view references by supplying a 'name' and 'url'
-     * const views = [
-     *     // if 'name' is undefined, one will be generated
-     *     // if 'url' is undefined, it will default the view URL to 'about:blank'
-     *     { name: 'google-view', url: 'http://google.com/'},
-     *     { name: 'of-developers-view', url: 'http://developers.openfin.co/'},
-     * ];
-     *
-     * // Create a view beforehand to be included in the new tab stack
-     * const outsideView = await fin.View.create({
-     *     name: 'outside-bloomberg-view',
-     *     url: 'https://bloomberg.com/',
-     *     target: fin.me.identity,
-     * });
-     *
-     * // Views to add can be identities, or the reference views mentioned above
-     * const viewsToAdd = [outsideView.identity, ...views];
-     *
-     * // Possible position inputs: 'right' | 'left' | 'top' | 'bottom'
-     * let stackFrom = await columnOrRow.createAdjacentStack(viewsToAdd, { position: 'right' });
-     * // Or
-     * let newStack = await stack.createAdjacentStack(viewsToAdd, { position: 'right' });
-     * console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
-     *
-     * ```
-     */
-    createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
-        position?: OpenFin.LayoutPosition;
-    }) => Promise<TabStack>;
-    /**
-     * Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * const columnOrRow = await stack.getParent();
-     * // Possible position inputs: 'right' | 'left' | 'top' | 'bottom'
-     * let rightStacks = await columnOrRow.getAdjacentStacks('right');
-     * let leftStacks = await columnOrRow.getAdjacentStacks('left');
-     * // or
-     * let rightStacks = await stack.getAdjacentStacks('right');
-     * let leftStacks = await stack.getAdjacentStacks('left');
-     *
-     * console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
-     *
-     * ```
-     */
-    getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
-}
-/**
- * @typedef {string} LayoutPosition
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
- */
-/**
- * @typedef {object} StackCreationOptions
- * @summary Stack creation options.
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
- */
-/**
- * @typedef {object} TabStack~AddViewOptions
- * @summary Options to use when adding a view to a {@link TabStack}
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
- */
-/**
- * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
- */
-export declare class TabStack extends LayoutNode {
-    #private;
-    /**
-     * Determines if this {@link TabStack} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof TabStack
-     * @instance
-     * @tutorial TabStack.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link TabStack} exists.
-     * @function exists
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.exists
-     * @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof TabStack
-     * @tutorial TabStack.getParent
-     * @returns is the root content item or does not exist.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof TabStack
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial TabStack.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof TabStack
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack.
-     * @tutorial TabStack.createAdjacentStack
-     * @experimental
-     */
-    /** @internal */
-    constructor(client: LayoutEntitiesClient, entityId: string);
-    /**
-     * Type of the content item. Always stack, but useful for distinguishing between a {@link TabStack} and {@link ColumnOrRow}.
-     */
-    readonly type = "stack";
-    /**
-     * Retrieves a list of all views belonging to this {@link TabStack}.
-     *
-     * Known Issue: If adding a view overflows the tab-container width, the added view will be set as active
-     * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * If that happens and then getViews() is called, it will return the identities in a different order than
-     * than the currently rendered tab order.
-     *
-     *
-     * @throws If the {@link TabStack} has been destroyed.
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Alternatively, you can wrap any view and get the stack from there
-     * // const viewFromSomewhere = fin.View.wrapSync(someView.identity);
-     * // const stack = await viewFromSomewhere.getCurrentStack();
-     * const views = await stack.getViews();
-     * console.log(`Stack contains ${views.length} view(s)`);
-     * ```
-     * @experimental
-     */
-    getViews: () => Promise<OpenFin.Identity[]>;
-    /**
-     * Adds or creates a view in this {@link TabStack}.
-     *
-     * @remarks Known Issue: If adding a view overflows the tab-container, the added view will be set as active
-     * and rendered at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     *
-     * @param view The identity of an existing view to add, or options to create a view.
-     * @param options Optional view options: index number used to insert the view into the stack at that index. Defaults to 0 (front of the stack)
-     * @returns Resolves with the {@link OpenFin.Identity identity} of the added view.
-     * @throws If the view does not exist or fails to create.
-     * @throws If the {@link TabStack} has been destroyed.
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Alternatively, you can wrap any view and get the stack from there
-     * // const viewFromSomewhere = fin.View.wrapSync(someView.identity);
-     * // const stack = await viewFromSomewhere.getCurrentStack();
-     * const googleViewIdentity = await stack.addView({ name: 'google-view', url: 'http://google.com/' });
-     * console.log('Identity of the google view just added', { googleViewIdentity });
-     * // pass in { index: number } to set the index in the stack. Here 1 means, end of the stack (defaults to 0)
-     * const appleViewIdentity = await stack.addView({ name: 'apple-view', url: 'http://apple.com/' }, { index: 1 });
-     * console.log('Identity of the apple view just added', { appleViewIdentity });
-     * ```
-     * @experimental
-     */
-    addView: (view: OpenFin.Identity | OpenFin.PlatformViewCreationOptions, options?: OpenFin.AddViewToStackOptions) => Promise<OpenFin.Identity>;
-    /**
-     * Removes a view from this {@link TabStack}.
-     *
-     * @remarks Throws an exception if the view identity does not exist or was already destroyed.
-     *
-     * @param view - Identity of the view to remove.
-     * @throws If the view does not exist or does not belong to the stack.
-     * @throws If the {@link TabStack} has been destroyed.
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * const googleViewIdentity = await stack.addView({ name: 'google-view', url: 'http://google.com/' });
-     *
-     * await stack.removeView(googleViewIdentity);
-     *
-     * try {
-     *     await stack.removeView(googleViewIdentity);
-     * } catch (error) {
-     *     // Tried to remove a view ('google-view') which does not belong to the stack.
-     *     console.log(error);
-     * }
-     * ```
-     */
-    removeView: (view: OpenFin.Identity) => Promise<void>;
-    /**
-     * Sets the active view of the {@link TabStack} without focusing it.
-     * @param view - Identity of the view to activate.
-     * @returns Promise which resolves with void once the view has been activated.
-     * @throws If the {@link TabStack} has been destroyed.
-     * @throws If the view does not exist.
-     * @example
-     * Change the active tab of a known View's TabStack:
-     * ```js
-     * const targetView = fin.View.wrapSync({ uuid: 'uuid', name: 'view-name' });
-     * const stack = await targetView.getCurrentStack();
-     * await stack.setActiveView(targetView.identity);
-     * ```
-     *
-     * Set the current View as active within its TabStack:
-     * ```js
-     * const stack = await fin.me.getCurrentStack();
-     * await stack.setActiveView(fin.me.identity);
-     * ```
-     * @experimental
-     */
-    setActiveView: (view: OpenFin.Identity) => Promise<void>;
-}
-/**
- * A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
- */
-export declare class ColumnOrRow extends LayoutNode {
-    #private;
-    /**
-     * Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
-     * @function isRoot
-     * @memberof ColumnOrRow
-     * @instance
-     * @tutorial ColumnOrRow.isRoot
-     * @returns Resolves true if this TabStack is the top level content item, or false if it is not.
-     */
-    /**
-     * Determines if this  {@link ColumnOrRow} exists.
-     * @function exists
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.exists
-     * @returns Resolves true if the TabStack exists, or false if it has been destroyed.
-     */
-    /**
-     * Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
-     * @function getParent
-     * @instance
-     * @memberof ColumnOrRow
-     * @tutorial ColumnOrRow.getParent
-     * @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
-     * this {@link ColumnOrRow}does not exist or is the root content item.
-     */
-    /**
-     * Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
-     * @function getAdjacentStacks
-     * @instance
-     * @memberof ColumnOrRow
-     * @param  {LayoutPosition} edge - Edge to check for any adjacent stacks.
-     *
-     * @tutorial ColumnOrRow.getAdjacentStacks
-     */
-    /**
-     * Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
-     *
-     * Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
-     * during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
-     * This means the views you pass to createAdjacentStack() may not render in the order given by the array.
-     * Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
-     *
-     * @function createAdjacentStack
-     * @instance
-     * @memberof ColumnOrRow
-     * @param views - List of identities or view creation options of the views to include in the stack
-     * @param options - Creation options.
-     * @returns The created TabStack
-     * @tutorial ColumnOrRow.createAdjacentStack
-     * @experimental
-     */
-    /**
-     * @internal
-     */
-    constructor(client: LayoutEntitiesClient, entityId: string, type: 'row' | 'column');
-    /**
-     * The type of this {@link ColumnOrRow}. Either 'row' or 'column'.
-     */
-    readonly type: 'column' | 'row';
-    /**
-     * Retrieves the content array of the ColumnOrRow
-     *
-     * @example
-     * ```js
-     * if (!fin.me.isView) {
-     *     throw new Error('Not running in a platform View.');
-     * }
-     *
-     * const stack = await fin.me.getCurrentStack();
-     * // Retrieves the parent ColumnOrRow
-     * const columnOrRow = await stack.getParent();
-     *
-     * // returns [TabStack]
-     * const contentArray = await columnOrRow.getContent();
-     * console.log(`The ColumnOrRow has ${contentArray.length} item(s)`);
-     * ```
-     */
-    getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
-}