@jbrowse/plugin-linear-genome-view 2.1.6 → 2.2.0

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

@@ -20,7 +20,14 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
     type: import("mobx-state-tree").ISimpleType<string>;
     rpcDriverName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
 } & {
+    /**
+     * #property
+     */
     height: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<number>, [undefined]>;
+    /**
+     * #property
+     * updated via autorun
+     */
     blockState: import("mobx-state-tree").IMapType<import("mobx-state-tree").IModelType<{
         key: import("mobx-state-tree").ISimpleType<string>;
         region: import("mobx-state-tree").IModelType<{
@@ -54,6 +61,9 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
         doReload(): void;
         afterAttach(): void;
         setStatus(message: string): void;
+        /**
+         * #property
+         */
         setLoading(abortController: AbortController): void;
         setMessage(messageText: string): void;
         setRendered(props: {
@@ -65,9 +75,18 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
         } | undefined): void;
         setError(error: unknown): void;
         reload(): void;
+        /**
+         * #getter
+         */
         beforeDestroy(): void;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    /**
+     * #property
+     */
     userBpPerPxLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
+    /**
+     * #property
+     */
     userByteSizeLimit: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<number>>;
 }, {
     rendererTypeName: string;
@@ -118,7 +137,11 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
     readonly viewMenuActions: MenuItem[];
     regionCannotBeRendered(): undefined;
 } & {
-    setError(error?: unknown): void;
+    setError(error?: unknown): void; /**
+     * #getter
+     * returns a string feature ID if the globally-selected object
+     * is probably a feature
+     */
     setRpcDriverName(rpcDriverName: string): void;
     reload(): void;
 } & {
@@ -130,72 +153,182 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
     estimatedRegionStatsP: Promise<Stats> | undefined;
     estimatedRegionStats: Stats | undefined;
 } & {
+    /**
+     * #getter
+     */
     readonly blockType: "dynamicBlocks" | "staticBlocks";
+    /**
+     * #getter
+     */
     readonly blockDefinitions: import("@jbrowse/core/util/blockTypes").BlockSet;
 } & {
     /**
+     * #getter
      * how many milliseconds to wait for the display to
      * "settle" before re-rendering a block
      */
     readonly renderDelay: number;
+    /**
+     * #getter
+     */
     readonly TooltipComponent: React.FC<any>;
     /**
+     * #getter
      * returns a string feature ID if the globally-selected object
      * is probably a feature
      */
     readonly selectedFeatureId: string | undefined;
     /**
+     * #getter
      * if a display-level message should be displayed instead of the blocks,
      * make this return a react component
      */
     readonly DisplayMessageComponent: React.FC<any> | undefined;
 } & {
     /**
+     * #getter
      * a CompositeMap of `featureId -> feature obj` that
      * just looks in all the block data for that feature
      */
     readonly features: CompositeMap<string, Feature>;
+    /**
+     * #getter
+     */
     readonly featureUnderMouse: Feature | undefined;
+    /**
+     * #getter
+     */
     getFeatureOverlapping(blockKey: string, x: number, y: number): any;
+    /**
+     * #getter
+     */
     getFeatureByID(blockKey: string, id: string): LayoutRecord | undefined;
+    /**
+     * #getter
+     */
     searchFeatureByID(id: string): LayoutRecord | undefined;
+    /**
+     * #getter
+     */
     readonly currentBytesRequested: number;
+    /**
+     * #getter
+     */
     readonly currentFeatureScreenDensity: number;
+    /**
+     * #getter
+     */
     readonly maxFeatureScreenDensity: any;
+    /**
+     * #getter
+     */
     readonly estimatedStatsReady: boolean;
+    /**
+     * #getter
+     */
     readonly maxAllowableBytes: number;
 } & {
+    /**
+     * #action
+     */
     setMessage(message: string): void;
     afterAttach(): void;
+    /**
+     * #action
+     */
     estimateRegionsStats(regions: Region[], opts: {
         headers?: Record<string, string>;
         signal?: AbortSignal;
         filters?: string[];
     }): Promise<{}>;
+    /**
+     * #action
+     */
     setRegionStatsP(p?: Promise<Stats>): void;
+    /**
+     * #action
+     */
     setRegionStats(estimatedRegionStats?: Stats): void;
+    /**
+     * #action
+     */
     clearRegionStats(): void;
+    /**
+     * #action
+     */
     setHeight(displayHeight: number): number;
+    /**
+     * #action
+     */
     resizeHeight(distance: number): number;
+    /**
+     * #action
+     */
     setScrollTop(scrollTop: number): void;
+    /**
+     * #action
+     */
     updateStatsLimit(stats: Stats): void;
+    /**
+     * #action
+     */
     addBlock(key: string, block: BaseBlock): void;
+    /**
+     * #action
+     */
     setCurrBpPerPx(n: number): void;
+    /**
+     * #action
+     */
     deleteBlock(key: string): void;
+    /**
+     * #action
+     */
     selectFeature(feature: Feature): void;
+    /**
+     * #action
+     */
     clearFeatureSelection(): void;
+    /**
+     * #action
+     */
     setFeatureIdUnderMouse(feature: string | undefined): void;
+    /**
+     * #action
+     */
     reload(): void;
+    /**
+     * #action
+     */
     setContextMenuFeature(feature?: Feature): void;
 } & {
+    /**
+     * #getter
+     * region is too large if:
+     * - stats are ready
+     * - region is greater than 20kb (don't warn when zoomed in less than that)
+     * - and bytes is greater than max allowed bytes or density greater than max density
+     */
     readonly regionTooLarge: boolean;
+    /**
+     * #getter
+     * only shows a message of bytes requested is defined, the feature density
+     * based stats don't produce any helpful message besides to zoom in
+     */
     readonly regionTooLargeReason: string;
 } & {
+    /**
+     * #action
+     */
     reload(): Promise<void>;
     afterAttach(): void;
 } & {
+    /**
+     * #method
+     */
     regionCannotBeRenderedText(_region: Region): "" | "Force load to see features";
     /**
+     * #method
      * @param region -
      * @returns falsy if the region is fine to try rendering. Otherwise,
      *  return a react node + string of text.
@@ -203,7 +336,13 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
      *  react node allows user to force load at current setting
      */
     regionCannotBeRendered(_region: Region): JSX.Element | null;
+    /**
+     * #method
+     */
     trackMenuItems(): MenuItem[];
+    /**
+     * #method
+     */
     contextMenuItems(): {
         label: string;
         icon: import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
@@ -211,8 +350,14 @@ export declare const BaseLinearDisplay: import("mobx-state-tree").IModelType<{
         };
         onClick: () => void;
     }[];
+    /**
+     * #method
+     */
     renderProps(): any;
 } & {
+    /**
+     * #method
+     */
     renderSvg(opts: ExportSvgOptions & {
         overrideHeight: number;
     }): Promise<JSX.Element>;