gene-tooltips

---

Interfaces

GeneRIF

Defined in: config.ts:21

Properties

pubmed

pubmed: number

Defined in: config.ts:22

text

text: string

Defined in: config.ts:23

---

GeneTooltipConfig

Defined in: config.ts:88

Properties

api

api: "mygene"

Defined in: config.ts:90

constrainToViewport

constrainToViewport: boolean

Defined in: config.ts:107

display

display: Partial<TooltipDisplayConfig>

Defined in: config.ts:95

domainCount

domainCount: number

Defined in: config.ts:101

generifCount

generifCount: number

Defined in: config.ts:104

ideogram

ideogram: Partial<IdeogramConfig>

Defined in: config.ts:96

nestedTippyOptions

nestedTippyOptions: Partial<Props>

Defined in: config.ts:98

pathwayCount

pathwayCount: number

Defined in: config.ts:100

pathwaySource

pathwaySource: "reactome" | "kegg" | "wikipathways"

Defined in: config.ts:99

prefetch

prefetch: "smart" | "all" | "none"

Defined in: config.ts:91

prefetchThreshold

prefetchThreshold: number

Defined in: config.ts:92

selector

selector: string

Defined in: config.ts:89

structureCount

structureCount: number

Defined in: config.ts:103

theme

theme: "light" | "dark" | "auto" | "material" | "translucent" | "light-border" | undefined

Defined in: config.ts:94

tippyOptions

tippyOptions: Partial<Props>

Defined in: config.ts:97

tooltipHeight?

optional tooltipHeight: number

Defined in: config.ts:106

tooltipWidth?

optional tooltipWidth: number

Defined in: config.ts:105

transcriptCount

transcriptCount: number

Defined in: config.ts:102

truncateSummary

truncateSummary: number

Defined in: config.ts:93

---

GenomicPosition

Defined in: config.ts:3

Properties

chr

chr: string

Defined in: config.ts:4

end

end: number

Defined in: config.ts:6

start

start: number

Defined in: config.ts:5

strand

strand: number

Defined in: config.ts:7

---

IdeogramConfig

Defined in: config.ts:80

Properties

enabled

enabled: boolean

Defined in: config.ts:81

height

height: number

Defined in: config.ts:83

showLabels

showLabels: boolean

Defined in: config.ts:84

width

width: number

Defined in: config.ts:82

---

MyGeneExon

Defined in: config.ts:110

Properties

cdsend

cdsend: number

Defined in: config.ts:111

cdsstart

cdsstart: number

Defined in: config.ts:112

chr

chr: string

Defined in: config.ts:113

end?

optional end: number

Defined in: config.ts:120

position?

optional position: [number, number][]

Defined in: config.ts:118

start?

optional start: number

Defined in: config.ts:119

strand

strand: number

Defined in: config.ts:114

transcript

transcript: string

Defined in: config.ts:117

txend

txend: number

Defined in: config.ts:115

txstart

txstart: number

Defined in: config.ts:116

---

MyGeneInfoResult

Defined in: config.ts:27

Properties

_id

_id: string

Defined in: config.ts:28

ensembl?

optional ensembl: object

Defined in: config.ts:42

gene

gene: string

protein?

optional protein: string | string[]

transcript?

optional transcript: string | string[]

exons?

optional exons: MyGeneExon[]

Defined in: config.ts:41

generif?

optional generif: GeneRIF | GeneRIF[]

Defined in: config.ts:51

genomic_pos?

optional genomic_pos: GenomicPosition | GenomicPosition[]

Defined in: config.ts:34

interpro?

optional interpro: MyGeneInterproDomain | MyGeneInterproDomain[]

Defined in: config.ts:40

name

name: string

Defined in: config.ts:31

pathway?

optional pathway: object

Defined in: config.ts:35

kegg?

optional kegg: MyGenePathway | MyGenePathway[]

reactome?

optional reactome: MyGenePathway | MyGenePathway[]

wikipathways?

optional wikipathways: MyGenePathway | MyGenePathway[]

pdb?

optional pdb: string | string[]

Defined in: config.ts:47

query

query: string

Defined in: config.ts:29

summary?

optional summary: string

Defined in: config.ts:32

symbol

symbol: string

Defined in: config.ts:30

taxid

taxid: number

Defined in: config.ts:33

wikipedia?

optional wikipedia: object

Defined in: config.ts:48

url_stub?

optional url_stub: string

---

MyGeneInterproDomain

Defined in: config.ts:15

Properties

desc

desc: string

Defined in: config.ts:16

id

id: string

Defined in: config.ts:17

short_desc

short_desc: string

Defined in: config.ts:18

---

MyGenePathway

Defined in: config.ts:10

Properties

id

id: string

Defined in: config.ts:12

name

name: string

Defined in: config.ts:11

---

TooltipDisplayConfig

Defined in: config.ts:58

Properties

collapsedByDefault?

optional collapsedByDefault: boolean

Defined in: config.ts:71

collapsible?

optional collapsible: boolean

Defined in: config.ts:70

domains

domains: SectionVisibility

Defined in: config.ts:64

generifs

generifs: SectionVisibility

Defined in: config.ts:68

geneTrack

geneTrack: SectionVisibility

Defined in: config.ts:65

ideogram

ideogram: boolean

Defined in: config.ts:62

links

links: object

Defined in: config.ts:72

ensembl?

optional ensembl: boolean

ncbi?

optional ncbi: boolean

wikipedia?

optional wikipedia: boolean

linksSection

linksSection: SectionVisibility

Defined in: config.ts:69

location

location: SectionVisibility

Defined in: config.ts:61

pathways

pathways: SectionVisibility

Defined in: config.ts:63

species

species: boolean

Defined in: config.ts:60

structures

structures: SectionVisibility

Defined in: config.ts:67

summary

summary: SectionVisibility

Defined in: config.ts:59

transcripts

transcripts: SectionVisibility

Defined in: config.ts:66

Type Aliases

SectionVisibility

SectionVisibility = boolean | "expanded" | "collapsed"

Defined in: config.ts:55

Variables

defaultConfig

const defaultConfig: GeneTooltipConfig

Defined in: config.ts:123

Functions

mergeConfig()

mergeConfig(userConfig): GeneTooltipConfig

Defined in: config.ts:203

Parameters

userConfig

Partial<GeneTooltipConfig> = {}

Returns

GeneTooltipConfig