@jbrowse/plugin-alignments 2.16.1 → 2.18.0

package/esm/LinearPileupDisplay/model.d.ts

@@ -1,11 +1,6 @@
-import { Instance } from 'mobx-state-tree';
-import { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
-/**
- * #stateModel LinearPileupDisplay
- * #category display
- * extends
- * - [SharedLinearPileupDisplayMixin](../sharedlinearpileupdisplaymixin)
- */
+import type { ModificationType, ModificationTypeWithColor, SortedBy } from '../shared/types';
+import type { AnyConfigurationSchemaType } from '@jbrowse/core/configuration';
+import type { Instance } from 'mobx-state-tree';
 declare function stateModelFactory(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>;
@@ -18,21 +13,12 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
 } & {
     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>;
+        region: import("mobx-state-tree").IType<import("@jbrowse/core/util").Region, import("@jbrowse/core/util").Region, import("@jbrowse/core/util").Region>;
         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;
+        stopToken: string | undefined;
         filled: boolean;
         reactElement: React.ReactElement | undefined;
         features: Map<string, import("@jbrowse/core/util").Feature> | undefined;
@@ -48,9 +34,7 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
                 message: React.ReactNode;
                 filled?: boolean;
                 status?: string;
-                reactElement? /**
-                 * #property
-                 */: React.ReactElement;
+                reactElement?: React.ReactElement;
             };
         }) => import("react").JSX.Element | undefined;
         renderProps: any;
@@ -58,17 +42,9 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
         doReload(): void;
         afterAttach(): void;
         setStatus(message: string): void;
-        setLoading(abortController: AbortController): void;
+        setLoading(newStopToken: string): void;
         setMessage(messageText: string): void;
-        setRendered(props: {
-            reactElement: React.ReactElement /**
-             * #action
-             */;
-            features: Map<string, import("@jbrowse/core/util").Feature>;
-            layout: any;
-            maxHeightReached: boolean;
-            renderProps: any;
-        } | undefined): void;
+        setRendered(props: import("@jbrowse/plugin-linear-genome-view/src/BaseLinearDisplay/models/serverSideRenderedBlock").RenderedProps | undefined): void;
         setError(error: unknown): void;
         reload(): void;
         beforeDestroy(): void;
@@ -107,33 +83,15 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     noSpacing: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
     fadeLikelihood: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
     trackMaxHeight: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
-    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>>;
-    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").IMaybe<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]>;
+    colorBySetting: import("mobx-state-tree").IType<import("../shared/types").ColorBy | undefined, import("../shared/types").ColorBy | undefined, import("../shared/types").ColorBy | undefined>;
+    filterBySetting: import("mobx-state-tree").IType<import("../shared/types").FilterBy | undefined, import("../shared/types").FilterBy | undefined, import("../shared/types").FilterBy | undefined>;
     jexlFilters: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").ISimpleType<string>>, [undefined]>;
 } & {
     type: import("mobx-state-tree").ISimpleType<"LinearPileupDisplay">;
     configuration: AnyConfigurationSchemaType;
     showSoftClipping: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
     mismatchAlpha: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
-    sortedBy: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IModelType<{
-        type: import("mobx-state-tree").ISimpleType<string>;
-        pos: import("mobx-state-tree").ISimpleType<number>;
-        tag: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
-        refName: import("mobx-state-tree").ISimpleType<string>;
-        assemblyName: import("mobx-state-tree").ISimpleType<string>;
-    }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    sortedBy: import("mobx-state-tree").IType<SortedBy | undefined, SortedBy | undefined, SortedBy | undefined>;
 }, {
     rendererTypeName: string;
     error: unknown;
@@ -156,9 +114,7 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
             rendererTypeName: string;
             error: unknown;
             message: string | undefined;
-        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree" /**
-         * #property
-         */)._NotCustomized>>;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
         onHorizontalScroll?: () => void;
         blockState?: Record<string, any>;
     }>;
@@ -225,6 +181,7 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     readonly regionTooLarge: boolean;
     readonly regionTooLargeReason: string;
 } & {
+    readonly statsReadyAndRegionNotTooLarge: boolean;
     regionCannotBeRenderedText(_region: import("@jbrowse/core/util").Region): "" | "Force load to see features";
     regionCannotBeRendered(_region: import("@jbrowse/core/util").Region): import("react").JSX.Element | null;
 } & {
@@ -265,6 +222,9 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     colorTagMap: import("mobx").ObservableMap<string, string>;
     featureUnderMouseVolatile: undefined | import("@jbrowse/core/util").Feature;
     tagsReady: boolean;
+} & {
+    readonly colorBy: any;
+    readonly filterBy: any;
 } & {
     readonly autorunReady: boolean;
 } & {
@@ -272,17 +232,13 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     setMaxHeight(n?: number): void;
     setFeatureHeight(n?: number): void;
     setNoSpacing(flag?: boolean): void;
-    setColorScheme(colorScheme: {
-        type: string;
-        tag?: string;
-        extra?: import("../shared/color").ExtraColorBy;
-    }): void;
+    setColorScheme(colorScheme: import("../shared/types").ColorBy): void;
     updateColorTagMap(uniqueTag: string[]): void;
     setFeatureUnderMouse(feat?: import("@jbrowse/core/util").Feature): void;
     selectFeature(feature: import("@jbrowse/core/util").Feature): void;
     copyFeatureToClipboard(feature: import("@jbrowse/core/util").Feature): void;
     setConfig(conf: import("@jbrowse/core/configuration").AnyConfigurationModel): void;
-    setFilterBy(filter: import("../shared").IFilter): void;
+    setFilterBy(filter: import("../shared/types").FilterBy): void;
     setJexlFilters(filters: string[]): void;
 } & {
     readonly rendererConfig: {
@@ -317,12 +273,7 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     })[];
     readonly DisplayBlurb: ({ model, }: {
         model: {
-            sortedBy?: {
-                pos: number;
-                refName: number;
-                type: string;
-                tag?: string;
-            };
+            sortedBy?: SortedBy;
         };
     }) => import("react").JSX.Element | null;
     renderPropsPre(): any;
@@ -344,56 +295,22 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
 } & {
     sortReady: boolean;
     currSortBpPerPx: number;
-    modificationTagMap: import("mobx").ObservableMap<string, string>;
+    visibleModifications: import("mobx").ObservableMap<string, ModificationTypeWithColor>;
     modificationsReady: boolean;
 } & {
-    /**
-     * #action
-     */
     setCurrSortBpPerPx(n: number): void;
-    /**
-     * #action
-     */
-    updateModificationColorMap(uniqueModifications: string[]): void;
-    /**
-     * #action
-     */
+    updateVisibleModifications(uniqueModifications: ModificationType[]): void;
     setModificationsReady(flag: boolean): void;
-    /**
-     * #action
-     */
     setSortReady(flag: boolean): void;
-    /**
-     * #action
-     */
     clearSelected(): void;
-    /**
-     * #action
-     */
     toggleSoftClipping(): void;
-    /**
-     * #action
-     */
     toggleMismatchAlpha(): void;
-    /**
-     * #action
-     */
     setSortedBy(type: string, tag?: string): void;
-    /**
-     * #action
-     * overrides base from SharedLinearPileupDisplay to make sortReady false
-     * since changing feature height destroys the sort-induced layout
-     */
     setFeatureHeight(n?: number): void;
 } & {
-    /**
-     * #action
-     */
     reload(): void;
 } & {
-    /**
-     * #getter
-     */
+    readonly visibleModificationTypes: string[];
     readonly rendererConfig: {
         [x: string]: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
@@ -406,26 +323,11 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
         } & import("mobx-state-tree").IStateTreeNode<AnyConfigurationSchemaType>);
     } & import("mobx-state-tree").IStateTreeNode<AnyConfigurationSchemaType>;
 } & {
-    /**
-     * #getter
-     */
     readonly mismatchAlphaSetting: any;
-    /**
-     * #method
-     */
     renderReady(): boolean;
 } & {
-    /**
-     * #method
-     */
     renderPropsPre(): any;
-    /**
-     * #method
-     */
     renderProps(): any;
-    /**
-     * #method
-     */
     trackMenuItems(): readonly [...import("@jbrowse/core/ui").MenuItem[], {
         readonly label: "Sort by...";
         readonly icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
@@ -451,8 +353,17 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
             readonly label: "Pair orientation";
             readonly onClick: () => void;
         }, {
-            readonly label: "Modifications or methylation";
-            readonly onClick: () => void;
+            readonly label: "Modifications";
+            readonly type: "subMenu";
+            readonly subMenu: ({
+                label: string;
+                onClick: () => void;
+                type?: undefined;
+            } | {
+                type: string;
+                label?: undefined;
+                onClick?: undefined;
+            })[];
         }, {
             readonly label: "Insert size";
             readonly onClick: () => void;
@@ -482,7 +393,94 @@ declare function stateModelFactory(configSchema: AnyConfigurationSchemaType): im
     }];
 } & {
     afterAttach(): void;
-}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+}, {
+    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").IType<import("@jbrowse/core/util").Region, import("@jbrowse/core/util").Region, import("@jbrowse/core/util").Region>;
+        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>;
+    }, {
+        stopToken: string | undefined;
+        filled: boolean;
+        reactElement: React.ReactElement | undefined;
+        features: Map<string, import("@jbrowse/core/util").Feature> | undefined;
+        layout: any;
+        status: string;
+        error: unknown;
+        message: string | undefined;
+        maxHeightReached: boolean;
+        ReactComponent: ({ model, }: {
+            model: {
+                error?: unknown;
+                reload: () => void;
+                message: React.ReactNode;
+                filled?: boolean;
+                status?: string;
+                reactElement?: React.ReactElement;
+            };
+        }) => import("react").JSX.Element | undefined;
+        renderProps: any;
+    } & {
+        doReload(): void;
+        afterAttach(): void;
+        setStatus(message: string): void;
+        setLoading(newStopToken: string): void;
+        setMessage(messageText: string): void;
+        setRendered(props: import("@jbrowse/plugin-linear-genome-view/src/BaseLinearDisplay/models/serverSideRenderedBlock").RenderedProps | undefined): void;
+        setError(error: unknown): void;
+        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[];
+        };
+        jexlFilters: {
+            type: string;
+            description: string;
+            defaultValue: never[];
+        };
+    }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, "displayId">>;
+} & {
+    configuration: AnyConfigurationSchemaType;
+    featureHeight: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    noSpacing: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
+    fadeLikelihood: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<boolean>>;
+    trackMaxHeight: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    colorBySetting: import("mobx-state-tree").IType<import("../shared/types").ColorBy | undefined, import("../shared/types").ColorBy | undefined, import("../shared/types").ColorBy | undefined>;
+    filterBySetting: import("mobx-state-tree").IType<import("../shared/types").FilterBy | undefined, import("../shared/types").FilterBy | undefined, import("../shared/types").FilterBy | undefined>;
+    jexlFilters: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").ISimpleType<string>>, [undefined]>;
+}>> & import("mobx-state-tree/dist/internal").NonEmptyObject & import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export type LinearPileupDisplayStateModel = ReturnType<typeof stateModelFactory>;
 export type LinearPileupDisplayModel = Instance<LinearPileupDisplayStateModel>;
 export default stateModelFactory;