@jbrowse/plugin-linear-genome-view 1.7.0 → 1.7.4

package/dist/BaseLinearDisplay/models/BaseLinearDisplayModel.d.ts

@@ -1,230 +1,227 @@
-import React from 'react';
-import { MenuItem } from '@jbrowse/core/ui';
-import { Stats } from '@jbrowse/core/data_adapters/BaseAdapter';
-import { BaseBlock } from '@jbrowse/core/util/blockTypes';
-import { Region } from '@jbrowse/core/util/types';
-import CompositeMap from '@jbrowse/core/util/compositeMap';
-import { Feature } from '@jbrowse/core/util/simpleFeature';
-import { Instance } from 'mobx-state-tree';
-import { ExportSvgOptions } from '../../LinearGenomeView';
-export interface Layout {
-    minX: number;
-    minY: number;
-    maxX: number;
-    maxY: number;
-    name: string;
-}
-declare type LayoutRecord = [number, number, number, number];
-export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
-    id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-    type: import("mobx-state-tree").ISimpleType<string>;
-    rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-} & {
-    height: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<number>, [undefined]>;
-    blockState: import("mobx-state-tree").IMapType<import("mobx-state-tree").IModelType<{
-        key: import("mobx-state-tree").ISimpleType<string>;
-        region: import("mobx-state-tree").IModelType<{
-            refName: import("mobx-state-tree").ISimpleType<string>;
-            start: import("mobx-state-tree").ISimpleType<number>;
-            end: import("mobx-state-tree").ISimpleType<number>;
-            reversed: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<boolean>, [undefined]>;
-        } & {
-            assemblyName: import("mobx-state-tree").ISimpleType<string>;
-        }, {
-            setRefName(newRefName: string): void;
-        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
-        reloadFlag: import("mobx-state-tree").IType<number | undefined, number, number>;
-        isLeftEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
-        isRightEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
-    }, {
-        renderInProgress: AbortController | undefined;
-        filled: boolean;
-        reactElement: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)> | undefined;
-        features: Map<string, Feature> | undefined;
-        layout: any;
-        status: string;
-        error: unknown;
-        message: string | undefined;
-        maxHeightReached: boolean;
-        ReactComponent: ({ model, }: {
-            model: any;
-        }) => any;
-        renderProps: any;
-    } & {
-        doReload(): void;
-        afterAttach(): void;
-        setStatus(message: string): void;
-        setLoading(abortController: AbortController): void;
-        setMessage(messageText: string): void;
-        setRendered(props: {
-            reactElement: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)>;
-            features: Map<string, Feature>;
-            layout: any;
-            maxHeightReached: boolean;
-            renderProps: any;
-        } | undefined): void; /**
-         * a CompositeMap of `featureId -> feature obj` that
-         * just looks in all the block data for that feature
-         */
-        setError(error: unknown): void;
-        reload(): void;
-        beforeDestroy(): void;
-    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
-    userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
-    userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
-}, {
-    rendererTypeName: string;
-    error: unknown;
-} & {
-    readonly RenderingComponent: React.FC<{
-        model: import("mobx-state-tree").ModelInstanceTypeProps<{
-            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-            type: import("mobx-state-tree").ISimpleType<string>;
-            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-        }> & {
-            rendererTypeName: string;
-            error: unknown;
-        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
-            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-            type: import("mobx-state-tree").ISimpleType<string>;
-            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-        }, {
-            rendererTypeName: string;
-            error: unknown;
-        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
-        onHorizontalScroll?: Function | undefined;
-        blockState?: Record<string, any> | undefined;
-    }>;
-    readonly DisplayBlurb: React.FC<{
-        model: import("mobx-state-tree").ModelInstanceTypeProps<{
-            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-            type: import("mobx-state-tree").ISimpleType<string>;
-            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-        }> & {
-            rendererTypeName: string;
-            error: unknown;
-        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
-            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
-            type: import("mobx-state-tree").ISimpleType<string>;
-            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-        }, {
-            rendererTypeName: string;
-            error: unknown;
-        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
-    }> | null;
-    readonly adapterConfig: any;
-    readonly parentTrack: any;
-    renderProps(): any;
-    readonly rendererType: any;
-    readonly DisplayMessageComponent: React.FC<any> | undefined;
-    trackMenuItems(): MenuItem[];
-    readonly viewMenuActions: MenuItem[];
-    regionCannotBeRendered(): undefined;
-} & {
-    setError(error?: unknown): void;
-    setRpcDriverName(rpcDriverName: string): void;
-    reload(): void;
-} & {
-    currBpPerPx: number;
-    message: string;
-    featureIdUnderMouse: string | undefined;
-    contextMenuFeature: Feature | undefined;
-    scrollTop: number;
-    estimatedRegionStatsP: Promise<Stats> | undefined;
-    estimatedRegionStats: Stats | undefined;
-} & {
-    readonly blockType: "staticBlocks" | "dynamicBlocks";
-    readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
-} & {
-    /**
-     * how many milliseconds to wait for the display to
-     * "settle" before re-rendering a block
-     */
-    readonly renderDelay: number;
-    readonly TooltipComponent: React.FC<any>;
-    /**
-     * returns a string feature ID if the globally-selected object
-     * is probably a feature
-     */
-    readonly selectedFeatureId: string | undefined;
-    /**
-     * if a display-level message should be displayed instead of the blocks,
-     * make this return a react component
-     */
-    readonly DisplayMessageComponent: React.FC<any> | undefined;
-} & {
-    /**
-     * a CompositeMap of `featureId -> feature obj` that
-     * just looks in all the block data for that feature
-     */
-    readonly features: CompositeMap<string, Feature>;
-    readonly featureUnderMouse: Feature | undefined;
-    getFeatureOverlapping(blockKey: string, x: number, y: number): any;
-    getFeatureByID(blockKey: string, id: string): LayoutRecord | undefined;
-    searchFeatureByID(id: string): LayoutRecord | undefined;
-    readonly currentBytesRequested: number;
-    readonly currentFeatureScreenDensity: number;
-    readonly maxFeatureScreenDensity: any;
-    readonly estimatedStatsReady: boolean;
-    readonly maxAllowableBytes: number;
-} & {
-    setMessage(message: string): void;
-    afterAttach(): void;
-    estimateRegionsStats(regions: Region[], opts: {
-        headers?: Record<string, string>;
-        signal?: AbortSignal;
-        filters?: string[];
-    }): Promise<Stats>;
-    setRegionStatsP(p?: Promise<Stats> | undefined): void;
-    setRegionStats(estimatedRegionStats?: Stats | undefined): void;
-    clearRegionStats(): void;
-    setHeight(displayHeight: number): number;
-    resizeHeight(distance: number): number;
-    setScrollTop(scrollTop: number): void;
-    updateStatsLimit(stats: Stats): void;
-    addBlock(key: string, block: BaseBlock): void;
-    setCurrBpPerPx(n: number): void;
-    deleteBlock(key: string): void;
-    selectFeature(feature: Feature): void;
-    clearFeatureSelection(): void;
-    setFeatureIdUnderMouse(feature: string | undefined): void;
-    reload(): void;
-    setContextMenuFeature(feature?: Feature | undefined): void;
-} & {
-    readonly regionTooLarge: boolean;
-    readonly regionTooLargeReason: string;
-} & {
-    reload(): Promise<void>;
-    afterAttach(): void;
-} & {
-    regionCannotBeRenderedText(_region: Region): "" | "Force load to see features";
-    /**
-     * @param region -
-     * @returns falsy if the region is fine to try rendering. Otherwise,
-     *  return a react node + string of text.
-     *  string of text describes why it cannot be rendered
-     *  react node allows user to force load at current setting
-     */
-    regionCannotBeRendered(_region: Region): JSX.Element | undefined;
-    trackMenuItems(): MenuItem[];
-    contextMenuItems(): {
-        label: string;
-        icon: import("@material-ui/core/OverridableComponent").OverridableComponent<import("@material-ui/core").SvgIconTypeMap<{}, "svg">>;
-        onClick: () => void;
-    }[];
-    renderProps(): any;
-} & {
-    renderSvg(opts: ExportSvgOptions & {
-        overrideHeight: number;
-    }): Promise<JSX.Element>;
-}, import("mobx-state-tree")._NotCustomized, {
-    id: string;
-    type: string;
-    rpcDriverName: string | undefined;
-    height: number;
-    userBpPerPxLimit: number | undefined;
-    userByteSizeLimit: number | undefined;
-}>;
-export declare type BaseLinearDisplayStateModel = typeof BaseLinearDisplay;
-export declare type BaseLinearDisplayModel = Instance<BaseLinearDisplayStateModel>;
-export {};
+import React from 'react';
+import { MenuItem } from '@jbrowse/core/ui';
+import { Stats } from '@jbrowse/core/data_adapters/BaseAdapter';
+import { BaseBlock } from '@jbrowse/core/util/blockTypes';
+import { Region } from '@jbrowse/core/util/types';
+import CompositeMap from '@jbrowse/core/util/compositeMap';
+import { Feature } from '@jbrowse/core/util/simpleFeature';
+import { Instance } from 'mobx-state-tree';
+import { ExportSvgOptions } from '../../LinearGenomeView';
+export interface Layout {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+    name: string;
+}
+declare type LayoutRecord = [number, number, number, number];
+export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
+    id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
+    type: import("mobx-state-tree").ISimpleType<string>;
+    rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+} & {
+    height: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<number>, [undefined]>;
+    blockState: import("mobx-state-tree").IMapType<import("mobx-state-tree").IModelType<{
+        key: import("mobx-state-tree").ISimpleType<string>;
+        region: import("mobx-state-tree").IModelType<{
+            refName: import("mobx-state-tree").ISimpleType<string>;
+            start: import("mobx-state-tree").ISimpleType<number>;
+            end: import("mobx-state-tree").ISimpleType<number>;
+            reversed: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<boolean>, [undefined]>;
+        } & {
+            assemblyName: import("mobx-state-tree").ISimpleType<string>;
+        }, {
+            setRefName(newRefName: string): void;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+        reloadFlag: import("mobx-state-tree").IType<number | undefined, number, number>;
+        isLeftEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        isRightEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    }, {
+        renderInProgress: AbortController | undefined;
+        filled: boolean;
+        reactElement: React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined;
+        features: Map<string, Feature> | undefined;
+        layout: any;
+        status: string;
+        error: unknown;
+        message: string | undefined;
+        maxHeightReached: boolean;
+        ReactComponent: ({ model, }: {
+            model: any;
+        }) => any;
+        renderProps: any;
+    } & {
+        doReload(): void;
+        afterAttach(): void;
+        setStatus(message: string): void;
+        setLoading(abortController: AbortController): void;
+        setMessage(messageText: string): void;
+        setRendered(props: {
+            reactElement: React.ReactElement<any, string | React.JSXElementConstructor<any>>;
+            features: Map<string, Feature>;
+            layout: any;
+            maxHeightReached: boolean;
+            renderProps: any;
+        } | undefined): void;
+        setError(error: unknown): void;
+        reload(): void;
+        beforeDestroy(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+}, {
+    rendererTypeName: string;
+    error: unknown;
+} & {
+    readonly RenderingComponent: React.FC<{
+        model: import("mobx-state-tree").ModelInstanceTypeProps<{
+            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
+            type: import("mobx-state-tree").ISimpleType<string>;
+            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        }> & {
+            rendererTypeName: string;
+            error: unknown;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
+            type: import("mobx-state-tree").ISimpleType<string>;
+            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        }, {
+            rendererTypeName: string;
+            error: unknown;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+        onHorizontalScroll?: Function | undefined;
+        blockState?: Record<string, any> | undefined;
+    }>;
+    readonly DisplayBlurb: React.FC<{
+        model: import("mobx-state-tree").ModelInstanceTypeProps<{
+            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
+            type: import("mobx-state-tree").ISimpleType<string>;
+            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        }> & {
+            rendererTypeName: string;
+            error: unknown;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>;
+            type: import("mobx-state-tree").ISimpleType<string>;
+            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        }, {
+            rendererTypeName: string;
+            error: unknown;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    }> | null;
+    readonly adapterConfig: any;
+    readonly parentTrack: any;
+    renderProps(): any;
+    readonly rendererType: any;
+    readonly DisplayMessageComponent: React.FC<any> | undefined;
+    trackMenuItems(): MenuItem[];
+    readonly viewMenuActions: MenuItem[];
+    regionCannotBeRendered(): undefined;
+} & {
+    setError(error?: unknown): void;
+    setRpcDriverName(rpcDriverName: string): void;
+    reload(): void;
+} & {
+    currBpPerPx: number;
+    message: string;
+    featureIdUnderMouse: string | undefined;
+    contextMenuFeature: Feature | undefined;
+    scrollTop: number;
+    estimatedRegionStatsP: Promise<Stats> | undefined;
+    estimatedRegionStats: Stats | undefined;
+} & {
+    readonly blockType: "staticBlocks" | "dynamicBlocks";
+    readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
+} & {
+    /**
+     * how many milliseconds to wait for the display to
+     * "settle" before re-rendering a block
+     */
+    readonly renderDelay: number;
+    readonly TooltipComponent: React.FC<any>;
+    /**
+     * returns a string feature ID if the globally-selected object
+     * is probably a feature
+     */
+    readonly selectedFeatureId: string | undefined;
+    /**
+     * if a display-level message should be displayed instead of the blocks,
+     * make this return a react component
+     */
+    readonly DisplayMessageComponent: React.FC<any> | undefined;
+} & {
+    /**
+     * a CompositeMap of `featureId -> feature obj` that
+     * just looks in all the block data for that feature
+     */
+    readonly features: CompositeMap<string, Feature>;
+    readonly featureUnderMouse: Feature | undefined;
+    getFeatureOverlapping(blockKey: string, x: number, y: number): any;
+    getFeatureByID(blockKey: string, id: string): LayoutRecord | undefined;
+    searchFeatureByID(id: string): LayoutRecord | undefined;
+    readonly currentBytesRequested: number;
+    readonly currentFeatureScreenDensity: number;
+    readonly maxFeatureScreenDensity: any;
+    readonly estimatedStatsReady: boolean;
+    readonly maxAllowableBytes: number;
+} & {
+    setMessage(message: string): void;
+    afterAttach(): void;
+    estimateRegionsStats(regions: Region[], opts: {
+        headers?: Record<string, string>;
+        signal?: AbortSignal;
+        filters?: string[];
+    }): Promise<Stats>;
+    setRegionStatsP(p?: Promise<Stats> | undefined): void;
+    setRegionStats(estimatedRegionStats?: Stats | undefined): void;
+    clearRegionStats(): void;
+    setHeight(displayHeight: number): number;
+    resizeHeight(distance: number): number;
+    setScrollTop(scrollTop: number): void;
+    updateStatsLimit(stats: Stats): void;
+    addBlock(key: string, block: BaseBlock): void;
+    setCurrBpPerPx(n: number): void;
+    deleteBlock(key: string): void;
+    selectFeature(feature: Feature): void;
+    clearFeatureSelection(): void;
+    setFeatureIdUnderMouse(feature: string | undefined): void;
+    reload(): void;
+    setContextMenuFeature(feature?: Feature | undefined): void;
+} & {
+    readonly regionTooLarge: boolean;
+    readonly regionTooLargeReason: string;
+} & {
+    reload(): Promise<void>;
+    afterAttach(): void;
+} & {
+    regionCannotBeRenderedText(_region: Region): "" | "Force load to see features";
+    /**
+     * @param region -
+     * @returns falsy if the region is fine to try rendering. Otherwise,
+     *  return a react node + string of text.
+     *  string of text describes why it cannot be rendered
+     *  react node allows user to force load at current setting
+     */
+    regionCannotBeRendered(_region: Region): JSX.Element | undefined;
+    trackMenuItems(): MenuItem[];
+    contextMenuItems(): {
+        label: string;
+        icon: import("@material-ui/core/OverridableComponent").OverridableComponent<import("@material-ui/core").SvgIconTypeMap<{}, "svg">>;
+        onClick: () => void;
+    }[];
+    renderProps(): any;
+} & {
+    renderSvg(opts: ExportSvgOptions & {
+        overrideHeight: number;
+    }): Promise<JSX.Element>;
+}, import("mobx-state-tree")._NotCustomized, {
+    id: string;
+    type: string;
+    rpcDriverName: string | undefined;
+    height: number;
+    userBpPerPxLimit: number | undefined;
+    userByteSizeLimit: number | undefined;
+}>;
+export declare type BaseLinearDisplayStateModel = typeof BaseLinearDisplay;
+export declare type BaseLinearDisplayModel = Instance<BaseLinearDisplayStateModel>;
+export {};