/
FeatureDensityMixin.tsx
213 lines (201 loc) · 5.72 KB
/
FeatureDensityMixin.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/* eslint-disable @typescript-eslint/no-explicit-any */
import React from 'react'
import { getConf } from '@jbrowse/core/configuration'
import { getContainingView } from '@jbrowse/core/util'
import { FeatureDensityStats } from '@jbrowse/core/data_adapters/BaseAdapter'
import { Region } from '@jbrowse/core/util/types'
import { autorun } from 'mobx'
import { addDisposer, isAlive, types } from 'mobx-state-tree'
// locals
import { LinearGenomeViewModel } from '../../LinearGenomeView'
import TooLargeMessage from '../components/TooLargeMessage'
import { getDisplayStr, getFeatureDensityStatsPre } from './util'
import autorunFeatureDensityStats from './autorunFeatureDensityStats'
type LGV = LinearGenomeViewModel
/**
* #stateModel FeatureDensityMixin
* #category display
*/
export default function FeatureDensityMixin() {
return types
.model({
/**
* #property
*/
userBpPerPxLimit: types.maybe(types.number),
/**
* #property
*/
userByteSizeLimit: types.maybe(types.number),
})
.volatile(() => ({
featureDensityStatsP: undefined as
| undefined
| Promise<FeatureDensityStats>,
featureDensityStats: undefined as undefined | FeatureDensityStats,
currStatsBpPerPx: 0,
}))
.views(self => ({
/**
* #getter
*/
get currentBytesRequested() {
return self.featureDensityStats?.bytes || 0
},
/**
* #getter
*/
get currentFeatureScreenDensity() {
const view = getContainingView(self) as LGV
return (self.featureDensityStats?.featureDensity || 0) * view.bpPerPx
},
/**
* #getter
*/
get maxFeatureScreenDensity() {
// @ts-expect-error
return getConf(self, 'maxFeatureScreenDensity')
},
/**
* #getter
*/
get featureDensityStatsReady() {
const view = getContainingView(self) as LGV
return (
self.currStatsBpPerPx === view.bpPerPx &&
(!!self.featureDensityStats || !!self.userBpPerPxLimit)
)
},
/**
* #getter
*/
get maxAllowableBytes() {
return (
self.userByteSizeLimit ||
self.featureDensityStats?.fetchSizeLimit ||
// @ts-expect-error
(getConf(self, 'fetchSizeLimit') as number)
)
},
}))
.actions(self => ({
afterAttach() {
addDisposer(
self,
autorun(() => autorunFeatureDensityStats(self as any)),
)
},
}))
.actions(self => ({
/**
* #action
*/
setCurrStatsBpPerPx(n: number) {
self.currStatsBpPerPx = n
},
/**
* #action
*/
setFeatureDensityStatsLimit(stats?: FeatureDensityStats) {
const view = getContainingView(self) as LGV
if (stats?.bytes) {
self.userByteSizeLimit = stats.bytes
} else {
self.userBpPerPxLimit = view.bpPerPx
}
},
/**
* #action
*/
async getFeatureDensityStats() {
if (!self.featureDensityStatsP) {
self.featureDensityStatsP = getFeatureDensityStatsPre(
self as any,
).catch(e => {
if (isAlive(self)) {
this.setFeatureDensityStatsP(undefined)
}
throw e
})
}
return self.featureDensityStatsP
},
/**
* #action
*/
setFeatureDensityStatsP(arg: any) {
self.featureDensityStatsP = arg
},
/**
* #action
*/
setFeatureDensityStats(featureDensityStats?: FeatureDensityStats) {
self.featureDensityStats = featureDensityStats
},
/**
* #action
*/
clearFeatureDensityStats() {
self.featureDensityStatsP = undefined
self.featureDensityStats = undefined
},
}))
.views(self => ({
/**
* #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
*/
get regionTooLarge() {
const view = getContainingView(self) as LGV
if (
!self.featureDensityStatsReady ||
view.dynamicBlocks.totalBp < 20_000
) {
return false
}
return (
self.currentBytesRequested > self.maxAllowableBytes ||
(self.userBpPerPxLimit
? view.bpPerPx > self.userBpPerPxLimit
: self.currentFeatureScreenDensity > self.maxFeatureScreenDensity)
)
},
/**
* #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
*/
get regionTooLargeReason() {
const req = self.currentBytesRequested
const max = self.maxAllowableBytes
return req && req > max
? `Requested too much data (${getDisplayStr(req)})`
: ''
},
}))
.views(self => ({
/**
* #method
*/
regionCannotBeRenderedText(_region: Region) {
return self.regionTooLarge ? '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.
* string of text describes why it cannot be rendered
* react node allows user to force load at current setting
*/
regionCannotBeRendered(_region: Region) {
return self.regionTooLarge ? (
<TooLargeMessage model={self as any} />
) : null
},
}))
}