@deephaven/golden-layout 0.19.2-beta.4 → 0.20.0

package/dist/LayoutManager.d.ts

@@ -0,0 +1,313 @@
+import React from 'react';
+import type { ItemConfig, Config, ComponentConfig, ItemConfigType, ReactComponentConfig } from './config';
+import type { ItemContainer } from './container';
+import { BrowserPopout, DragSource, DragSourceFromEvent, DropTargetIndicator, TransitionIndicator } from './controls';
+import { AbstractContentItem, ItemArea, Root, Stack } from './items';
+import { EventEmitter, EventHub } from './utils';
+export declare type ComponentConstructor<C extends ComponentConfig | ReactComponentConfig = ComponentConfig> = {
+    new (container: ItemContainer<C>, state: unknown): unknown;
+};
+/**
+ * The main class that will be exposed as GoldenLayout.
+ *
+ * @param config
+ * @param container Can be a jQuery selector string or a Dom element. Defaults to body
+ */
+export default class LayoutManager extends EventEmitter {
+    /**
+     * Hook that allows to access private classes
+     */
+    static __lm: {
+        config: typeof import("./config");
+        container: typeof import("./container");
+        controls: typeof import("./controls");
+        errors: typeof import("./errors");
+        items: typeof import("./items");
+        utils: typeof import("./utils");
+    };
+    /**
+     * Takes a GoldenLayout configuration object and
+     * replaces its keys and values recursively with
+     * one letter codes
+     *
+     * @param config A GoldenLayout config object
+     * @returns minified config
+     */
+    static minifyConfig(config: Config): Record<string, unknown>;
+    /**
+     * Takes a configuration Object that was previously minified
+     * using minifyConfig and returns its original version
+     *
+     * @param minifiedConfig
+     * @returns the original configuration
+     */
+    static unminifyConfig(config: Record<string, unknown>): Config;
+    isInitialised: boolean;
+    private _isFullPage;
+    private _resizeTimeoutId;
+    private _components;
+    private _fallbackComponent?;
+    private _itemAreas;
+    private _maximisedItem;
+    private _maximisePlaceholder;
+    private _creationTimeoutPassed;
+    private _subWindowsCreated;
+    private _dragSources;
+    private _updatingColumnsResponsive;
+    private _firstLoad;
+    width: number | null;
+    height: number | null;
+    root: Root;
+    openPopouts: BrowserPopout[];
+    selectedItem: AbstractContentItem | null;
+    isSubWindow: boolean;
+    eventHub: EventHub;
+    config: Config;
+    container: JQuery<HTMLElement>;
+    private _originalContainer;
+    dropTargetIndicator: DropTargetIndicator | null;
+    transitionIndicator: TransitionIndicator | null;
+    tabDropPlaceholder: JQuery<HTMLElement>;
+    private _typeToItem;
+    constructor(config: Config, container: JQuery<HTMLElement> | HTMLElement | undefined);
+    /**
+     * Register a component with the layout manager. If a configuration node
+     * of type component is reached it will look up componentName and create the
+     * associated component
+     *
+     *  {
+     *		type: "component",
+     *		componentName: "EquityNewsFeed",
+     *		componentState: { "feedTopic": "us-bluechips" }
+     *  }
+     *
+     * @param name
+     * @param constructor
+     * @returns cleanup function to deregister component
+     */
+    registerComponent(name: string, constructor: ComponentConstructor | React.Component | React.ForwardRefExoticComponent<any>): () => void;
+    /**
+     * Set a fallback component to be rendered in place of unregistered components
+     * @param constructor
+     */
+    setFallbackComponent(constructor: ComponentConstructor | React.ForwardRefExoticComponent<any>): void;
+    /**
+     * Creates a layout configuration object based on the the current state
+     * @param root
+     * @returns GoldenLayout configuration
+     */
+    toConfig(root?: AbstractContentItem): Config;
+    /**
+     * Returns a previously registered component
+     * @param name The name used
+     */
+    getComponent(name: string): ComponentConstructor<ComponentConfig> | ComponentConstructor<ReactComponentConfig> | React.Component<{}, {}, any> | React.ForwardRefExoticComponent<any>;
+    /**
+     * Returns a fallback component to render in place of unregistered components
+     *
+     * @public
+     *
+     * @returns {Function}
+     */
+    getFallbackComponent(): ComponentConstructor<ComponentConfig> | React.ForwardRefExoticComponent<any> | undefined;
+    /**
+     * Creates the actual layout. Must be called after all initial components
+     * are registered. Recurses through the configuration and sets up
+     * the item tree.
+     *
+     * If called before the document is ready it adds itself as a listener
+     * to the document.ready event
+     */
+    init(): void;
+    /**
+     * Updates the layout managers size
+     * @param width width in pixels
+     * @param height height in pixels
+     */
+    updateSize(width?: number, height?: number): void;
+    /**
+     * Destroys the LayoutManager instance itself as well as every ContentItem
+     * within it. After this is called nothing should be left of the LayoutManager.
+     */
+    destroy(): void;
+    /**
+     * Recursively creates new item tree structures based on a provided
+     * ItemConfiguration object
+     *
+     * @public
+     * @param config ItemConfig
+     * @param parent The item the newly created item should be a child of
+     *
+     * @returns Created item
+     */
+    createContentItem(config: Partial<ComponentConfig> & {
+        type: ItemConfig['type'];
+    }, parent?: AbstractContentItem): AbstractContentItem;
+    /**
+       * Creates a popout window with the specified content and dimensions
+       *
+       * @param configOrContentItem
+       * @param dimensions A map with width, height, left and top
+       * @param parentId the id of the element this item will be appended to
+       *                             when popIn is called
+       * @param indexInParent The position of this item within its parent element
+  
+       * @returns Created popout
+       */
+    createPopout(configOrContentItem: ItemConfigType | AbstractContentItem | ItemConfigType[], dimensions?: {
+        width: number;
+        height: number;
+        left: number;
+        top: number;
+    }, parentId?: string, indexInParent?: number): BrowserPopout | undefined;
+    /**
+     * Attaches DragListener to any given DOM element
+     * and turns it into a way of creating new ContentItems
+     * by 'dragging' the DOM element into the layout
+     *
+     * @param element
+     * @param itemConfig for the new item to be created, or a function which will provide it
+     */
+    createDragSource(element: JQuery<HTMLElement>, itemConfig: ComponentConfig | (() => ComponentConfig)): DragSource;
+    /**
+     * Create a new item in a dragging state, given a starting mouse event to act as the initial position
+     *
+     * @param itemConfig for the new item to be created, or a function which will provide it
+     * @param event used as the starting position for the dragProxy
+     */
+    createDragSourceFromEvent(itemConfig: ItemConfig | (() => ItemConfig), event: JQuery.TriggeredEvent): DragSourceFromEvent;
+    /**
+     * Programmatically selects an item. This deselects
+     * the currently selected item, selects the specified item
+     * and emits a selectionChanged event
+     *
+     * @param item
+     * @param _$silent Wheather to notify the item of its selection
+     */
+    selectItem(item: AbstractContentItem, _$silent?: boolean): void;
+    /*************************
+     * PACKAGE PRIVATE
+     *************************/
+    _$maximiseItem(contentItem: AbstractContentItem): void;
+    _$minimiseItem(contentItem: AbstractContentItem): void;
+    /**
+     * This method is used to get around sandboxed iframe restrictions.
+     * If 'allow-top-navigation' is not specified in the iframe's 'sandbox' attribute
+     * (as is the case with codepens) the parent window is forbidden from calling certain
+     * methods on the child, such as window.close() or setting document.location.href.
+     *
+     * This prevented GoldenLayout popouts from popping in in codepens. The fix is to call
+     * _$closeWindow on the child window's gl instance which (after a timeout to disconnect
+     * the invoking method from the close call) closes itself.
+     */
+    _$closeWindow(): void;
+    _$getArea(x: number, y: number): ItemArea<AbstractContentItem> | null;
+    /**
+     * Creates the drop zones at the edges of the screen
+     */
+    _$createRootItemAreas(): void;
+    _$calculateItemAreas(): void;
+    /**
+     * Takes a contentItem or a configuration and optionally a parent
+     * item and returns an initialised instance of the contentItem.
+     * If the contentItem is a function, it is first called
+     *
+     * @param contentItemOrConfig
+     * @param parent Only necessary when passing in config
+     */
+    _$normalizeContentItem(contentItemOrConfig: {
+        type: ItemConfig['type'];
+    } | ItemConfigType | AbstractContentItem | (() => AbstractContentItem), parent?: AbstractContentItem): AbstractContentItem;
+    /**
+     * Iterates through the array of open popout windows and removes the ones
+     * that are effectively closed. This is necessary due to the lack of reliably
+     * listening for window.close / unload events in a cross browser compatible fashion.
+     */
+    _$reconcilePopoutWindows(): void;
+    /***************************
+     * PRIVATE
+     ***************************/
+    /**
+     * Returns a flattened array of all content items,
+     * regardles of level or type
+     * @return Flattened array of content items
+     */
+    _getAllContentItems(): AbstractContentItem[];
+    /**
+     * Binds to DOM/BOM events on init
+     */
+    _bindEvents(): void;
+    /**
+     * Handles setting a class based on window focus, useful for focus indicators
+     */
+    _windowBlur(): void;
+    _windowFocus(): void;
+    /**
+     * Debounces resize events
+     */
+    _onResize(): void;
+    /**
+     * Extends the default config with the user specific settings and applies
+     * derivations. Please note that there's a seperate method (AbstractContentItem._extendItemNode)
+     * that deals with the extension of item configs
+     *
+     * @param config
+     * @returns config
+     */
+    _createConfig(config: Config): Config;
+    /**
+     * This is executed when GoldenLayout detects that it is run
+     * within a previously opened popout window.
+     */
+    _adjustToWindowMode(): void;
+    /**
+     * Creates Subwindows (if there are any). Throws an error
+     * if popouts are blocked.
+     */
+    _createSubWindows(): void;
+    _getContainer(): JQuery<HTMLElement>;
+    /**
+     * Determines what element the layout will be created in
+     */
+    _setContainer(): void;
+    /**
+     * Kicks of the initial, recursive creation chain
+     *
+     * @param config GoldenLayout Config
+     */
+    _create(config: Config): void;
+    /**
+     * Called when the window is closed or the user navigates away
+     * from the page
+     */
+    _onUnload(): void;
+    /**
+     * Adjusts the number of columns to be lower to fit the screen and still maintain minItemWidth.
+     */
+    _adjustColumnsResponsive(): void;
+    /**
+     * Determines if responsive layout should be used.
+     *
+     * @returns True if responsive layout should be used; otherwise false.
+     */
+    _useResponsiveLayout(): boolean;
+    /**
+     * Adds all children of a node to another container recursively.
+     * @param container - Container to add child content items to.
+     * @param node - Node to search for content items.
+     */
+    _addChildContentItemsToContainer(container: AbstractContentItem, node: AbstractContentItem): void;
+    /**
+     * Finds all the stack containers.
+     * @returns The found stack containers.
+     */
+    _findAllStackContainers(): Stack[];
+    /**
+     * Finds all the stack containers.
+     *
+     * @param stackContainers Set of containers to populate.
+     * @param node Current node to process.
+     */
+    _findAllStackContainersRecursive(stackContainers: Stack[], node: AbstractContentItem): void;
+}
+//# sourceMappingURL=LayoutManager.d.ts.map

package/dist/LayoutManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayoutManager.d.ts","sourceRoot":"","sources":["../src/LayoutManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,KAAK,EACV,UAAU,EACV,MAAM,EACN,eAAe,EACf,cAAc,EACd,oBAAoB,EACrB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EACL,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,mBAAmB,EACnB,QAAQ,EAGR,IAAI,EAEJ,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAGL,YAAY,EACZ,QAAQ,EAKT,MAAM,SAAS,CAAC;AAEjB,oBAAY,oBAAoB,CAC9B,CAAC,SAAS,eAAe,GAAG,oBAAoB,GAAG,eAAe,IAChE;IACF,KAAK,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,YAAY;IACrD;;OAEG;IACH,MAAM,CAAC,IAAI;;;;;;;MAAM;IAEjB;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAI5D;;;;;;OAMG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAI9D,aAAa,UAAS;IACtB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,gBAAgB,CAAqB;IAE7C,OAAO,CAAC,WAAW,CAMiC;IAEpD,OAAO,CAAC,kBAAkB,CAAC,CAEc;IACzC,OAAO,CAAC,UAAU,CAAkB;IACpC,OAAO,CAAC,cAAc,CAAoC;IAC1D,OAAO,CAAC,oBAAoB,CAA8C;IAC1E,OAAO,CAAC,sBAAsB,CAAS;IACvC,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,0BAA0B,CAAS;IAC3C,OAAO,CAAC,UAAU,CAAQ;IAE1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC7B,IAAI,EAAG,IAAI,CAAC;IACZ,WAAW,EAAE,aAAa,EAAE,CAAM;IAClC,YAAY,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IAChD,WAAW,UAAS;IACpB,QAAQ,WAAsB;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/B,OAAO,CAAC,kBAAkB,CAAgD;IAC1E,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IACvD,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IACvD,kBAAkB,sBAAoD;IAEtE,OAAO,CAAC,WAAW,CAEjB;gBAGA,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,SAAS;IAyB1D;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CACf,IAAI,EAAE,MAAM,EACZ,WAAW,EACP,oBAAoB,GACpB,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,yBAAyB,CAAC,GAAG,CAAC;IA4B1C;;;OAGG;IACH,oBAAoB,CAClB,WAAW,EAAE,oBAAoB,GAAG,KAAK,CAAC,yBAAyB,CAAC,GAAG,CAAC;IAK1E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB;IAsFnC;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM;IAIzB;;;;;;OAMG;IACH,oBAAoB;IAIpB;;;;;;;OAOG;IACH,IAAI;IA6CJ;;;;OAIG;IACH,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;IAiB1C;;;OAGG;IACH,OAAO;IAqBP;;;;;;;;;OASG;IACH,iBAAiB,CACf,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG;QAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,EAC/D,MAAM,CAAC,EAAE,mBAAmB;IAiD9B;;;;;;;;;;SAUE;IACF,YAAY,CACV,mBAAmB,EACf,cAAc,GACd,mBAAmB,GACnB,cAAc,EAAE,EACpB,UAAU,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EACzE,QAAQ,CAAC,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,GACrB,aAAa,GAAG,SAAS;IA2F5B;;;;;;;OAOG;IACH,gBAAgB,CACd,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,EAC5B,UAAU,EAAE,eAAe,GAAG,CAAC,MAAM,eAAe,CAAC;IASvD;;;;;OAKG;IACH,yBAAyB,CACvB,UAAU,EAAE,UAAU,GAAG,CAAC,MAAM,UAAU,CAAC,EAC3C,KAAK,EAAE,MAAM,CAAC,cAAc;IAM9B;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,EAAE,OAAO;IAwBxD;;+BAE2B;IAC3B,cAAc,CAAC,WAAW,EAAE,mBAAmB;IAgB/C,cAAc,CAAC,WAAW,EAAE,mBAAmB;IAW/C;;;;;;;;;OASG;IACH,aAAa;IAMb,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAsB9B;;OAEG;IACH,qBAAqB;IAkCrB,oBAAoB;IAyCpB;;;;;;;OAOG;IACH,sBAAsB,CACpB,mBAAmB,EACf;QAAE,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;KAAE,GAC5B,cAAc,GACd,mBAAmB,GACnB,CAAC,MAAM,mBAAmB,CAAC,EAC/B,MAAM,CAAC,EAAE,mBAAmB;IAuB9B;;;;OAIG;IACH,wBAAwB;IAiBxB;;iCAE6B;IAC7B;;;;OAIG;IACH,mBAAmB;IAkBnB;;OAEG;IACH,WAAW;IAUX;;OAEG;IACH,WAAW;IAIX,YAAY;IAIZ;;OAEG;IACH,SAAS;IAKT;;;;;;;OAOG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAiCrC;;;OAGG;IACH,mBAAmB;IAsCnB;;;OAGG;IACH,iBAAiB;IAiBjB,aAAa;IAgBb;;OAEG;IACH,aAAa;IAiBb;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM;IA0BtB;;;OAGG;IACH,SAAS;IAQT;;OAEG;IACH,wBAAwB;IAgDxB;;;;OAIG;IACH,oBAAoB;IAQpB;;;;OAIG;IACH,gCAAgC,CAC9B,SAAS,EAAE,mBAAmB,EAC9B,IAAI,EAAE,mBAAmB;IAc3B;;;OAGG;IACH,uBAAuB;IAOvB;;;;;OAKG;IACH,gCAAgC,CAC9B,eAAe,EAAE,KAAK,EAAE,EACxB,IAAI,EAAE,mBAAmB;CAU5B"}