@jbrowse/plugin-alignments 2.1.7 → 2.2.1

package/dist/LinearPileupDisplay/model.d.ts

@@ -4,7 +4,11 @@ import { AnyConfigurationModel } from '@jbrowse/core/configuration';
 import { Feature } from '@jbrowse/core/util';
 import { ContentCopy as ContentCopyIcon } from '@jbrowse/core/ui/Icons';
 import { LinearPileupDisplayConfigModel } from './configSchema';
-declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel) => import("mobx-state-tree").IModelType<{
+/**
+ * #stateModel LinearPileupDisplay
+ * extends `BaseLinearDisplay`
+ */
+declare function stateModelFactory(configSchema: LinearPileupDisplayConfigModel): 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>>;
@@ -26,10 +30,14 @@ declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel)
         isLeftEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
         isRightEndOfDisplayedRegion: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
     }, {
-        renderInProgress: AbortController | undefined;
+        renderInProgress: AbortController | undefined; /**
+         * #property
+         */
         filled: boolean;
         reactElement: import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | undefined;
-        features: Map<string, Feature> | undefined;
+        features: Map<string, Feature> | undefined; /**
+         * #property
+         */
         layout: any;
         status: string;
         error: unknown;
@@ -40,7 +48,9 @@ declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel)
         }) => any;
         renderProps: any;
     } & {
-        doReload(): void;
+        doReload(): void; /**
+         * #property
+         */
         afterAttach(): void;
         setStatus(message: string): void;
         setLoading(abortController: AbortController): void;
@@ -216,27 +226,78 @@ declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel)
     colorTagMap: import("mobx").ObservableMap<string, string>;
     modificationTagMap: import("mobx").ObservableMap<string, string>;
     featureUnderMouseVolatile: Feature | undefined;
+    currSortBpPerPx: number;
     ready: boolean;
 } & {
+    /**
+     * #action
+     */
     setReady(flag: boolean): void;
+    /**
+     * #action
+     */
+    setCurrSortBpPerPx(n: number): void;
+    /**
+     * #action
+     */
     setMaxHeight(n: number): void;
+    /**
+     * #action
+     */
     setFeatureHeight(n: number): void;
+    /**
+     * #action
+     */
     setNoSpacing(flag: boolean): void;
+    /**
+     * #action
+     */
     setColorScheme(colorScheme: {
         type: string;
         tag?: string;
     }): void;
+    /**
+     * #action
+     */
     updateModificationColorMap(uniqueModifications: string[]): void;
+    /**
+     * #action
+     */
     updateColorTagMap(uniqueTag: string[]): void;
+    /**
+     * #action
+     */
     setFeatureUnderMouse(feat?: Feature): void;
 } & {
     afterAttach(): void;
+    /**
+     * #action
+     */
     selectFeature(feature: Feature): void;
+    /**
+     * #action
+     */
     clearSelected(): void;
+    /**
+     * #action
+     * uses copy-to-clipboard and generates notification
+     */
     copyFeatureToClipboard(feature: Feature): void;
+    /**
+     * #action
+     */
     toggleSoftClipping(): void;
+    /**
+     * #action
+     */
     toggleMismatchAlpha(): void;
+    /**
+     * #action
+     */
     setConfig(configuration: AnyConfigurationModel): void;
+    /**
+     * #action
+     */
     setSortedBy(type: string, tag?: string): void;
     setFilterBy(filter: {
         flagInclude: number;
@@ -248,26 +309,59 @@ declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel)
         };
     }): void;
 } & {
+    /**
+     * #action
+     */
     reload(): void;
 } & {
+    /**
+     * #getter
+     */
     readonly maxHeight: any;
+    /**
+     * #getter
+     */
     readonly rendererConfig: {
         [x: string]: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
         setSubschema(slotName: string, data: unknown): any;
     } & import("mobx-state-tree").IStateTreeNode<import("@jbrowse/core/configuration").AnyConfigurationSchemaType>;
+    /**
+     * #getter
+     */
     readonly featureHeightSetting: any;
+    /**
+     * #getter
+     */
     readonly mismatchAlphaSetting: any;
+    /**
+     * #getter
+     */
     readonly featureUnderMouse: Feature | undefined;
 } & {
+    /**
+     * #getter
+     */
     readonly rendererTypeName: string;
+    /**
+     * #method
+     */
     contextMenuItems(): {
         label: string;
         icon: typeof ContentCopyIcon;
         onClick: () => void;
     }[];
+    /**
+     * #getter
+     */
     readonly DisplayBlurb: (props: import("./components/LinearPileupDisplayBlurb").LinearPileupDisplayBlurbProps) => JSX.Element | null;
+    /**
+     * #method
+     */
     renderProps(): any;
+    /**
+     * #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">> & {
@@ -331,6 +425,6 @@ declare const stateModelFactory: (configSchema: LinearPileupDisplayConfigModel)
     userBpPerPxLimit: number | undefined;
     userByteSizeLimit: number | undefined;
 } & import("mobx-state-tree")._NotCustomized>;
-export declare type LinearPileupDisplayStateModel = ReturnType<typeof stateModelFactory>;
-export declare type LinearPileupDisplayModel = Instance<LinearPileupDisplayStateModel>;
+export type LinearPileupDisplayStateModel = ReturnType<typeof stateModelFactory>;
+export type LinearPileupDisplayModel = Instance<LinearPileupDisplayStateModel>;
 export default stateModelFactory;