-
Notifications
You must be signed in to change notification settings - Fork 35
/
NumberColumn.ts
488 lines (433 loc) · 14.6 KB
/
NumberColumn.ts
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
import { format } from 'd3-format';
import { equalArrays, IEventListener, ISequence } from '../internal';
import { Category, dialogAddons, SortByDefault, toolbar } from './annotations';
import Column, {
dirty,
dirtyCaches,
dirtyHeader,
dirtyValues,
groupRendererChanged,
labelChanged,
metaDataChanged,
rendererTypeChanged,
summaryRendererChanged,
visibilityChanged,
widthChanged,
DEFAULT_COLOR,
} from './Column';
import { IDataRow, IGroup, ECompareValueType, IValueColumnDesc, ITypeFactory } from './interfaces';
import {
INumberColumn,
EAdvancedSortMethod,
INumberDesc,
INumberFilter,
IMappingFunction,
IColorMappingFunction,
IMapAbleColumn,
} from './INumberColumn';
import { restoreMapping } from './MappingFunction';
import { isMissingValue, isUnknown, missingGroup } from './missing';
import type { dataLoaded } from './ValueColumn';
import ValueColumn from './ValueColumn';
import {
noNumberFilter,
isDummyNumberFilter,
restoreNumberFilter,
toCompareGroupValue,
isEqualNumberFilter,
isNumberIncluded,
} from './internalNumber';
import { integrateDefaults } from './internal';
export declare type INumberColumnDesc = INumberDesc & IValueColumnDesc<number>;
/**
* emitted when the mapping property changes
* @asMemberOf NumberColumn
* @event
*/
export declare function mappingChanged_NC(previous: IMappingFunction, current: IMappingFunction): void;
/**
* emitted when the color mapping property changes
* @asMemberOf NumberColumn
* @event
*/
export declare function colorMappingChanged_NC(previous: IColorMappingFunction, current: IColorMappingFunction): void;
/**
* emitted when the filter property changes
* @asMemberOf NumberColumn
* @event
*/
export declare function filterChanged_NC(previous: INumberFilter | null, current: INumberFilter | null): void;
/**
* emitted when the sort method property changes
* @asMemberOf NumberColumn
* @event
*/
export declare function sortMethodChanged_NC(previous: EAdvancedSortMethod, current: EAdvancedSortMethod): void;
/**
* emitted when the grouping property changes
* @asMemberOf NumberColumn
* @event
*/
export declare function groupingChanged_NC(previous: number[], current: number[]): void;
/**
* a number column mapped from an original input scale to an output range
*/
@toolbar('rename', 'clone', 'sort', 'sortBy', 'groupBy', 'sortGroupBy', 'filterNumber', 'colorMapped', 'editMapping')
@dialogAddons('sortGroup', 'sortNumber')
@dialogAddons('group', 'groupNumber')
@Category('number')
@SortByDefault('descending')
export default class NumberColumn extends ValueColumn<number> implements INumberColumn, IMapAbleColumn {
static readonly EVENT_MAPPING_CHANGED = 'mappingChanged';
static readonly EVENT_COLOR_MAPPING_CHANGED = 'colorMappingChanged';
static readonly EVENT_FILTER_CHANGED = 'filterChanged';
static readonly EVENT_SORTMETHOD_CHANGED = 'sortMethodChanged';
static readonly EVENT_GROUPING_CHANGED = 'groupingChanged';
private mapping: IMappingFunction;
private colorMapping: IColorMappingFunction;
private original: IMappingFunction;
private deriveMapping: readonly boolean[];
/**
* currently active filter
* @private
*/
private currentFilter: INumberFilter = noNumberFilter();
/**
* The accuracy defines the deviation of values to the applied filter boundary.
* Use an accuracy closer to 0 for columns with smaller numbers (e.g., 1e-9).
* @private
*/
private readonly filterAccuracy: number = 0.001;
private readonly numberFormat: (n: number) => string = format('.2f');
private currentGroupThresholds: number[] = [];
private groupSortMethod: EAdvancedSortMethod = EAdvancedSortMethod.median;
constructor(id: string, desc: INumberColumnDesc, factory: ITypeFactory) {
super(
id,
integrateDefaults(desc, {
groupRenderer: 'boxplot',
summaryRenderer: 'histogram',
})
);
this.mapping = restoreMapping(desc, factory);
this.original = this.mapping.clone();
this.deriveMapping = this.mapping.domain.map((d) => d == null || Number.isNaN(d));
this.colorMapping = factory.colorMappingFunction(desc.colorMapping || desc.color);
if (desc.numberFormat) {
this.numberFormat = format(desc.numberFormat);
}
if (desc.filterAccuracy) {
this.filterAccuracy = desc.filterAccuracy;
}
}
getNumberFormat() {
return this.numberFormat;
}
onDataUpdate(rows: ISequence<IDataRow>): void {
super.onDataUpdate(rows);
if (!this.deriveMapping.some(Boolean)) {
return;
}
// hook for listening to data updates
const minMax = rows
.map((row) => this.getRawValue(row))
.reduce(
(acc, v) => {
if (v == null || Number.isNaN(v)) {
return acc;
}
if (v < acc.min) {
acc.min = v;
}
if (v > acc.max) {
acc.max = v;
}
return acc;
},
{ min: Number.POSITIVE_INFINITY, max: Number.NEGATIVE_INFINITY }
);
const domain = this.mapping.domain.slice();
if (this.deriveMapping[0]) {
domain[0] = minMax.min;
}
if (this.deriveMapping[this.deriveMapping.length - 1]) {
domain[domain.length - 1] = minMax.max;
}
this.mapping.domain = domain;
(this.original as IMappingFunction).domain = domain;
}
dump(toDescRef: (desc: any) => any) {
const r = super.dump(toDescRef);
r.map = this.mapping.toJSON();
r.colorMapping = this.colorMapping.toJSON();
r.filter = isDummyNumberFilter(this.currentFilter) ? null : this.currentFilter;
r.groupSortMethod = this.groupSortMethod;
if (this.currentGroupThresholds) {
r.stratifyThresholds = this.currentGroupThresholds;
}
return r;
}
restore(dump: any, factory: ITypeFactory) {
super.restore(dump, factory);
if (dump.map || dump.domain) {
this.mapping = restoreMapping(dump, factory);
}
if (dump.colorMapping) {
this.colorMapping = factory.colorMappingFunction(dump.colorMapping);
}
if (dump.groupSortMethod) {
this.groupSortMethod = dump.groupSortMethod;
}
if (dump.filter) {
this.currentFilter = restoreNumberFilter(dump.filter);
}
if (dump.stratifyThresholds) {
this.currentGroupThresholds = dump.stratifyThresholds;
}
if (dump.stratifyThreshholds) {
this.currentGroupThresholds = dump.stratifyThreshholds;
}
}
protected createEventList() {
return super
.createEventList()
.concat([
NumberColumn.EVENT_MAPPING_CHANGED,
NumberColumn.EVENT_COLOR_MAPPING_CHANGED,
NumberColumn.EVENT_FILTER_CHANGED,
NumberColumn.EVENT_SORTMETHOD_CHANGED,
NumberColumn.EVENT_GROUPING_CHANGED,
]);
}
on(type: typeof NumberColumn.EVENT_MAPPING_CHANGED, listener: typeof mappingChanged_NC | null): this;
on(type: typeof NumberColumn.EVENT_COLOR_MAPPING_CHANGED, listener: typeof colorMappingChanged_NC | null): this;
on(type: typeof NumberColumn.EVENT_FILTER_CHANGED, listener: typeof filterChanged_NC | null): this;
on(type: typeof NumberColumn.EVENT_SORTMETHOD_CHANGED, listener: typeof sortMethodChanged_NC | null): this;
on(type: typeof NumberColumn.EVENT_GROUPING_CHANGED, listener: typeof groupingChanged_NC | null): this;
on(type: typeof ValueColumn.EVENT_DATA_LOADED, listener: typeof dataLoaded | null): this;
on(type: typeof Column.EVENT_WIDTH_CHANGED, listener: typeof widthChanged | null): this;
on(type: typeof Column.EVENT_LABEL_CHANGED, listener: typeof labelChanged | null): this;
on(type: typeof Column.EVENT_METADATA_CHANGED, listener: typeof metaDataChanged | null): this;
on(type: typeof Column.EVENT_DIRTY, listener: typeof dirty | null): this;
on(type: typeof Column.EVENT_DIRTY_HEADER, listener: typeof dirtyHeader | null): this;
on(type: typeof Column.EVENT_DIRTY_VALUES, listener: typeof dirtyValues | null): this;
on(type: typeof Column.EVENT_DIRTY_CACHES, listener: typeof dirtyCaches | null): this;
on(type: typeof Column.EVENT_RENDERER_TYPE_CHANGED, listener: typeof rendererTypeChanged | null): this;
on(type: typeof Column.EVENT_GROUP_RENDERER_TYPE_CHANGED, listener: typeof groupRendererChanged | null): this;
on(type: typeof Column.EVENT_SUMMARY_RENDERER_TYPE_CHANGED, listener: typeof summaryRendererChanged | null): this;
on(type: typeof Column.EVENT_VISIBILITY_CHANGED, listener: typeof visibilityChanged | null): this;
on(type: string | string[], listener: IEventListener | null): this; // required for correct typings in *.d.ts
on(type: string | string[], listener: IEventListener | null): this {
return super.on(type as any, listener);
}
getLabel(row: IDataRow) {
if ((this.desc as any).numberFormat) {
const raw = this.getRawValue(row);
//if a dedicated format and a number use the formatter in any case
if (Number.isNaN(raw)) {
return 'NaN';
}
if (!isFinite(raw)) {
return raw.toString();
}
return this.numberFormat(raw);
}
const v = super.getValue(row);
//keep non number if it is not a number else convert using formatter
if (typeof v === 'number') {
return this.numberFormat(+v);
}
return String(v);
}
getRange() {
return this.mapping.getRange(this.numberFormat);
}
getRawValue(row: IDataRow) {
const v: any = super.getValue(row);
if (isMissingValue(v)) {
return NaN;
}
return +v;
}
getExportValue(row: IDataRow, format: 'text' | 'json'): any {
return format === 'json' ? this.getRawValue(row) : super.getExportValue(row, format);
}
getValue(row: IDataRow) {
const v = this.getNumber(row);
if (Number.isNaN(v)) {
return null;
}
return v;
}
getNumber(row: IDataRow) {
const v = this.getRawValue(row);
if (Number.isNaN(v)) {
return NaN;
}
return this.mapping.apply(v);
}
iterNumber(row: IDataRow) {
return [this.getNumber(row)];
}
iterRawNumber(row: IDataRow) {
return [this.getRawNumber(row)];
}
getRawNumber(row: IDataRow) {
return this.getRawValue(row);
}
toCompareValue(row: IDataRow, valueCache?: any) {
return valueCache != null ? valueCache : this.getNumber(row);
}
toCompareValueType() {
return ECompareValueType.FLOAT;
}
toCompareGroupValue(rows: ISequence<IDataRow>, _group: IGroup, valueCache?: ISequence<any>): number {
return toCompareGroupValue(rows, this, this.groupSortMethod, valueCache);
}
toCompareGroupValueType() {
return ECompareValueType.FLOAT;
}
getOriginalMapping() {
return this.original.clone();
}
getMapping() {
return this.mapping.clone();
}
setMapping(mapping: IMappingFunction) {
if (this.mapping.eq(mapping)) {
return;
}
this.deriveMapping = [];
this.fire(
[
NumberColumn.EVENT_MAPPING_CHANGED,
Column.EVENT_DIRTY_VALUES,
Column.EVENT_DIRTY_CACHES,
Column.EVENT_DIRTY_HEADER,
Column.EVENT_DIRTY,
],
this.mapping.clone(),
(this.mapping = mapping)
);
}
getColor(row: IDataRow) {
const v = this.getNumber(row);
if (Number.isNaN(v)) {
return DEFAULT_COLOR;
}
return this.colorMapping.apply(v);
}
getColorMapping() {
return this.colorMapping.clone();
}
setColorMapping(mapping: IColorMappingFunction) {
if (this.colorMapping.eq(mapping)) {
return;
}
this.fire(
[
NumberColumn.EVENT_COLOR_MAPPING_CHANGED,
Column.EVENT_DIRTY_VALUES,
Column.EVENT_DIRTY_HEADER,
Column.EVENT_DIRTY,
],
this.colorMapping.clone(),
(this.colorMapping = mapping)
);
}
isFiltered() {
return !isDummyNumberFilter(this.currentFilter);
}
getFilter(): INumberFilter {
return Object.assign({}, this.currentFilter);
}
setFilter(value: INumberFilter | null) {
value = value || { min: Number.NEGATIVE_INFINITY, max: Number.POSITIVE_INFINITY, filterMissing: false };
if (isEqualNumberFilter(value, this.currentFilter, this.filterAccuracy)) {
return;
}
const bak = this.getFilter();
this.currentFilter.min = isUnknown(value.min) ? Number.NEGATIVE_INFINITY : value.min;
this.currentFilter.max = isUnknown(value.max) ? Number.POSITIVE_INFINITY : value.max;
this.currentFilter.filterMissing = value.filterMissing;
this.fire(
[NumberColumn.EVENT_FILTER_CHANGED, Column.EVENT_DIRTY_VALUES, Column.EVENT_DIRTY],
bak,
this.getFilter()
);
}
/**
* filter the current row if any filter is set
* @param row
* @returns {boolean}
*/
filter(row: IDataRow) {
return isNumberIncluded(this.currentFilter, this.getRawNumber(row));
}
clearFilter() {
const was = this.isFiltered();
this.setFilter(null);
return was;
}
getGroupThresholds() {
return this.currentGroupThresholds.slice();
}
setGroupThresholds(value: number[]) {
if (equalArrays(this.currentGroupThresholds, value)) {
return;
}
const bak = this.getGroupThresholds();
this.currentGroupThresholds = value.slice();
this.fire([NumberColumn.EVENT_GROUPING_CHANGED, Column.EVENT_DIRTY_VALUES, Column.EVENT_DIRTY], bak, value);
}
group(row: IDataRow): IGroup {
const value = this.getRawNumber(row);
if (Number.isNaN(value)) {
return Object.assign({}, missingGroup);
}
let threshold = this.currentGroupThresholds;
if (threshold.length === 0) {
// default threshold
const d = this.mapping.domain;
threshold = [(d[1] - d[0]) / 2];
}
const thresholdIndex = threshold.findIndex((t) => value <= t);
// group by thresholds / bins
switch (thresholdIndex) {
case -1:
//bigger than the last threshold
return {
name: `${this.label} > ${this.numberFormat(threshold[threshold.length - 1])}`,
color: this.colorMapping.apply(1),
};
case 0:
//smallest
return {
name: `${this.label} <= ${this.numberFormat(threshold[0])}`,
color: this.colorMapping.apply(0),
};
default:
return {
name: `${this.numberFormat(threshold[thresholdIndex - 1])} <= ${this.label} <= ${this.numberFormat(
threshold[thresholdIndex]
)}`,
color: this.colorMapping.apply(
this.mapping.apply((threshold[thresholdIndex - 1] + threshold[thresholdIndex]) / 2)
),
};
}
}
getSortMethod() {
return this.groupSortMethod;
}
setSortMethod(sortMethod: EAdvancedSortMethod) {
if (this.groupSortMethod === sortMethod) {
return;
}
this.fire([NumberColumn.EVENT_SORTMETHOD_CHANGED], this.groupSortMethod, (this.groupSortMethod = sortMethod));
// sort by me if not already sorted by me
if (!this.isGroupSortedByMe().asc) {
this.toggleMyGroupSorting();
}
}
}