@jbrowse/plugin-alignments 2.6.2 → 2.7.0

package/dist/LinearPileupDisplay/SharedLinearPileupDisplayMixin.d.ts

@@ -0,0 +1,514 @@
+/// <reference types="react" />
+import { AnyConfigurationModel, AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
+import SerializableFilterChain from '@jbrowse/core/pluggableElementTypes/renderers/util/serializableFilterChain';
+import { Feature } from '@jbrowse/core/util';
+import { ContentCopy as ContentCopyIcon } from '@jbrowse/core/ui/Icons';
+import { IFilter } from '../shared';
+import { ExtraColorBy } from '../shared/color';
+/**
+ * #stateModel SharedLinearPileupDisplayMixin
+ * #category display
+ * extends `BaseLinearDisplay`
+ */
+export declare function SharedLinearPileupDisplayMixin(configSchema: AnyConfigurationSchemaType): 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>>;
+} & {
+    heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+} & {
+    userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+} & {
+    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: import("react").ReactElement<any, string | import("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: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+            /**
+             * #action
+             */
+            features: Map<string, Feature>;
+            layout: any;
+            maxHeightReached: boolean;
+            renderProps: any;
+        } | undefined): void;
+        setError(error: unknown): void; /**
+         * #action
+         */
+        reload(): void;
+        beforeDestroy(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        maxFeatureScreenDensity: {
+            type: string;
+            description: string;
+            defaultValue: number;
+        };
+        fetchSizeLimit: {
+            type: string;
+            defaultValue: number;
+            description: string;
+        };
+        height: {
+            type: string;
+            defaultValue: number;
+            description: string;
+        };
+        mouseover: {
+            type: string;
+            description: string;
+            defaultValue: string;
+            contextVariable: string[];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "displayId">>;
+} & {
+    /**
+     * #property
+     */
+    configuration: AnyConfigurationSchemaType;
+    /**
+     * #property
+     */
+    featureHeight: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    /**
+     * #property
+     */
+    noSpacing: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
+    /**
+     * #property
+     */
+    fadeLikelihood: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
+    /**
+     * #property
+     */
+    trackMaxHeight: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    /**
+     * #property
+     */
+    colorBy: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IModelType<{
+        type: import("mobx-state-tree").ISimpleType<string>;
+        tag: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        extra: import("mobx-state-tree").IType<any, any, any>;
+    }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    /**
+     * #property
+     */
+    filterBy: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IModelType<{
+        flagInclude: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<number>, [undefined]>;
+        flagExclude: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<number>, [undefined]>;
+        readName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        tagFilter: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IModelType<{
+            tag: import("mobx-state-tree").ISimpleType<string>;
+            value: import("mobx-state-tree").ISimpleType<string>;
+        }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>, [undefined]>;
+    /**
+     * #property
+     */
+    jexlFilters: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").ISimpleType<string>>, [undefined]>;
+}, {
+    rendererTypeName: string;
+    error: unknown;
+    message: string | undefined;
+} & {
+    readonly RenderingComponent: import("react").FC<{
+        model: {
+            id: string;
+            type: string;
+            rpcDriverName: string | undefined;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            rendererTypeName: string;
+            error: unknown;
+            message: string | undefined;
+        } & 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;
+            message: string | undefined;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+        onHorizontalScroll?: Function | undefined;
+        blockState?: Record<string, any> | undefined;
+    }>;
+    readonly DisplayBlurb: import("react").FC<{
+        model: {
+            id: string;
+            type: string;
+            rpcDriverName: string | undefined;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            rendererTypeName: string;
+            error: unknown;
+            message: string | undefined;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<string>, [undefined]>; /**
+             * #property
+             */
+            type: import("mobx-state-tree").ISimpleType<string>;
+            rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        }, {
+            rendererTypeName: string;
+            error: unknown;
+            message: string | undefined;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    }> | null;
+    readonly adapterConfig: any;
+    readonly parentTrack: any;
+    renderProps(): any;
+    readonly rendererType: import("@jbrowse/core/pluggableElementTypes").RendererType;
+    readonly DisplayMessageComponent: import("react").FC<any> | undefined;
+    trackMenuItems(): import("@jbrowse/core/ui").MenuItem[];
+    readonly viewMenuActions: import("@jbrowse/core/ui").MenuItem[];
+    regionCannotBeRendered(): null;
+} & {
+    setMessage(arg?: string | undefined): void;
+    setError(error?: unknown): void;
+    setRpcDriverName(rpcDriverName: string): void;
+    reload(): void;
+} & {
+    scrollTop: number;
+} & {
+    readonly height: number;
+} & {
+    setScrollTop(scrollTop: number): void;
+    setHeight(displayHeight: number): number;
+    resizeHeight(distance: number): number;
+} & {
+    featureDensityStatsP: Promise<import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats> | undefined;
+    featureDensityStats: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined;
+    currStatsBpPerPx: number;
+} & {
+    readonly currentBytesRequested: number;
+    readonly currentFeatureScreenDensity: number;
+    readonly maxFeatureScreenDensity: any;
+    readonly featureDensityStatsReady: boolean;
+    readonly maxAllowableBytes: number;
+} & {
+    afterAttach(): void;
+} & {
+    setCurrStatsBpPerPx(n: number): void;
+    setFeatureDensityStatsLimit(stats?: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined): void;
+    getFeatureDensityStats(): Promise<import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats>;
+    setFeatureDensityStatsP(arg: any): void;
+    setFeatureDensityStats(featureDensityStats?: import("@jbrowse/core/data_adapters/BaseAdapter").FeatureDensityStats | undefined): void;
+    clearFeatureDensityStats(): void;
+} & {
+    readonly regionTooLarge: boolean;
+    readonly regionTooLargeReason: string;
+} & {
+    regionCannotBeRenderedText(_region: import("@jbrowse/core/util").Region): "" | "Force load to see features";
+    regionCannotBeRendered(_region: import("@jbrowse/core/util").Region): import("react").JSX.Element | null;
+} & {
+    featureIdUnderMouse: string | undefined; /**
+     * #property
+     */
+    contextMenuFeature: Feature | undefined;
+} & {
+    /**
+     * #property
+     */
+    readonly blockType: "dynamicBlocks" | "staticBlocks";
+    readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
+} & {
+    readonly renderDelay: number;
+    readonly TooltipComponent: import("react").FC<any>;
+    readonly selectedFeatureId: string | undefined;
+    readonly DisplayMessageComponent: import("react").FC<any> | undefined;
+} & {
+    readonly features: import("@jbrowse/core/util/compositeMap").default<string, Feature>;
+    readonly featureUnderMouse: Feature | undefined;
+    getFeatureOverlapping(blockKey: string, x: number, y: number): string | undefined;
+    getFeatureByID(blockKey: string, id: string): [number, number, number, number] | undefined;
+    searchFeatureByID(id: string): [number, number, number, number] | undefined;
+} & {
+    addBlock(key: string, block: import("@jbrowse/core/util/blockTypes").BaseBlock): void;
+    deleteBlock(key: string): void;
+    selectFeature(feature: Feature): void;
+    clearFeatureSelection(): void;
+    setFeatureIdUnderMouse(feature?: string | undefined): void;
+    setContextMenuFeature(feature?: Feature | undefined): void;
+} & {
+    reload(): Promise<void>;
+} & {
+    trackMenuItems(): import("@jbrowse/core/ui").MenuItem[];
+    contextMenuItems(): import("@jbrowse/core/ui").MenuItem[];
+    renderProps(): any;
+} & {
+    renderSvg(opts: import("@jbrowse/plugin-linear-genome-view").ExportSvgDisplayOptions): Promise<import("react").JSX.Element>;
+    afterAttach(): void;
+} & {
+    colorTagMap: import("mobx").ObservableMap<string, string>;
+    featureUnderMouseVolatile: Feature | undefined;
+    tagsReady: boolean;
+} & {
+    readonly autorunReady: boolean;
+} & {
+    /**
+     * #action
+     */
+    setTagsReady(flag: boolean): void;
+    /**
+     * #action
+     */
+    setMaxHeight(n: number): void;
+    /**
+     * #action
+     */
+    setFeatureHeight(n?: number): void;
+    /**
+     * #action
+     */
+    setNoSpacing(flag?: boolean): void;
+    /**
+     * #action
+     */
+    setColorScheme(colorScheme: {
+        type: string;
+        tag?: string;
+        extra?: ExtraColorBy;
+    }): void;
+    /**
+     * #action
+     */
+    updateColorTagMap(uniqueTag: string[]): void;
+    /**
+     * #action
+     */
+    setFeatureUnderMouse(feat?: Feature): void;
+    /**
+     * #action
+     */
+    selectFeature(feature: Feature): void;
+    /**
+     * #action
+     * uses copy-to-clipboard and generates notification
+     */
+    copyFeatureToClipboard(feature: Feature): void;
+    /**
+     * #action
+     */
+    setConfig(conf: AnyConfigurationModel): void;
+    /**
+     * #action
+     */
+    setFilterBy(filter: IFilter): void;
+    /**
+     * #action
+     */
+    setJexlFilters(filters: string[]): void;
+} & {
+    /**
+     * #getter
+     */
+    readonly rendererConfig: {
+        [x: string]: any;
+    } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+        setSubschema(slotName: string, data: unknown): any;
+    } & import("mobx-state-tree").IStateTreeNode<AnyConfigurationSchemaType>;
+} & {
+    /**
+     * #getter
+     */
+    readonly maxHeight: any;
+    /**
+     * #getter
+     */
+    readonly featureHeightSetting: any;
+    /**
+     * #getter
+     */
+    readonly featureUnderMouse: Feature | undefined;
+    /**
+     * #getter
+     */
+    renderReady(): boolean;
+    /**
+     * #getter
+     */
+    readonly filters: SerializableFilterChain;
+} & {
+    /**
+     * #getter
+     */
+    readonly rendererTypeName: string;
+    /**
+     * #method
+     */
+    contextMenuItems(): ({
+        label: string;
+        icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
+            muiName: string;
+        };
+        onClick: () => void;
+    } | {
+        label: string;
+        icon: typeof ContentCopyIcon;
+        onClick: () => void;
+    })[];
+    /**
+     * #getter
+     */
+    readonly DisplayBlurb: ({ model, }: {
+        model: {
+            sortedBy?: {
+                pos: number;
+                refName: number;
+                type: string;
+                tag?: string | undefined;
+            } | undefined;
+        };
+    }) => import("react").JSX.Element | null;
+    /**
+     * #method
+     */
+    renderPropsPre(): any;
+    /**
+     * #method
+     */
+    colorSchemeSubMenuItems(): {
+        label: string;
+        onClick: () => void;
+    }[];
+    /**
+     * #method
+     */
+    trackMenuItems(): (import("@jbrowse/core/ui").MenuDivider | import("@jbrowse/core/ui").MenuSubHeader | import("@jbrowse/core/ui").NormalMenuItem | import("@jbrowse/core/ui").CheckboxMenuItem | import("@jbrowse/core/ui").RadioMenuItem | import("@jbrowse/core/ui").SubMenuItem | {
+        label: string;
+        icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
+            muiName: string;
+        };
+        onClick: () => void;
+    })[];
+} & {
+    renderProps(): any;
+} & {
+    afterAttach(): void;
+}, {
+    type: string;
+} & Partial<import("mobx-state-tree/dist/internal").ExtractCFromProps<{
+    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>>;
+} & {
+    heightPreConfig: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+} & {
+    userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+} & {
+    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: import("react").ReactElement<any, string | import("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: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+            /**
+             * #action
+             */
+            features: Map<string, Feature>;
+            layout: any;
+            maxHeightReached: boolean;
+            renderProps: any;
+        } | undefined): void;
+        setError(error: unknown): void; /**
+         * #action
+         */
+        reload(): void;
+        beforeDestroy(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    configuration: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
+        maxFeatureScreenDensity: {
+            type: string;
+            description: string;
+            defaultValue: number;
+        };
+        fetchSizeLimit: {
+            type: string;
+            defaultValue: number;
+            description: string;
+        };
+        height: {
+            type: string;
+            defaultValue: number;
+            description: string;
+        };
+        mouseover: {
+            type: string;
+            description: string;
+            defaultValue: string;
+            contextVariable: string[];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "displayId">>;
+}>> & import("mobx-state-tree/dist/internal").NonEmptyObject & import("mobx-state-tree")._NotCustomized, {
+    type: string;
+    id: string;
+    configuration: import("mobx-state-tree").ModelSnapshotType<Record<string, any>>;
+    rpcDriverName: string | undefined;
+    heightPreConfig: number | undefined;
+    userBpPerPxLimit: number | undefined;
+    userByteSizeLimit: number | undefined;
+} & import("mobx-state-tree")._NotCustomized>;