Skip to content

Commit

Permalink
browser global ROI API
Browse files Browse the repository at this point in the history
Signed-off-by: eternal-flame-AD <[email protected]>
  • Loading branch information
eternal-flame-AD committed Sep 2, 2024
1 parent 2fd541c commit d359455
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions js/igv.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,15 @@ interface ReferenceFrag {
}

interface CreateOptExtras {
/**
*
* An igv.js instance can be initialized on page load with query parameters.
*
* @type {boolean=}
*
*/
supportQueryParameters?: boolean;

/**
*
* Initial genomic location(s). Either a string or an array of strings. If an array a viewport is created for each location.
Expand All @@ -597,6 +606,15 @@ interface CreateOptExtras {
*/
nucleotideColors?: Partial<Record<Nucleotide, string>>;

/**
*
* A Region of Interest (ROI) is a specified genomic extent that can be configured to highlight a region
*
* @type {DefineROI[]}
*
*/
roi: DefineROI[];

/**
*
* Array of configuration objects defining tracks initially displayed when app launches.
Expand Down Expand Up @@ -639,12 +657,18 @@ declare class ROISet {
isvisible: boolean;
}

interface DefineROI {
url: string;
type DefineROI = {
name: string;
format: string;
color: string;
}
} & ({
url: string;
indexed?: boolean;
format?: string;
} | {
chr: string;
start: number;
end: number;
});


declare class _Browser {
Expand Down

0 comments on commit d359455

Please sign in to comment.