@joint/core 4.2.0-alpha.0 → 4.2.0-beta.1

package/types/joint.d.ts

@@ -8,6 +8,9 @@ export namespace config {
     var classNamePrefix: string;
     var defaultTheme: string;
     var doubleTapInterval: number;
+    var cellMergeStrategy: util.MergeCustomizer | null;
+    var cellDefaultsMergeStrategy: util.MergeCustomizer | null;
+    var layerAttribute: string;
 }
 
 type NativeEvent = Event;
@@ -151,6 +154,89 @@ export namespace dia {
         util.filter.FilterJSON<'brightness'> |
         util.filter.FilterJSON<'contrast'>;
 
+    class CellCollection<C extends Cell = Cell> extends mvc.Collection<C> {
+
+        cellNamespace: any;
+        layer: GraphLayer;
+
+        minZIndex(): number;
+
+        maxZIndex(): number;
+    }
+
+    class GraphLayerCollection<L extends GraphLayer = GraphLayer> extends mvc.Collection<L> {
+
+        cellNamespace: any;
+        layerNamespace: any;
+        graph: Graph;
+
+        insert(layer: Graph.LayerInit, beforeId: GraphLayer.ID | null, opt?: ObjectHash): void;
+
+        getCell(cellRef: Graph.CellRef): Cell | undefined;
+
+        getCells(): Cell[];
+
+        removeCell(cell: Cell, opt?: ObjectHash): void;
+
+        moveCellBetweenLayers(cell: Cell, targetLayerId: GraphLayer.ID, opt?: ObjectHash): void;
+
+        addCellToLayer(cell: Cell, layerId: GraphLayer.ID, opt?: ObjectHash): void;
+    }
+
+    class GraphLayersController extends mvc.Listener<[]> {
+
+        graph: Graph;
+
+        layerCollection: GraphLayerCollection;
+
+        startListening(): void;
+
+        protected onCellChange(cell: Cell, opt: ObjectHash): void;
+
+        protected onCellRemove(cell: Cell, opt: ObjectHash): void;
+
+        protected onLayerCollectionEvent(eventName: string, ...args: any[]): void;
+
+        protected forwardLayerEvent(...args: any[]): void;
+
+        protected forwardCellEvent(...args: any[]): void;
+
+        protected forwardCellCollectionEvent(...args: any[]): void;
+
+        protected forwardLayerCollectionEvent(...args: any[]): void;
+    }
+
+    class GraphTopologyIndex extends mvc.Listener<[]> {
+
+        layerCollection: GraphLayerCollection;
+
+        startListening(): void;
+
+        getOutboundEdges(id: Cell.ID): { [edgeId: string]: true };
+
+        getInboundEdges(id: Cell.ID): { [edgeId: string]: true };
+
+        getSinkNodes(): string[];
+
+        getSourceNodes(): string[];
+
+        isSinkNode(id: Cell.ID): boolean;
+
+        isSourceNode(id: Cell.ID): boolean;
+
+        protected initializeIndex(): void;
+
+        protected _restructureOnReset(): void;
+
+        protected _restructureOnAdd(cell: Cell): void;
+
+        protected _restructureOnRemove(cell: Cell): void;
+
+        protected _restructureOnChangeSource(cell: Cell): void;
+
+        protected _restructureOnChangeTarget(cell: Cell): void;
+    }
+
     export namespace Graph {
 
         interface Options {
@@ -174,35 +260,100 @@ export namespace dia {
             strict?: boolean;
         }
 
+        interface SyncCellOptions extends Options {
+            remove?: boolean;
+        }
+
+        interface RemoveCellOptions extends Options {
+            disconnectLinks?: boolean;
+            replace?: boolean;
+            clear?: boolean;
+        }
+
         type SearchByKey = 'bbox' | PositionName;
 
         interface FindUnderElementOptions extends FindInAreaOptions, FindAtPointOptions {
             searchBy?: SearchByKey;
         }
 
-        class Cells extends mvc.Collection<Cell> {
-            graph: Graph;
-            cellNamespace: any;
-        }
+        type Cells = CellCollection;
+
+        type CellInit = Cell | Cell.JSON;
+
+        type CellRef = Cell | Cell.ID;
+
+        type LayerInit = GraphLayer | GraphLayer.Attributes;
+
+        type LayerRef = GraphLayer | GraphLayer.ID;
 
         interface Attributes {
-            cells?: Cells;
+            /** @deprecated use cellsCollection property **/
+            cells?: CellCollection;
             [key: string]: any;
         }
+
+        interface JSON {
+            cells: Array<Cell.JSON>;
+            layers?: Array<GraphLayer.Attributes>;
+            defaultLayer?: string;
+            [key: string]: any;
+        }
+
+        interface InsertLayerOptions extends Options {
+            before?: GraphLayer.ID | null;
+            index?: number;
+        }
     }
 
     class Graph<A extends ObjectHash = Graph.Attributes, S = dia.ModelSetOptions> extends mvc.Model<A, S> {
 
-        constructor(attributes?: Graph.Attributes, opt?: { cellNamespace?: any, cellModel?: typeof Cell });
+        layerCollection: GraphLayerCollection;
+
+        defaultLayerId: GraphLayer.ID;
+
+        layersController: GraphLayersController;
+
+        topologyIndex: GraphTopologyIndex;
+
+        constructor(attributes?: Graph.Attributes, opt?: {
+            cellNamespace?: any,
+            layerNamespace?: any,
+            /** @deprecated use cellNamespace instead */
+            cellModel?: typeof Cell
+        });
+
+        addCell(cell: Graph.CellInit, opt?: CollectionAddOptions): this;
+        addCell(cell: Array<Graph.CellInit>, opt?: CollectionAddOptions): this;
+
+        addCells(cells: Array<Graph.CellInit>, opt?: CollectionAddOptions): this;
+
+        removeCell(cell: Graph.CellRef, opt?: Graph.RemoveCellOptions): void;
+
+        removeCells(cells: Array<Graph.CellRef>, opt?: Graph.RemoveCellOptions): this;
 
-        addCell(cell: Cell.JSON | Cell, opt?: CollectionAddOptions): this;
-        addCell(cell: Array<Cell | Cell.JSON>, opt?: CollectionAddOptions): this;
+        resetCells(cells: Array<Graph.CellInit>, opt?: Graph.Options): this;
 
-        addCells(cells: Array<Cell | Cell.JSON>, opt?: CollectionAddOptions): this;
+        syncCells(cells: Array<Graph.CellInit>, opt?: Graph.SyncCellOptions): void;
 
-        resetCells(cells: Array<Cell | Cell.JSON>, opt?: Graph.Options): this;
+        addLayer(layerInit: Graph.LayerInit, opt?: Graph.InsertLayerOptions): void;
 
-        getCell(id: Cell.ID | Cell): Cell;
+        moveLayer(layerRef: Graph.LayerRef, opt?: Graph.InsertLayerOptions): void;
+
+        removeLayer(layerRef: Graph.LayerRef, opt?: Graph.Options): void;
+
+        getDefaultLayer(): GraphLayer;
+
+        setDefaultLayer(id: string, opt?: Graph.Options): void;
+
+        getLayer(id: string): GraphLayer;
+
+        hasLayer(id: string): boolean;
+
+        getLayers(): GraphLayer[];
+
+        getCellLayerId(cell: Graph.CellRef): GraphLayer.ID;
+
+        getCell(id: Graph.CellRef): Cell;
 
         getElements(): Element[];
 
@@ -210,15 +361,15 @@ export namespace dia {
 
         getCells(): Cell[];
 
-        getFirstCell(): Cell | undefined;
+        getFirstCell(layerId?: string): Cell | undefined;
 
-        getLastCell(): Cell | undefined;
+        getLastCell(layerId?: string): Cell | undefined;
 
         getConnectedLinks(cell: Cell, opt?: Graph.ConnectionOptions): Link[];
 
         disconnectLinks(cell: Cell, opt?: S): void;
 
-        removeLinks(cell: Cell, opt?: Cell.DisconnectableOptions): void;
+        removeLinks(cell: Graph.CellRef, opt?: Graph.RemoveCellOptions): void;
 
         translate(tx: number, ty?: number, opt?: Element.TranslateOptions): this;
 
@@ -290,6 +441,12 @@ export namespace dia {
 
         protected _filterCellsUnderElement(cells: Cell[], element: Element, opt: Graph.FindUnderElementOptions): Cell[];
 
+        protected _syncCell(cellInit: Graph.CellInit, opt?: Graph.Options): void;
+
+        protected _replaceCell(currentCell: Cell, newCellInit: Graph.CellInit,  opt?: Graph.Options): void;
+
+        protected _resetLayers(layers: Array<Graph.LayerInit>, defaultLayerId: GraphLayer.ID | null, opt?: Graph.Options): this;
+
         /** @deprecated use `findElementsAtPoint` instead */
         findModelsFromPoint(p: Point): Element[];
 
@@ -305,11 +462,9 @@ export namespace dia {
 
         hasActiveBatch(name?: string | string[]): boolean;
 
-        maxZIndex(): number;
-
-        minZIndex(): number;
+        maxZIndex(layerId?: GraphLayer.ID): number;
 
-        removeCells(cells: Cell[], opt?: Cell.DisconnectableOptions): this;
+        minZIndex(layerId?: GraphLayer.ID): number;
 
         transferCellEmbeds(sourceCell: Cell, targetCell: Cell, opt?: S): void;
 
@@ -368,9 +523,7 @@ export namespace dia {
             deep?: T;
         }
 
-        interface DisconnectableOptions extends Options {
-            disconnectLinks?: boolean;
-        }
+        type DisconnectableOptions = Graph.RemoveCellOptions;
 
         interface GetEmbeddedCellsOptions extends EmbeddableOptions {
             breadthFirst?: boolean;
@@ -450,9 +603,9 @@ export namespace dia {
 
         protected generateId(): string | number;
 
-        protected stopPendingTransitions(path?: string, delim?: string): void;
+        protected stopPendingTransitions(path?: Path, delim?: string): void;
 
-        protected stopScheduledTransitions(path?: string, delim?: string): void;
+        protected stopScheduledTransitions(path?: Path, delim?: string): void;
 
         toJSON(opt?: dia.Cell.ExportOptions): Cell.JSON<any, A>;
 
@@ -490,11 +643,11 @@ export namespace dia {
 
         removeAttr(path: Path, opt?: Cell.Options): this;
 
-        transition(path: string, value?: any, opt?: Cell.TransitionOptions, delim?: string): number;
+        transition(path: Path, value?: any, opt?: Cell.TransitionOptions, delim?: string): number;
 
         getTransitions(): string[];
 
-        stopTransitions(path?: string, delim?: string): this;
+        stopTransitions(path?: Path, delim?: string): this;
 
         embed(cell: Cell | Cell[], opt?: Cell.EmbedOptions): this;
 
@@ -518,6 +671,9 @@ export namespace dia {
 
         z(): number;
 
+        layer(): string | null;
+        layer(id: string | null, opt?: Graph.Options): this;
+
         angle(): number;
 
         getBBox(): g.Rect;
@@ -539,6 +695,8 @@ export namespace dia {
 
         static define(type: string, defaults?: any, protoProps?: any, staticProps?: any): Cell.Constructor<Cell>;
 
+        static getAttributeDefinition(attrName: string): Cell.PresentationAttributeDefinition<CellView> | null;
+
         /**
          * @deprecated
          */
@@ -563,24 +721,40 @@ export namespace dia {
         interface Attributes extends GenericAttributes<Cell.Selectors> {
         }
 
-        type PortPositionCallback = (ports: Port[], bbox: g.Rect) => dia.Point[];
+        interface ConstructorOptions extends Cell.ConstructorOptions {
+            portLayoutNamespace?: { [key: string]: layout.Port.LayoutFunction };
+            portLabelLayoutNamespace?: { [key: string]: layout.PortLabel.LayoutFunction };
+        }
+
+        type PortPositionCallback = layout.Port.LayoutFunction;
+
+        type PortLabelPositionCallback = layout.PortLabel.LayoutFunction;
 
         interface PortPositionJSON {
             name?: string;
-            args?: { [key: string]: any };
+            args?: layout.Port.Options;
+        }
+
+        interface PortLabelPositionJSON {
+            name?: string;
+            args?: layout.PortLabel.Options;
         }
 
         type PositionType = string | PortPositionCallback | PortPositionJSON;
 
+        type PortLabelPositionType = PortLabelPositionCallback | PortPositionJSON;
+
         interface PortGroup {
             position?: PositionType;
             markup?: string | MarkupJSON;
             attrs?: Cell.Selectors;
             size?: Size;
-            label?: {
-                markup?: string | MarkupJSON;
-                position?: PositionType;
-            };
+            label?: PortLabel;
+        }
+
+        interface PortLabel {
+            markup?: string | MarkupJSON;
+            position?: PortLabelPositionType;
         }
 
         interface Port {
@@ -589,14 +763,12 @@ export namespace dia {
             group?: string;
             attrs?: Cell.Selectors;
             position?: {
-                args?: { [key: string]: any };
+                args?: layout.Port.Options;
             };
-            args?: { [key: string]: any };
+            /** @deprecated use `position.args` instead */
+            args?: layout.Port.Options;
             size?: Size;
-            label?: {
-                markup?: string | MarkupJSON;
-                position?: PositionType;
-            };
+            label?: PortLabel;
             z?: number | 'auto';
         }
 
@@ -626,13 +798,13 @@ export namespace dia {
             filter?: (cell: Cell) => boolean;
             deep?: boolean;
             padding?: Padding;
-            minRect?: g.Rect;
+            minRect?: Partial<BBox>;
             expandOnly?: boolean;
             shrinkOnly?: boolean;
         }
 
         interface FitParentOptions extends FitToChildrenOptions {
-            terminator?: Cell | Cell.ID;
+            terminator?: Graph.CellRef;
         }
 
         interface RotateOptions {
@@ -646,6 +818,8 @@ export namespace dia {
 
     class Element<A extends ObjectHash = Element.Attributes, S extends mvc.ModelSetOptions = dia.ModelSetOptions> extends Cell<A, S> {
 
+        constructor(attributes?: DeepPartial<A>, opt?: Element.ConstructorOptions);
+
         translate(tx: number, ty?: number, opt?: Element.TranslateOptions): this;
 
         position(opt?: Element.PositionOptions): g.Point;
@@ -1357,44 +1531,105 @@ export namespace dia {
         }
 
         enum Layers {
-            CELLS = 'cells',
             LABELS = 'labels',
             BACK = 'back',
             FRONT = 'front',
+            /** @deprecated */
+            CELLS = 'cells',
             TOOLS = 'tools',
             GRID = 'grid',
         }
 
-        type UpdateStats = {
+        type LayerRef = Layers | string | dia.LayerView | dia.GraphLayer;
+
+        interface RenderStats {
             priority: number;
             updated: number;
-            empty?: boolean;
-            postponed?: number;
-            unmounted?: number;
-            mounted?: number;
+        }
+
+        interface UpdateVisibilityStats {
+            mounted: number;
+            unmounted: number;
+        }
+
+        interface RenderBatchStats extends RenderStats, UpdateVisibilityStats {
+            postponed: number;
+            empty: boolean;
+        }
+
+        type UpdateStats = RenderStats & Partial<RenderBatchStats> & {
             batches?: number;
         };
 
         type ViewportCallback = (view: mvc.View<any, any>, isMounted: boolean, paper: Paper) => boolean;
+        type CellVisibilityCallback = (cell: Cell, isMounted: boolean, paper: Paper) => boolean;
         type ProgressCallback = (done: boolean, processed: number, total: number, stats: UpdateStats, paper: Paper) => void;
         type BeforeRenderCallback = (opt: { [key: string]: any }, paper: Paper) => void;
         type AfterRenderCallback = (stats: UpdateStats, opt: { [key: string]: any }, paper: Paper) => void;
 
-        interface FreezeOptions {
-            key?: string;
+        interface CellVisibilityOptions {
+            cellVisibility?: CellVisibilityCallback | null;
+
+            /** @deprecated disable `legacyMode` and use `cellVisibility` instead */
+            viewport?: ViewportCallback | null;
         }
 
-        interface UnfreezeOptions {
-            key?: string;
+        interface MountOptions {
             mountBatchSize?: number;
+        }
+
+        interface UnmountOptions {
             unmountBatchSize?: number;
+        }
+
+        interface BatchSizeOptions {
             batchSize?: number;
-            viewport?: ViewportCallback;
-            progress?: ProgressCallback;
+        }
+
+        interface BeforeRenderOptions {
             beforeRender?: BeforeRenderCallback;
+        }
+
+        interface AfterRenderOptions {
             afterRender?: AfterRenderCallback;
         }
 
+        interface RenderCallbackOptions extends BeforeRenderOptions, AfterRenderOptions, mvc.Silenceable {
+
+        }
+
+        interface KeyOptions {
+            key?: string;
+        }
+
+        interface UpdateViewOptions {
+            [key: string]: any;
+        }
+
+        interface UpdateViewsBatchOptions extends UpdateViewOptions, BatchSizeOptions, CellVisibilityOptions {
+
+        }
+
+        interface UpdateViewsOptions extends UpdateViewsBatchOptions, RenderCallbackOptions {
+
+        }
+
+        interface UpdateViewsAsyncOptions extends UpdateViewsBatchOptions, ScheduleCellsVisibilityUpdateOptions, RenderCallbackOptions {
+            progress?: ProgressCallback;
+        }
+
+        interface ScheduleCellsVisibilityUpdateOptions extends CellVisibilityOptions, MountOptions, UnmountOptions {
+
+        }
+
+        interface FreezeOptions extends KeyOptions {
+
+        }
+
+        interface UnfreezeOptions extends KeyOptions, UpdateViewsAsyncOptions, UpdateViewsOptions {
+
+        }
+
         interface SnapLinksOptions {
             radius?: number;
             findInAreaOptions?: FindInAreaOptions;
@@ -1406,7 +1641,7 @@ export namespace dia {
         type FindParentByCallback = ((this: dia.Graph, elementView: ElementView, evt: dia.Event, x: number, y: number) => Cell[]);
         type MeasureNodeCallback = (node: SVGGraphicsElement, cellView: dia.CellView) => g.Rect;
 
-        interface Options extends mvc.ViewOptions<Graph> {
+        interface Options extends mvc.ViewOptions<Graph>, CellVisibilityOptions, BeforeRenderOptions, AfterRenderOptions {
             // appearance
             width?: Dimension;
             height?: Dimension;
@@ -1449,6 +1684,7 @@ export namespace dia {
             validateUnembedding?: (this: Paper, childView: ElementView) => boolean;
             // default views, models & attributes
             cellViewNamespace?: any;
+            layerViewNamespace?: any;
             routerNamespace?: any;
             connectorNamespace?: any;
             highlighterNamespace?: any;
@@ -1468,14 +1704,17 @@ export namespace dia {
             sorting?: sorting;
             frozen?: boolean;
             autoFreeze?: boolean;
-            viewport?: ViewportCallback | null;
+            viewManagement?: ViewManagementOptions | boolean;
             onViewUpdate?: (view: mvc.View<any, any>, flag: number, priority: number, opt: { [key: string]: any }, paper: Paper) => void;
             onViewPostponed?: (view: mvc.View<any, any>, flag: number, paper: Paper) => boolean;
-            beforeRender?: Paper.BeforeRenderCallback;
-            afterRender?: Paper.AfterRenderCallback;
             overflow?: boolean;
         }
 
+        interface ViewManagementOptions {
+            lazyInitialize?: boolean;
+            disposeHidden?: boolean;
+        }
+
         interface TransformToFitContentOptions {
             padding?: Padding;
             preserveAspectRatio?: boolean;
@@ -1608,6 +1847,22 @@ export namespace dia {
 
         interface FindInAreaOptions extends Graph.FindInAreaOptions, BufferOptions {
         }
+
+        interface FindClosestMagnetToPointOptions {
+            radius?: number;
+            findInAreaOptions?: FindInAreaOptions;
+            filter?: (view: CellView, magnet: SVGElement) => boolean;
+        }
+
+        interface ClosestMagnet {
+            view: CellView;
+            magnet: SVGElement;
+        }
+
+        interface InsertLayerViewOptions {
+            before?: LayerRef | null;
+            index?: number;
+        }
     }
 
     class Paper extends mvc.View<Graph> {
@@ -1620,10 +1875,14 @@ export namespace dia {
 
         svg: SVGSVGElement;
         defs: SVGDefsElement;
+
+        /** @deprecated use getLayerViewNode()*/
         cells: SVGGElement;
+        /** @deprecated use layers property*/
+        viewport: SVGGElement;
+
         tools: SVGGElement;
         layers: SVGGElement;
-        viewport: SVGGElement;
 
         GUARDED_TAG_NAMES: string[];
         FORM_CONTROLS_TAG_NAMES: string[];
@@ -1699,7 +1958,7 @@ export namespace dia {
 
         findView<T extends ElementView | LinkView>(element: mvc.$SVGElement): T;
 
-        findViewByModel<T extends ElementView | LinkView>(model: Cell | Cell.ID): T;
+        findViewByModel<T extends ElementView | LinkView>(model: Graph.CellRef): T;
 
         /**
          * Finds all the element views at the specified point
@@ -1743,6 +2002,13 @@ export namespace dia {
          */
         findCellViewsInArea(area: BBox, opt?: Paper.FindInAreaOptions): CellView[];
 
+        /**
+         * Finds the closest magnet to the specified point
+         * @param point a point in local paper coordinates
+         * @param opt options for the search
+         */
+        findClosestMagnetToPoint(point: Point, opt?: Paper.FindClosestMagnetToPointOptions): Paper.ClosestMagnet | null;
+
         fitToContent(opt?: Paper.FitToContentOptions): g.Rect;
         fitToContent(gridWidth?: number, gridHeight?: number, padding?: number, opt?: any): g.Rect;
 
@@ -1754,7 +2020,7 @@ export namespace dia {
 
         getDefaultLink(cellView: CellView, magnet: SVGElement): Link;
 
-        getModelById(id: Cell.ID | Cell): Cell;
+        getModelById(id: Graph.CellRef): Cell;
 
         setDimensions(width: Paper.Dimension, height: Paper.Dimension, data?: any): void;
 
@@ -1790,29 +2056,38 @@ export namespace dia {
 
         // layers
 
-        getLayerNode(layerName: Paper.Layers | string): SVGGElement;
+        getLayerView(layerRef: Paper.LayerRef): LayerView;
+        getLayerView(layer: GraphLayer): GraphLayerView;
 
-        getLayerView(layerName: Paper.Layers | string): PaperLayer;
+        hasLayerView(layerRef: Paper.LayerRef): boolean;
 
-        hasLayerView(layerName: Paper.Layers | string): boolean;
+        getLayerViews(): Array<LayerView>;
 
-        renderLayers(layers: Array<{ name: string }>): void;
+        getGraphLayerViews(): Array<GraphLayerView>;
 
-        protected removeLayers(): void;
+        addLayerView(layerView: LayerView, options?: Paper.InsertLayerViewOptions): void;
 
-        protected resetLayers(): void;
+        moveLayerView(layerRef: Paper.LayerRef, options?: Paper.InsertLayerViewOptions): void;
 
-        addLayer(layerName: string, layerView: PaperLayer, options?: { insertBefore?: string }): void;
+        removeLayerView(layerRef: Paper.LayerRef): void;
 
-        removeLayer(layer: string | PaperLayer): void;
+        protected insertLayerView(layerView: LayerView, before?: Paper.LayerRef): void;
 
-        moveLayer(layer: string | PaperLayer, insertBefore: string | PaperLayer | null): void;
+        protected requestLayerViewRemoval(layerRef: Paper.LayerRef): void;
 
-        hasLayer(layer: string | PaperLayer): boolean;
+        protected createLayerView(options: Omit<LayerView.Options, 'paper'>): LayerView;
 
-        getLayerNames(): string[];
+        protected getLayerViewOrder(): string[];
 
-        getLayers(): Array<PaperLayer>;
+        protected renderLayerViews(): void;
+
+        protected renderImplicitLayerViews(): void;
+
+        protected renderGraphLayerViews(): void;
+
+        protected removeLayerViews(): void;
+
+        protected resetLayerViews(): void;
 
         // rendering
 
@@ -1820,39 +2095,33 @@ export namespace dia {
 
         unfreeze(opt?: Paper.UnfreezeOptions): void;
 
+        wakeUp(): void;
+
         isFrozen(): boolean;
 
         requestViewUpdate(view: mvc.View<any, any>, flag: number, priority: number, opt?: { [key: string]: any }): void;
 
-        requireView<T extends ElementView | LinkView>(model: Cell | Cell.ID, opt?: dia.Cell.Options): T;
-
-        dumpViews(opt?: {
-            batchSize?: number;
-            mountBatchSize?: number;
-            unmountBatchSize?: number;
-            viewport?: Paper.ViewportCallback;
-        }): void;
+        requestCellViewInsertion(cell: Graph.CellRef, opt?: { [key: string]: any }): void;
 
-        checkViewport(opt?: {
-            mountBatchSize?: number;
-            unmountBatchSize?: number;
-            viewport?: Paper.ViewportCallback;
-        }): {
-            mounted: number;
-            unmounted: number;
-        };
+        requireView<T extends ElementView | LinkView>(cellOrId: Graph.CellRef, opt?: Paper.UpdateViewOptions & Paper.RenderCallbackOptions): T;
 
-        updateViews(opt?: {
-            batchSize?: number;
-            viewport?: Paper.ViewportCallback;
-        }): {
-            updated: number;
-            batches: number;
-            priority: number;
-        };
+        updateViews(opt?: Paper.UpdateViewsOptions): Paper.RenderStats & { batches: number };
 
         hasScheduledUpdates(): boolean;
 
+        disposeHiddenCellViews(): void;
+
+        isCellVisible(cellOrId: Graph.CellRef): boolean;
+
+        updateCellVisibility(
+            cell: Graph.CellRef,
+            opt?: Paper.CellVisibilityOptions & Paper.UpdateViewOptions & Paper.RenderCallbackOptions
+        ): void;
+
+        updateCellsVisibility(
+            opt?: Paper.ScheduleCellsVisibilityUpdateOptions & Paper.UpdateViewsOptions
+        ): void;
+
         // events
 
         on<T extends keyof Paper.EventMap = keyof Paper.EventMap>(eventName: T, callback: Paper.EventMap[T], context?: any): this;
@@ -1862,52 +2131,51 @@ export namespace dia {
         // protected
 
         /**
-        * For the specified view, calls the visibility viewport function specified by the paper.options.viewport function.
+        * For the specified view, calls the cell visibility function specified by the `paper.options.cellVisibility` function.
         * If the function returns true, the view is attached to the DOM; in other case it is detached.
-        * While async papers do this automatically, synchronous papers require an explicit call to this method for this functionality to be applied. To show the view again, use paper.requestView().
-        * If you are using autoFreeze option you should call this function if you are calling paper.requestView() if you want paper.options.viewport function to be applied.
+        * While async papers do this automatically, synchronous papers require an explicit call to this method for this functionality to be applied. To show the view again, use `paper.requestView()`.
+        * If you are using `autoFreeze` option you should call this function if you are calling `paper.requestView()` if you want `paper.options.cellVisibility` function to be applied.
         * @param cellView cellView for which the visibility check is performed
-        * @param opt if opt.viewport is provided, it is used as the callback function instead of paper.options.viewport.
+        * @param opt if opt.cellVisibility is provided, it is used as the callback function instead of paper.options.cellVisibility.
         */
-        protected checkViewVisibility(cellView: dia.CellView, opt?: {
-            viewport?: Paper.ViewportCallback;
-        }): {
-            mounted: number;
-            unmounted: number;
-        };
+        protected checkViewVisibility(
+            cellView: dia.CellView,
+            opt?: Paper.CellVisibilityOptions
+        ): Paper.UpdateVisibilityStats;
+
+
+        protected scheduleCellsVisibilityUpdate(opt?: Paper.ScheduleCellsVisibilityUpdateOptions): Paper.UpdateVisibilityStats;
 
         protected scheduleViewUpdate(view: mvc.View<any, any>, flag: number, priority: number, opt?: { [key: string]: any }): void;
 
         protected dumpViewUpdate(view: mvc.View<any, any>): number;
 
-        protected dumpView(view: mvc.View<any, any>, opt?: { [key: string]: any }): number;
+        protected dumpView(view: mvc.View<any, any>, opt?: Paper.UpdateViewOptions & Paper.RenderCallbackOptions): number;
 
-        protected updateView(view: mvc.View<any, any>, flag: number, opt?: { [key: string]: any }): number;
+        protected updateView(view: mvc.View<any, any>, flag: number, opt?: Paper.UpdateViewOptions): number;
 
         protected registerUnmountedView(view: mvc.View<any, any>): number;
 
         protected registerMountedView(view: mvc.View<any, any>): number;
 
-        protected updateViewsAsync(opt?: {
-            batchSize?: number;
-            mountBatchSize?: number;
-            unmountBatchSize?: number;
-            viewport?: Paper.ViewportCallback;
-            progress?: Paper.ProgressCallback;
-            before?: Paper.BeforeRenderCallback;
-        }): void;
+        protected updateViewsAsync(opt?: Paper.UpdateViewsAsyncOptions): void;
 
-        protected updateViewsBatch(opt?: {
-            batchSize?: number;
-            viewport?: Paper.ViewportCallback;
-        }): Paper.UpdateStats;
+        protected updateViewsBatch(opt?: Paper.UpdateViewsBatchOptions): Paper.RenderBatchStats;
+
+        protected checkMountedViews(viewport: Paper.ViewportCallback, opt?: Paper.UnmountOptions): number;
 
-        protected checkMountedViews(viewport: Paper.ViewportCallback, opt?: { unmountBatchSize?: number }): number;
+        protected checkUnmountedViews(viewport: Paper.ViewportCallback, opt?: Paper.MountOptions): number;
 
-        protected checkUnmountedViews(viewport: Paper.ViewportCallback, opt?: { mountBatchSize?: number }): number;
+        protected prioritizeCellViewMount(cellOrId: Graph.CellRef): boolean;
+
+        protected prioritizeCellViewUnmount(cellOrId: Graph.CellRef): boolean;
+
+        protected isViewMounted(viewOrCid: dia.CellView | string): boolean;
 
         protected isAsync(): boolean;
 
+        protected isIdle(): boolean;
+
         protected isExactSorting(): boolean;
 
         protected sortViews(): void;
@@ -1961,6 +2229,14 @@ export namespace dia {
         protected onCellChanged(cell: Cell, opt: dia.Cell.Options): void;
         protected onCellChanged(cell: mvc.Collection<Cell>, opt: dia.Graph.Options): void;
 
+        protected onGraphLayerAdd(layer: GraphLayer, collection: mvc.Collection<GraphLayer>, opt: dia.Graph.Options): void;
+
+        protected onGraphLayerRemove(layer: GraphLayer, collection: mvc.Collection<GraphLayer>, opt: dia.Graph.Options): void;
+
+        protected onGraphLayerCollectionReset(layer: mvc.Collection<GraphLayer>, opt: dia.Graph.Options): void;
+
+        protected onGraphLayerCollectionSort(layer: GraphLayer[]): void;
+
         protected onGraphReset(cells: mvc.Collection<Cell>, opt: dia.Graph.Options): void;
 
         protected onGraphSort(): void;
@@ -1983,12 +2259,19 @@ export namespace dia {
 
         protected insertView(cellView: CellView, isInitialInsert: boolean): void;
 
-        protected detachView(cellView: CellView): void;
+        protected _hideCellView(cellView: CellView): void;
+
+        protected _detachCellView(cellView: CellView): void;
 
         protected customEventTrigger(event: dia.Event, view: CellView, rootNode?: SVGElement): dia.Event | null;
 
         protected addStylesheet(stylesheet: string): void;
 
+        /**
+         * @deprecated use `getLayerView(id).el` instead
+         * **/
+        getLayerNode(id: Paper.Layers | string): SVGElement;
+
         /**
          * @deprecated use `findElementViewsAtPoint()
          */
@@ -2003,19 +2286,32 @@ export namespace dia {
          * @deprecated use transformToFitContent
          */
         scaleContentToFit(opt?: Paper.ScaleContentOptions): void;
+
+        /**
+         * @deprecated Use `updateCellsVisibility()`
+         */
+        checkViewport(opt?: Paper.ScheduleCellsVisibilityUpdateOptions): Paper.UpdateVisibilityStats;
+
+        /**
+         * @deprecated Use `updateCellsVisibility()`
+         */
+        dumpViews(opt?: Paper.ScheduleCellsVisibilityUpdateOptions & Paper.UpdateViewsOptions): void;
     }
 
-    namespace PaperLayer {
+    namespace LayerView {
 
-        interface Options extends mvc.ViewOptions<undefined, SVGElement> {
-            name: string;
+        interface Options<T extends mvc.Model | undefined = undefined> extends mvc.ViewOptions<T, SVGElement> {
+            id: string;
+            paper: Paper;
+            type?: string;
         }
     }
-    class PaperLayer extends mvc.View<undefined, SVGElement> {
 
-        constructor(opt?: PaperLayer.Options);
+    class LayerView<T extends mvc.Model | undefined = undefined> extends mvc.View<T, SVGElement> {
+
+        constructor(opt?: LayerView.Options);
 
-        options: PaperLayer.Options;
+        options: LayerView.Options;
 
         pivotNodes: { [z: number]: Comment };
 
@@ -2025,7 +2321,78 @@ export namespace dia {
 
         insertPivot(z: number): Comment;
 
-        removePivots(): void;
+        isEmpty(): boolean;
+
+        reset(): void;
+
+        setPaperReference(paper: Paper): void;
+
+        unsetPaperReference(): void;
+
+        protected removePivots(): void;
+
+        protected afterPaperReferenceSet(paper: Paper): void;
+
+        protected beforePaperReferenceUnset(paper: Paper): void;
+
+        protected assertPaperReferenceSet(): void;
+    }
+
+    namespace GraphLayer {
+
+        type ID = string;
+
+        interface Attributes extends mvc.ObjectHash {
+            id: ID;
+            type?: string;
+        }
+    }
+
+    class GraphLayer<C extends CellCollection = CellCollection, A extends GraphLayer.Attributes = GraphLayer.Attributes, S extends mvc.ModelSetOptions = dia.ModelSetOptions> extends mvc.Model<A, S> {
+
+        declare id: string;
+
+        cellCollection: C;
+        graph: Graph | null;
+
+        constructor(attributes?: DeepPartial<A>, options?: mvc.ModelConstructorOptions<GraphLayer>);
+
+        getCells(): Cell[];
+    }
+
+    class GraphLayerView<T extends GraphLayer = GraphLayer> extends LayerView<T> {
+
+        sort(): void;
+
+        sortExact(): void;
+
+        insertCellView(cellView: CellView): void;
+
+        protected onCellMove(cell: Cell, opt: Graph.Options): void;
+
+        protected onCellChange(cell: Cell, opt: Cell.Options): void;
+
+        protected onCellCollectionSort(collection: CellCollection, opt: Graph.Options): void;
+
+        protected onGraphBatchStop(data: any): void;
+    }
+
+    namespace GridLayerView {
+
+        interface Options extends LayerView.Options {
+            patterns?: Record<string, Paper.GridOptions[]>;
+        }
+    }
+
+    class GridLayerView extends LayerView {
+
+        setGrid(opt?: null | boolean | string | Paper.GridOptions | Paper.GridOptions[]): void;
+
+        renderGrid(): void;
+
+        updateGrid(): void;
+
+        removeGrid(): void;
     }
 
     namespace ToolsView {
@@ -2061,6 +2428,10 @@ export namespace dia {
         hide(): this;
 
         mount(): this;
+
+        getLayer(): string | null;
+
+        hasLayer(): boolean;
     }
 
     namespace ToolView {
@@ -2104,6 +2475,8 @@ export namespace dia {
 
         update(): void;
 
+        isOverlay(): boolean;
+
         protected guard(evt: dia.Event): boolean;
     }
 
@@ -2195,6 +2568,8 @@ export namespace dia {
             id?: string
         ): T[];
 
+        static has(cellView: dia.CellView, id?: string): boolean;
+
         static update(cellView: dia.CellView, id?: string): void;
 
         static transform(cellView: dia.CellView, id?: string): void;
@@ -2327,7 +2702,7 @@ export namespace highlighters {
             position?: Positions | dia.PositionName;
             size?: number | dia.Size;
             gap?: number;
-            margin?: number | dia.Sides;
+            margin?: dia.Sides;
         }
     }
 
@@ -2677,7 +3052,7 @@ export namespace util {
     export function isPercentage(val: any): boolean;
 
     export function parseCssNumeric(val: any, restrictUnits: string | string[]): { value: number, unit?: string } | null;
-    
+
     type BreakTextOptions = {
         svgDocument?: SVGElement;
         separator?: string | any;
@@ -2687,7 +3062,7 @@ export namespace util {
         maxLineCount?: number;
         preserveSpaces?: boolean;
     }
-    
+
     type BreakTextFunction = (
         text: string,
         size: { width: number, height?: number },
@@ -2953,6 +3328,8 @@ export namespace util {
 
     export function merge(destinationObject: object, ...args: any[]): object;
 
+    type MergeCustomizer = (value: any, srcValue: any, key: string, object: any, source: any, stack: any) => any;
+
     // ADDITIONAL SIMPLE UTIL FUNCTIONS:
 
     export function isBoolean(value: any): boolean;
@@ -2992,7 +3369,7 @@ export namespace layout {
             angle: number;
         };
 
-        type LayoutFunction = (ports: Array<Object>, elBBox: g.Rect, opt: Options) => Array<Transformation>;
+        type LayoutFunction = (ports: Array<dia.Element.Port>, elBBox: g.Rect, opt: Options) => Array<Transformation>;
 
         interface Options {
             x?: number | string;
@@ -3005,9 +3382,11 @@ export namespace layout {
             startAngle?: number;
             step?: number;
             compensateRotation?: boolean;
+            [key: string]: any;
         }
 
         export var absolute: LayoutFunction;
+        /** @deprecated */
         export var fn: LayoutFunction;
         export var line: LayoutFunction;
         export var left: LayoutFunction;
@@ -3026,6 +3405,7 @@ export namespace layout {
             angle?: number;
             offset?: number;
             attrs?: dia.Cell.Selectors;
+            [key: string]: any;
         }
 
         interface LabelAttributes {
@@ -3172,6 +3552,7 @@ export namespace mvc {
 
     interface ModelConstructorOptions<TModel extends Model = Model> extends ModelSetOptions, Parseable {
         collection?: Collection<TModel> | undefined;
+        eventPrefix?: string | undefined;
     }
 
     type CombinedModelConstructorOptions<E, M extends Model<any, any, E> = Model> = ModelConstructorOptions<M> & E;
@@ -3460,6 +3841,7 @@ export namespace mvc {
         collection?: Collection<any> | undefined; // was: Collection<TModel>;
         el?: $Element<TElement> | string | undefined;
         id?: string | undefined;
+        cid?: string | undefined;
         attributes?: Record<string, any> | undefined;
         className?: string | undefined;
         tagName?: string | undefined;
@@ -3502,9 +3884,9 @@ export namespace mvc {
 
         el: TElement;
         attributes: Record<string, any>;
-        /* @deprecated use `el` instead */
+        /** @deprecated use `el` instead */
         $el: Dom;
-        /* @deprecated use `el.querySelector()` instead */
+        /** @deprecated use `el.querySelector()` instead */
         $(selector: string): Dom;
         render(): this;
         remove(): this;
@@ -3857,7 +4239,8 @@ export namespace anchors {
     }
 
     interface MidSideAnchorArguments extends RotateAnchorArguments, PaddingAnchorArguments {
-
+        mode?: 'prefer-horizontal' | 'prefer-vertical' | 'horizontal' | 'vertical' | 'auto';
+        preferenceThreshold?: dia.Sides;
     }
 
     interface ModelCenterAnchorArguments {
@@ -4415,7 +4798,7 @@ export namespace elementTools {
 
     namespace Boundary {
         interface Options extends dia.ToolView.Options<dia.ElementView> {
-            padding?: number | dia.Sides;
+            padding?: dia.Sides;
             useModelGeometry?: boolean;
             rotate?: boolean;
         }
@@ -4658,7 +5041,7 @@ export namespace linkTools {
 
     namespace Boundary {
         interface Options extends dia.ToolView.Options<dia.LinkView> {
-            padding?: number | dia.Sides;
+            padding?: dia.Sides;
             useModelGeometry?: boolean;
         }
     }