@internetarchive/histogram-date-range 1.3.0 → 1.3.1-alpha-webdev7745.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1080 +1,1094 @@
1
- import '@internetarchive/ia-activity-indicator';
2
- import dayjs from 'dayjs/esm';
3
- import customParseFormat from 'dayjs/esm/plugin/customParseFormat';
4
- import {
5
- css,
6
- html,
7
- LitElement,
8
- nothing,
9
- PropertyValues,
10
- svg,
11
- SVGTemplateResult,
12
- TemplateResult,
13
- } from 'lit';
14
- import { customElement, property, state } from 'lit/decorators.js';
15
- import { live } from 'lit/directives/live.js';
16
- import { classMap } from 'lit/directives/class-map.js';
17
-
18
- dayjs.extend(customParseFormat);
19
-
20
- // these values can be overridden via the component's HTML (camelCased) attributes
21
- const WIDTH = 180;
22
- const HEIGHT = 40;
23
- const SLIDER_WIDTH = 10;
24
- const TOOLTIP_WIDTH = 125;
25
- const TOOLTIP_HEIGHT = 30;
26
- const DATE_FORMAT = 'YYYY';
27
- const MISSING_DATA = 'no data';
28
- const UPDATE_DEBOUNCE_DELAY_MS = 0;
29
-
30
- // this constant is not set up to be overridden
31
- const SLIDER_CORNER_SIZE = 4;
32
-
33
- // these CSS custom props can be overridden from the HTML that is invoking this component
34
- const sliderColor = css`var(--histogramDateRangeSliderColor, #4B65FE)`;
35
- const selectedRangeColor = css`var(--histogramDateRangeSelectedRangeColor, #DBE0FF)`;
36
- const barIncludedFill = css`var(--histogramDateRangeBarIncludedFill, #2C2C2C)`;
37
- const activityIndicatorColor = css`var(--histogramDateRangeActivityIndicator, #2C2C2C)`;
38
- const barExcludedFill = css`var(--histogramDateRangeBarExcludedFill, #CCCCCC)`;
39
- const inputRowMargin = css`var(--histogramDateRangeInputRowMargin, 0)`;
40
- const inputBorder = css`var(--histogramDateRangeInputBorder, 0.5px solid #2C2C2C)`;
41
- const inputWidth = css`var(--histogramDateRangeInputWidth, 35px)`;
42
- const inputFontSize = css`var(--histogramDateRangeInputFontSize, 1.2rem)`;
43
- const inputFontFamily = css`var(--histogramDateRangeInputFontFamily, sans-serif)`;
44
- const tooltipBackgroundColor = css`var(--histogramDateRangeTooltipBackgroundColor, #2C2C2C)`;
45
- const tooltipTextColor = css`var(--histogramDateRangeTooltipTextColor, #FFFFFF)`;
46
- const tooltipFontSize = css`var(--histogramDateRangeTooltipFontSize, 1.1rem)`;
47
- const tooltipFontFamily = css`var(--histogramDateRangeTooltipFontFamily, sans-serif)`;
48
-
49
- type SliderId = 'slider-min' | 'slider-max';
50
-
51
- export type BinSnappingInterval = 'none' | 'month' | 'year';
52
-
53
- interface HistogramItem {
54
- value: number;
55
- height: number;
56
- binStart: string;
57
- binEnd: string;
58
- tooltip: string;
59
- }
60
-
61
- interface BarDataset extends DOMStringMap {
62
- numItems: string;
63
- binStart: string;
64
- binEnd: string;
65
- }
66
-
67
- @customElement('histogram-date-range')
68
- export class HistogramDateRange extends LitElement {
69
- /* eslint-disable lines-between-class-members */
70
-
71
- // public reactive properties that can be set via HTML attributes
72
- @property({ type: Number }) width = WIDTH;
73
- @property({ type: Number }) height = HEIGHT;
74
- @property({ type: Number }) sliderWidth = SLIDER_WIDTH;
75
- @property({ type: Number }) tooltipWidth = TOOLTIP_WIDTH;
76
- @property({ type: Number }) tooltipHeight = TOOLTIP_HEIGHT;
77
- @property({ type: Number }) updateDelay = UPDATE_DEBOUNCE_DELAY_MS;
78
- @property({ type: String }) dateFormat = DATE_FORMAT;
79
- @property({ type: String }) missingDataMessage = MISSING_DATA;
80
- @property({ type: String }) minDate = '';
81
- @property({ type: String }) maxDate = '';
82
- @property({ type: Boolean }) disabled = false;
83
- @property({ type: Array }) bins: number[] = [];
84
- /** If true, update events will not be canceled by the date inputs receiving focus */
85
- @property({ type: Boolean }) updateWhileFocused = false;
86
-
87
- /**
88
- * What interval bins should be snapped to for determining their time ranges.
89
- * - `none` (default): Bins should each represent an identical duration of time,
90
- * without regard for the actual dates represented.
91
- * - `month`: Bins should each represent one or more full, non-overlapping months.
92
- * The bin ranges will be "snapped" to the nearest month boundaries, which can
93
- * result in bins that represent different amounts of time, particularly if the
94
- * provided bins do not evenly divide the provided date range, or if the months
95
- * represented are of different lengths.
96
- * - `year`: Same as `month`, but snapping to year boundaries instead of months.
97
- */
98
- @property({ type: String }) binSnapping: BinSnappingInterval = 'none';
99
-
100
- // internal reactive properties not exposed as attributes
101
- @state() private _tooltipOffset = 0;
102
- @state() private _tooltipContent?: TemplateResult;
103
- @state() private _tooltipVisible = false;
104
- @state() private _tooltipDateFormat?: string;
105
- @state() private _isDragging = false;
106
- @state() private _isLoading = false;
107
-
108
- // non-reactive properties (changes don't auto-trigger re-rendering)
109
- private _minSelectedDate = '';
110
- private _maxSelectedDate = '';
111
- private _minDateMS = 0;
112
- private _maxDateMS = 0;
113
- private _dragOffset = 0;
114
- private _histWidth = 0;
115
- private _binWidth = 0;
116
- private _currentSlider?: SVGRectElement;
117
- private _histData: HistogramItem[] = [];
118
- private _emitUpdatedEventTimer?: ReturnType<typeof setTimeout>;
119
- private _previousDateRange = '';
120
-
121
- /* eslint-enable lines-between-class-members */
122
-
123
- disconnectedCallback(): void {
124
- this.removeListeners();
125
- super.disconnectedCallback();
126
- }
127
-
128
- willUpdate(changedProps: PropertyValues): void {
129
- // check for changes that would affect bin data calculations
130
- if (
131
- changedProps.has('bins') ||
132
- changedProps.has('minDate') ||
133
- changedProps.has('maxDate') ||
134
- changedProps.has('minSelectedDate') ||
135
- changedProps.has('maxSelectedDate') ||
136
- changedProps.has('width') ||
137
- changedProps.has('height') ||
138
- changedProps.has('binSnapping')
139
- ) {
140
- this.handleDataUpdate();
141
- }
142
- }
143
-
144
- /**
145
- * Set private properties that depend on the attribute bin data
146
- *
147
- * We're caching these values and not using getters to avoid recalculating all
148
- * of the hist data every time the user drags a slider or hovers over a bar
149
- * creating a tooltip.
150
- */
151
- private handleDataUpdate(): void {
152
- if (!this.hasBinData) {
153
- return;
154
- }
155
- this._histWidth = this.width - this.sliderWidth * 2;
156
-
157
- this._minDateMS = this.snapTimestamp(this.getMSFromString(this.minDate));
158
- // NB: The max date string, converted as-is to ms, represents the *start* of the
159
- // final date interval; we want the *end*, so we add any snap interval/offset.
160
- this._maxDateMS =
161
- this.snapTimestamp(
162
- this.getMSFromString(this.maxDate) + this.snapInterval
163
- ) + this.snapEndOffset;
164
-
165
- this._binWidth = this._histWidth / this._numBins;
166
- this._previousDateRange = this.currentDateRangeString;
167
- this._histData = this.calculateHistData();
168
- this.minSelectedDate = this.minSelectedDate
169
- ? this.minSelectedDate
170
- : this.minDate;
171
- this.maxSelectedDate = this.maxSelectedDate
172
- ? this.maxSelectedDate
173
- : this.maxDate;
174
- }
175
-
176
- /**
177
- * Rounds the given timestamp to the next full second.
178
- */
179
- private snapToNextSecond(timestamp: number): number {
180
- return Math.ceil(timestamp / 1000) * 1000;
181
- }
182
-
183
- /**
184
- * Rounds the given timestamp to the (approximate) nearest start of a month,
185
- * such that dates up to and including the 15th of the month are rounded down,
186
- * while dates past the 15th are rounded up.
187
- */
188
- private snapToMonth(timestamp: number): number {
189
- const d = new Date(timestamp);
190
- const [year, month, day] = [d.getFullYear(), d.getMonth(), d.getDate()];
191
-
192
- return day < 16 // Obviously only an approximation, but good enough for snapping
193
- ? new Date(year, month, 1).getTime()
194
- : new Date(year, month + 1, 1).getTime();
195
- }
196
-
197
- /**
198
- * Rounds the given timestamp to the (approximate) nearest start of a year,
199
- * such that dates up to the end of June are rounded down, while dates in
200
- * July or later are rounded up.
201
- */
202
- private snapToYear(timestamp: number): number {
203
- const d = new Date(timestamp);
204
- const [year, month] = [d.getFullYear(), d.getMonth()];
205
-
206
- return month < 6 // NB: months are 0-indexed, so 6 = July
207
- ? new Date(year, 0, 1).getTime()
208
- : new Date(year + 1, 0, 1).getTime();
209
- }
210
-
211
- /**
212
- * Rounds the given timestamp according to the `binSnapping` property.
213
- * Default is simply to snap to the nearest full second.
214
- */
215
- private snapTimestamp(timestamp: number): number {
216
- switch (this.binSnapping) {
217
- case 'year':
218
- return this.snapToYear(timestamp);
219
- case 'month':
220
- return this.snapToMonth(timestamp);
221
- case 'none':
222
- default:
223
- // We still align it to second boundaries to resolve minor discrepancies
224
- return this.snapToNextSecond(timestamp);
225
- }
226
- }
227
-
228
- private calculateHistData(): HistogramItem[] {
229
- const { bins, height, dateRangeMS, _numBins, _minDateMS } = this;
230
- const minValue = Math.min(...this.bins);
231
- const maxValue = Math.max(...this.bins);
232
- // if there is no difference between the min and max values, use a range of
233
- // 1 because log scaling will fail if the range is 0
234
- const valueRange = minValue === maxValue ? 1 : Math.log1p(maxValue);
235
- const valueScale = height / valueRange;
236
- const dateScale = dateRangeMS / _numBins;
237
-
238
- return bins.map((v: number, i: number) => {
239
- const binStartMS = this.snapTimestamp(i * dateScale + _minDateMS);
240
- const binStart = this.formatDate(binStartMS);
241
-
242
- const binEndMS =
243
- this.snapTimestamp((i + 1) * dateScale + _minDateMS) +
244
- this.snapEndOffset;
245
- const binEnd = this.formatDate(binEndMS);
246
-
247
- const tooltipStart = this.formatDate(binStartMS, this.tooltipDateFormat);
248
- const tooltipEnd = this.formatDate(binEndMS, this.tooltipDateFormat);
249
- // If start/end are the same, just render a single value
250
- const tooltip =
251
- tooltipStart === tooltipEnd
252
- ? tooltipStart
253
- : `${tooltipStart} - ${tooltipEnd}`;
254
-
255
- return {
256
- value: v,
257
- // use log scaling for the height of the bar to prevent tall bars from
258
- // making the smaller ones too small to see
259
- height: Math.floor(Math.log1p(v) * valueScale),
260
- binStart,
261
- binEnd,
262
- tooltip,
263
- };
264
- });
265
- }
266
-
267
- private get hasBinData(): boolean {
268
- return this._numBins > 0;
269
- }
270
-
271
- private get _numBins(): number {
272
- if (!this.bins || !this.bins.length) {
273
- return 0;
274
- }
275
- return this.bins.length;
276
- }
277
-
278
- private get histogramLeftEdgeX(): number {
279
- return this.sliderWidth;
280
- }
281
-
282
- private get histogramRightEdgeX(): number {
283
- return this.width - this.sliderWidth;
284
- }
285
-
286
- /**
287
- * Approximate size in ms of the interval to which bins are snapped.
288
- */
289
- private get snapInterval(): number {
290
- const yearMS = 31_536_000_000; // A 365-day approximation of ms in a year
291
- const monthMS = 2_592_000_000; // A 30-day approximation of ms in a month
292
- switch (this.binSnapping) {
293
- case 'year':
294
- return yearMS;
295
- case 'month':
296
- return monthMS;
297
- case 'none':
298
- default:
299
- return 0;
300
- }
301
- }
302
-
303
- /**
304
- * Offset added to the end of each bin to ensure disjoint intervals,
305
- * depending on whether snapping is enabled and there are multiple bins.
306
- */
307
- private get snapEndOffset(): number {
308
- return this.binSnapping !== 'none' && this._numBins > 1 ? -1 : 0;
309
- }
310
-
311
- /**
312
- * Optional date format to use for tooltips only.
313
- * Falls back to `dateFormat` if not provided.
314
- */
315
- @property({ type: String }) get tooltipDateFormat(): string {
316
- return this._tooltipDateFormat ?? this.dateFormat;
317
- }
318
-
319
- set tooltipDateFormat(value: string) {
320
- this._tooltipDateFormat = value;
321
- }
322
-
323
- /** component's loading (and disabled) state */
324
- @property({ type: Boolean }) get loading(): boolean {
325
- return this._isLoading;
326
- }
327
-
328
- set loading(value: boolean) {
329
- this.disabled = value;
330
- this._isLoading = value;
331
- }
332
-
333
- /** formatted minimum date of selected date range */
334
- @property() get minSelectedDate(): string {
335
- return this.formatDate(this.getMSFromString(this._minSelectedDate));
336
- }
337
-
338
- /** updates minSelectedDate if new date is valid */
339
- set minSelectedDate(rawDate: string) {
340
- if (!this._minSelectedDate) {
341
- // because the values needed to calculate valid max/min values are not
342
- // available during the lit init when it's populating properties from
343
- // attributes, fall back to just the raw date if nothing is already set
344
- this._minSelectedDate = rawDate;
345
- return;
346
- }
347
- const proposedDateMS = this.getMSFromString(rawDate);
348
- const isValidDate = !Number.isNaN(proposedDateMS);
349
- const isNotTooRecent =
350
- proposedDateMS <= this.getMSFromString(this.maxSelectedDate);
351
- if (isValidDate && isNotTooRecent) {
352
- this._minSelectedDate = this.formatDate(proposedDateMS);
353
- }
354
- this.requestUpdate();
355
- }
356
-
357
- /** formatted maximum date of selected date range */
358
- @property() get maxSelectedDate(): string {
359
- return this.formatDate(this.getMSFromString(this._maxSelectedDate));
360
- }
361
-
362
- /** updates maxSelectedDate if new date is valid */
363
- set maxSelectedDate(rawDate: string) {
364
- if (!this._maxSelectedDate) {
365
- // because the values needed to calculate valid max/min values are not
366
- // available during the lit init when it's populating properties from
367
- // attributes, fall back to just the raw date if nothing is already set
368
- this._maxSelectedDate = rawDate;
369
- return;
370
- }
371
- const proposedDateMS = this.getMSFromString(rawDate);
372
- const isValidDate = !Number.isNaN(proposedDateMS);
373
- const isNotTooOld =
374
- proposedDateMS >= this.getMSFromString(this.minSelectedDate);
375
- if (isValidDate && isNotTooOld) {
376
- this._maxSelectedDate = this.formatDate(proposedDateMS);
377
- }
378
- this.requestUpdate();
379
- }
380
-
381
- /** horizontal position of min date slider */
382
- get minSliderX(): number {
383
- const x = this.translateDateToPosition(this.minSelectedDate);
384
- return this.validMinSliderX(x);
385
- }
386
-
387
- /** horizontal position of max date slider */
388
- get maxSliderX(): number {
389
- const maxSelectedDateMS = this.snapTimestamp(
390
- this.getMSFromString(this.maxSelectedDate) + this.snapInterval
391
- );
392
- const x = this.translateDateToPosition(this.formatDate(maxSelectedDateMS));
393
- return this.validMaxSliderX(x);
394
- }
395
-
396
- private get dateRangeMS(): number {
397
- return this._maxDateMS - this._minDateMS;
398
- }
399
-
400
- private showTooltip(e: PointerEvent): void {
401
- if (this._isDragging || this.disabled) {
402
- return;
403
- }
404
- const target = e.currentTarget as SVGRectElement;
405
- const x = target.x.baseVal.value + this.sliderWidth / 2;
406
- const dataset = target.dataset as BarDataset;
407
- const itemsText = `item${dataset.numItems !== '1' ? 's' : ''}`;
408
- const formattedNumItems = Number(dataset.numItems).toLocaleString();
409
-
410
- this._tooltipOffset =
411
- x + (this._binWidth - this.sliderWidth - this.tooltipWidth) / 2;
412
-
413
- this._tooltipContent = html`
414
- ${formattedNumItems} ${itemsText}<br />
415
- ${dataset.tooltip}
416
- `;
417
- this._tooltipVisible = true;
418
- }
419
-
420
- private hideTooltip(): void {
421
- this._tooltipContent = undefined;
422
- this._tooltipVisible = false;
423
- }
424
-
425
- // use arrow functions (rather than standard JS class instance methods) so
426
- // that `this` is bound to the histogramDateRange object and not the event
427
- // target. for more info see
428
- // https://lit-element.polymer-project.org/guide/events#using-this-in-event-listeners
429
- private drag = (e: PointerEvent): void => {
430
- // prevent selecting text or other ranges while dragging, especially in Safari
431
- e.preventDefault();
432
- if (this.disabled) {
433
- return;
434
- }
435
- this.setDragOffset(e);
436
- this._isDragging = true;
437
- this.addListeners();
438
- this.cancelPendingUpdateEvent();
439
- };
440
-
441
- private drop = (): void => {
442
- if (this._isDragging) {
443
- this.removeListeners();
444
- this.beginEmitUpdateProcess();
445
- }
446
- this._isDragging = false;
447
- };
448
-
449
- /**
450
- * Adjust the date range based on slider movement
451
- *
452
- * @param e PointerEvent from the slider being moved
453
- */
454
- private move = (e: PointerEvent): void => {
455
- const histogramClientX = this.getBoundingClientRect().x;
456
- const newX = e.clientX - histogramClientX - this._dragOffset;
457
- const slider = this._currentSlider as SVGRectElement;
458
- if ((slider.id as SliderId) === 'slider-min') {
459
- this.minSelectedDate = this.translatePositionToDate(
460
- this.validMinSliderX(newX)
461
- );
462
- } else {
463
- this.maxSelectedDate = this.translatePositionToDate(
464
- this.validMaxSliderX(newX)
465
- );
466
- if (this.getMSFromString(this.maxSelectedDate) > this._maxDateMS) {
467
- this.maxSelectedDate = this.maxDate;
468
- }
469
- }
470
- };
471
-
472
- /**
473
- * Constrain a proposed value for the minimum (left) slider
474
- *
475
- * If the value is less than the leftmost valid position, then set it to the
476
- * left edge of the histogram (ie the slider width). If the value is greater
477
- * than the rightmost valid position (the position of the max slider), then
478
- * set it to the position of the max slider
479
- */
480
- private validMinSliderX(newX: number): number {
481
- // allow the left slider to go right only to the right slider, even if the
482
- // max selected date is out of range
483
- const rightLimit = Math.min(
484
- this.translateDateToPosition(this.maxSelectedDate),
485
- this.histogramRightEdgeX
486
- );
487
- newX = this.clamp(newX, this.histogramLeftEdgeX, rightLimit);
488
- const isInvalid =
489
- Number.isNaN(newX) || rightLimit < this.histogramLeftEdgeX;
490
- return isInvalid ? this.histogramLeftEdgeX : newX;
491
- }
492
-
493
- /**
494
- * Constrain a proposed value for the maximum (right) slider
495
- *
496
- * If the value is greater than the rightmost valid position, then set it to
497
- * the right edge of the histogram (ie histogram width - slider width). If the
498
- * value is less than the leftmost valid position (the position of the min
499
- * slider), then set it to the position of the min slider
500
- */
501
- private validMaxSliderX(newX: number): number {
502
- // allow the right slider to go left only to the left slider, even if the
503
- // min selected date is out of range
504
- const leftLimit = Math.max(
505
- this.histogramLeftEdgeX,
506
- this.translateDateToPosition(this.minSelectedDate)
507
- );
508
- newX = this.clamp(newX, leftLimit, this.histogramRightEdgeX);
509
- const isInvalid =
510
- Number.isNaN(newX) || leftLimit > this.histogramRightEdgeX;
511
- return isInvalid ? this.histogramRightEdgeX : newX;
512
- }
513
-
514
- private addListeners(): void {
515
- window.addEventListener('pointermove', this.move);
516
- window.addEventListener('pointerup', this.drop);
517
- window.addEventListener('pointercancel', this.drop);
518
- }
519
-
520
- private removeListeners(): void {
521
- window.removeEventListener('pointermove', this.move);
522
- window.removeEventListener('pointerup', this.drop);
523
- window.removeEventListener('pointercancel', this.drop);
524
- }
525
-
526
- /**
527
- * start a timer to emit an update event. this timer can be canceled (and the
528
- * event not emitted) if user drags a slider or focuses a date input within
529
- * the update delay
530
- */
531
- private beginEmitUpdateProcess(): void {
532
- this.cancelPendingUpdateEvent();
533
- this._emitUpdatedEventTimer = setTimeout(() => {
534
- if (this.currentDateRangeString === this._previousDateRange) {
535
- // don't emit duplicate event if no change since last emitted event
536
- return;
537
- }
538
- this._previousDateRange = this.currentDateRangeString;
539
- const options = {
540
- detail: {
541
- minDate: this.minSelectedDate,
542
- maxDate: this.maxSelectedDate,
543
- },
544
- bubbles: true,
545
- composed: true,
546
- };
547
- this.dispatchEvent(new CustomEvent('histogramDateRangeUpdated', options));
548
- }, this.updateDelay);
549
- }
550
-
551
- private cancelPendingUpdateEvent(): void {
552
- if (this._emitUpdatedEventTimer === undefined) {
553
- return;
554
- }
555
- clearTimeout(this._emitUpdatedEventTimer);
556
- this._emitUpdatedEventTimer = undefined;
557
- }
558
-
559
- /**
560
- * find position of pointer in relation to the current slider
561
- */
562
- private setDragOffset(e: PointerEvent): void {
563
- this._currentSlider = e.currentTarget as SVGRectElement;
564
- const sliderX =
565
- (this._currentSlider.id as SliderId) === 'slider-min'
566
- ? this.minSliderX
567
- : this.maxSliderX;
568
- const histogramClientX = this.getBoundingClientRect().x;
569
- this._dragOffset = e.clientX - histogramClientX - sliderX;
570
- }
571
-
572
- /**
573
- * @param x horizontal position of slider
574
- * @returns string representation of date
575
- */
576
- private translatePositionToDate(x: number): string {
577
- // Snap to the nearest second, fixing the case where input like 1/1/2010
578
- // would get translated to 12/31/2009 due to slight discrepancies from
579
- // pixel boundaries and floating point error.
580
- const milliseconds = this.snapToNextSecond(
581
- ((x - this.sliderWidth) * this.dateRangeMS) / this._histWidth
582
- );
583
- return this.formatDate(this._minDateMS + milliseconds);
584
- }
585
-
586
- /**
587
- * Returns slider x-position corresponding to given date
588
- *
589
- * @param date
590
- * @returns x-position of slider
591
- */
592
- private translateDateToPosition(date: string): number {
593
- const milliseconds = this.getMSFromString(date);
594
- return (
595
- this.sliderWidth +
596
- ((milliseconds - this._minDateMS) * this._histWidth) / this.dateRangeMS
597
- );
598
- }
599
-
600
- /** ensure that the returned value is between minValue and maxValue */
601
- private clamp(x: number, minValue: number, maxValue: number): number {
602
- return Math.min(Math.max(x, minValue), maxValue);
603
- }
604
-
605
- private handleInputFocus(): void {
606
- if (!this.updateWhileFocused) {
607
- this.cancelPendingUpdateEvent();
608
- }
609
- }
610
-
611
- private handleMinDateInput(e: Event): void {
612
- const target = e.currentTarget as HTMLInputElement;
613
- if (target.value !== this.minSelectedDate) {
614
- this.minSelectedDate = target.value;
615
- this.beginEmitUpdateProcess();
616
- }
617
- }
618
-
619
- private handleMaxDateInput(e: Event): void {
620
- const target = e.currentTarget as HTMLInputElement;
621
- if (target.value !== this.maxSelectedDate) {
622
- this.maxSelectedDate = target.value;
623
- this.beginEmitUpdateProcess();
624
- }
625
- }
626
-
627
- private handleKeyUp(e: KeyboardEvent): void {
628
- if (e.key === 'Enter') {
629
- const target = e.currentTarget as HTMLInputElement;
630
- target.blur();
631
- if (target.id === 'date-min') {
632
- this.handleMinDateInput(e);
633
- } else if (target.id === 'date-max') {
634
- this.handleMaxDateInput(e);
635
- }
636
- }
637
- }
638
-
639
- private get currentDateRangeString(): string {
640
- return `${this.minSelectedDate}:${this.maxSelectedDate}`;
641
- }
642
-
643
- private getMSFromString(date: unknown): number {
644
- // It's possible that `date` is not a string in certain situations.
645
- // For instance if you use LitElement bindings and the date is `2000`,
646
- // it will be treated as a number instead of a string. This just makes sure
647
- // we're dealing with a string.
648
- const stringified = typeof date === 'string' ? date : String(date);
649
- const digitGroupCount = (stringified.split(/(\d+)/).length - 1) / 2;
650
- if (digitGroupCount === 1) {
651
- // if there's just a single set of digits, assume it's a year
652
- const dateObj = new Date(0, 0); // start at January 1, 1900
653
- dateObj.setFullYear(Number(stringified)); // override year
654
- return dateObj.getTime(); // get time in milliseconds
655
- }
656
- return dayjs(stringified, [this.dateFormat, DATE_FORMAT]).valueOf();
657
- }
658
-
659
- /**
660
- * expand or narrow the selected range by moving the slider nearest the
661
- * clicked bar to the outer edge of the clicked bar
662
- *
663
- * @param e Event click event from a histogram bar
664
- */
665
- private handleBarClick(e: Event): void {
666
- const dataset = (e.currentTarget as SVGRectElement).dataset as BarDataset;
667
- // use the midpoint of the width of the clicked bar to determine which is
668
- // the nearest slider
669
- const clickPosition =
670
- (this.getMSFromString(dataset.binStart) +
671
- this.getMSFromString(dataset.binEnd)) /
672
- 2;
673
- const distanceFromMinSlider = Math.abs(
674
- clickPosition - this.getMSFromString(this.minSelectedDate)
675
- );
676
- const distanceFromMaxSlider = Math.abs(
677
- clickPosition - this.getMSFromString(this.maxSelectedDate)
678
- );
679
- // update the selected range by moving the nearer slider
680
- if (distanceFromMinSlider < distanceFromMaxSlider) {
681
- this.minSelectedDate = dataset.binStart;
682
- } else {
683
- this.maxSelectedDate = dataset.binEnd;
684
- }
685
- this.beginEmitUpdateProcess();
686
- }
687
-
688
- private get minSliderTemplate(): SVGTemplateResult {
689
- // width/height in pixels of curved part of the sliders (like
690
- // border-radius); used as part of a SVG quadratic curve. see
691
- // https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands
692
- const cs = SLIDER_CORNER_SIZE;
693
-
694
- const sliderShape = `
695
- M${this.minSliderX},0
696
- h-${this.sliderWidth - cs}
697
- q-${cs},0 -${cs},${cs}
698
- v${this.height - cs * 2}
699
- q0,${cs} ${cs},${cs}
700
- h${this.sliderWidth - cs}
701
- `;
702
- return this.generateSliderSVG(this.minSliderX, 'slider-min', sliderShape);
703
- }
704
-
705
- private get maxSliderTemplate(): SVGTemplateResult {
706
- const cs = SLIDER_CORNER_SIZE;
707
- const sliderShape = `
708
- M${this.maxSliderX},0
709
- h${this.sliderWidth - cs}
710
- q${cs},0 ${cs},${cs}
711
- v${this.height - cs * 2}
712
- q0,${cs} -${cs},${cs}
713
- h-${this.sliderWidth - cs}
714
- `;
715
- return this.generateSliderSVG(this.maxSliderX, 'slider-max', sliderShape);
716
- }
717
-
718
- private generateSliderSVG(
719
- sliderPositionX: number,
720
- id: SliderId,
721
- sliderShape: string
722
- ): SVGTemplateResult {
723
- // whether the curved part of the slider is facing towards the left (1), ie
724
- // minimum, or facing towards the right (-1), ie maximum
725
- const k = id === 'slider-min' ? 1 : -1;
726
-
727
- const sliderClasses = classMap({
728
- slider: true,
729
- draggable: !this.disabled,
730
- dragging: this._isDragging,
731
- });
732
-
733
- return svg`
734
- <svg
735
- id=${id}
736
- class=${sliderClasses}
737
- @pointerdown=${this.drag}
738
- >
739
- <path d="${sliderShape} z" fill="${sliderColor}" />
740
- <rect
741
- x="${
742
- sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k
743
- }"
744
- y="${this.height / 3}"
745
- width="1"
746
- height="${this.height / 3}"
747
- fill="white"
748
- />
749
- <rect
750
- x="${
751
- sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k
752
- }"
753
- y="${this.height / 3}"
754
- width="1"
755
- height="${this.height / 3}"
756
- fill="white"
757
- />
758
- </svg>
759
- `;
760
- }
761
-
762
- get selectedRangeTemplate(): SVGTemplateResult {
763
- return svg`
764
- <rect
765
- x="${this.minSliderX}"
766
- y="0"
767
- width="${this.maxSliderX - this.minSliderX}"
768
- height="${this.height}"
769
- fill="${selectedRangeColor}"
770
- />`;
771
- }
772
-
773
- get histogramTemplate(): SVGTemplateResult[] {
774
- const xScale = this._histWidth / this._numBins;
775
- const barWidth = xScale - 1;
776
- let x = this.sliderWidth; // start at the left edge of the histogram
777
-
778
- return this._histData.map(data => {
779
- const { minSelectedDate, maxSelectedDate } = this;
780
- const barHeight = data.height;
781
-
782
- const binIsBeforeMin = this.isBefore(data.binEnd, minSelectedDate);
783
- const binIsAfterMax = this.isAfter(data.binStart, maxSelectedDate);
784
- const barFill =
785
- binIsBeforeMin || binIsAfterMax ? barExcludedFill : barIncludedFill;
786
-
787
- // the stroke-dasharray style below creates a transparent border around the
788
- // right edge of the bar, which prevents user from encountering a gap
789
- // between adjacent bars (eg when viewing the tooltips or when trying to
790
- // extend the range by clicking on a bar)
791
- const barStyle = `stroke-dasharray: 0 ${barWidth} ${barHeight} ${barWidth} 0 ${barHeight}`;
792
-
793
- const bar = svg`
794
- <rect
795
- class="bar"
796
- style=${barStyle}
797
- x=${x}
798
- y=${this.height - barHeight}
799
- width=${barWidth}
800
- height=${barHeight}
801
- @pointerenter=${this.showTooltip}
802
- @pointerleave=${this.hideTooltip}
803
- @click=${this.handleBarClick}
804
- fill=${barFill}
805
- data-num-items=${data.value}
806
- data-bin-start=${data.binStart}
807
- data-bin-end=${data.binEnd}
808
- data-tooltip=${data.tooltip}
809
- />`;
810
- x += xScale;
811
- return bar;
812
- });
813
- }
814
-
815
- /** Whether the first arg represents a date strictly before the second arg */
816
- private isBefore(date1: string, date2: string): boolean {
817
- const date1MS = this.getMSFromString(date1);
818
- const date2MS = this.getMSFromString(date2);
819
- return date1MS < date2MS;
820
- }
821
-
822
- /** Whether the first arg represents a date strictly after the second arg */
823
- private isAfter(date1: string, date2: string): boolean {
824
- const date1MS = this.getMSFromString(date1);
825
- const date2MS = this.getMSFromString(date2);
826
- return date1MS > date2MS;
827
- }
828
-
829
- private formatDate(dateMS: number, format: string = this.dateFormat): string {
830
- if (Number.isNaN(dateMS)) {
831
- return '';
832
- }
833
- const date = dayjs(dateMS);
834
- if (date.year() < 1000) {
835
- // years before 1000 don't play well with dayjs custom formatting, so fall
836
- // back to displaying only the year
837
- return String(date.year());
838
- }
839
- return date.format(format);
840
- }
841
-
842
- /**
843
- * NOTE: we are relying on the lit `live` directive in the template to
844
- * ensure that the change to minSelectedDate is noticed and the input value
845
- * gets properly re-rendered. see
846
- * https://lit.dev/docs/templates/directives/#live
847
- */
848
- get minInputTemplate(): TemplateResult {
849
- return html`
850
- <input
851
- id="date-min"
852
- placeholder=${this.dateFormat}
853
- type="text"
854
- @focus=${this.handleInputFocus}
855
- @blur=${this.handleMinDateInput}
856
- @keyup=${this.handleKeyUp}
857
- .value=${live(this.minSelectedDate)}
858
- ?disabled=${this.disabled}
859
- />
860
- `;
861
- }
862
-
863
- get maxInputTemplate(): TemplateResult {
864
- return html`
865
- <input
866
- id="date-max"
867
- placeholder=${this.dateFormat}
868
- type="text"
869
- @focus=${this.handleInputFocus}
870
- @blur=${this.handleMaxDateInput}
871
- @keyup=${this.handleKeyUp}
872
- .value=${live(this.maxSelectedDate)}
873
- ?disabled=${this.disabled}
874
- />
875
- `;
876
- }
877
-
878
- get minLabelTemplate(): TemplateResult {
879
- return html`<label for="date-min" class="sr-only">Minimum date:</label>`;
880
- }
881
-
882
- get maxLabelTemplate(): TemplateResult {
883
- return html`<label for="date-max" class="sr-only">Maximum date:</label>`;
884
- }
885
-
886
- get tooltipTemplate(): TemplateResult {
887
- return html`
888
- <style>
889
- #tooltip {
890
- width: ${this.tooltipWidth}px;
891
- height: ${this.tooltipHeight}px;
892
- top: ${-9 - this.tooltipHeight}px;
893
- left: ${this._tooltipOffset}px;
894
- display: ${this._tooltipVisible ? 'block' : 'none'};
895
- }
896
- #tooltip:after {
897
- left: ${this.tooltipWidth / 2}px;
898
- }
899
- </style>
900
- <div id="tooltip">${this._tooltipContent}</div>
901
- `;
902
- }
903
-
904
- private get noDataTemplate(): TemplateResult {
905
- return html`
906
- <div class="missing-data-message">${this.missingDataMessage}</div>
907
- `;
908
- }
909
-
910
- private get activityIndicatorTemplate(): TemplateResult | typeof nothing {
911
- if (!this.loading) {
912
- return nothing;
913
- }
914
- return html`
915
- <ia-activity-indicator mode="processing"> </ia-activity-indicator>
916
- `;
917
- }
918
-
919
- static styles = css`
920
- .missing-data-message {
921
- text-align: center;
922
- }
923
- #container {
924
- margin: 0;
925
- touch-action: none;
926
- position: relative;
927
- }
928
- .disabled {
929
- opacity: 0.3;
930
- }
931
- ia-activity-indicator {
932
- position: absolute;
933
- left: calc(50% - 10px);
934
- top: 10px;
935
- width: 20px;
936
- height: 20px;
937
- --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
938
- --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
939
- }
940
-
941
- /* prevent selection from interfering with tooltip, especially on mobile */
942
- /* https://stackoverflow.com/a/4407335/1163042 */
943
- .noselect {
944
- -webkit-touch-callout: none; /* iOS Safari */
945
- -webkit-user-select: none; /* Safari */
946
- -moz-user-select: none; /* Old versions of Firefox */
947
- -ms-user-select: none; /* Internet Explorer/Edge */
948
- user-select: none; /* current Chrome, Edge, Opera and Firefox */
949
- }
950
- .bar {
951
- /* create a transparent border around the hist bars to prevent "gaps" and
952
- flickering when moving around between bars. this also helps with handling
953
- clicks on the bars, preventing users from being able to click in between
954
- bars */
955
- stroke: rgba(0, 0, 0, 0);
956
- /* ensure transparent stroke wide enough to cover gap between bars */
957
- stroke-width: 2px;
958
- }
959
- .bar:hover {
960
- /* highlight currently hovered bar */
961
- fill-opacity: 0.7;
962
- }
963
- .disabled .bar:hover {
964
- /* ensure no visual hover interaction when disabled */
965
- fill-opacity: 1;
966
- }
967
- /****** histogram ********/
968
- #tooltip {
969
- position: absolute;
970
- background: ${tooltipBackgroundColor};
971
- color: ${tooltipTextColor};
972
- text-align: center;
973
- border-radius: 3px;
974
- padding: 2px;
975
- font-size: ${tooltipFontSize};
976
- font-family: ${tooltipFontFamily};
977
- touch-action: none;
978
- pointer-events: none;
979
- }
980
- #tooltip:after {
981
- content: '';
982
- position: absolute;
983
- margin-left: -5px;
984
- top: 100%;
985
- /* arrow */
986
- border: 5px solid ${tooltipTextColor};
987
- border-color: ${tooltipBackgroundColor} transparent transparent
988
- transparent;
989
- }
990
- /****** slider ********/
991
- .slider {
992
- shape-rendering: crispEdges; /* So the slider doesn't get blurry if dragged between pixels */
993
- }
994
- .draggable:hover {
995
- cursor: grab;
996
- }
997
- .dragging {
998
- cursor: grabbing !important;
999
- }
1000
- /****** inputs ********/
1001
- #inputs {
1002
- display: flex;
1003
- justify-content: center;
1004
- margin: ${inputRowMargin};
1005
- }
1006
- #inputs .dash {
1007
- position: relative;
1008
- bottom: -1px;
1009
- align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
1010
- }
1011
- input {
1012
- width: ${inputWidth};
1013
- margin: 0 3px;
1014
- border: ${inputBorder};
1015
- border-radius: 2px !important;
1016
- text-align: center;
1017
- font-size: ${inputFontSize};
1018
- font-family: ${inputFontFamily};
1019
- }
1020
- .sr-only {
1021
- position: absolute !important;
1022
- width: 1px !important;
1023
- height: 1px !important;
1024
- margin: 0 !important;
1025
- padding: 0 !important;
1026
- border: 0 !important;
1027
- overflow: hidden !important;
1028
- white-space: nowrap !important;
1029
- clip: rect(1px, 1px, 1px, 1px) !important;
1030
- -webkit-clip-path: inset(50%) !important;
1031
- clip-path: inset(50%) !important;
1032
- }
1033
- `;
1034
-
1035
- render(): TemplateResult {
1036
- if (!this.hasBinData) {
1037
- return this.noDataTemplate;
1038
- }
1039
- return html`
1040
- <div
1041
- id="container"
1042
- class="
1043
- noselect
1044
- ${this._isDragging ? 'dragging' : ''}
1045
- "
1046
- style="width: ${this.width}px"
1047
- >
1048
- ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
1049
- <div
1050
- class="inner-container
1051
- ${this.disabled ? 'disabled' : ''}"
1052
- >
1053
- <svg
1054
- width="${this.width}"
1055
- height="${this.height}"
1056
- @pointerleave="${this.drop}"
1057
- >
1058
- ${this.selectedRangeTemplate}
1059
- <svg id="histogram">${this.histogramTemplate}</svg>
1060
- ${this.minSliderTemplate} ${this.maxSliderTemplate}
1061
- </svg>
1062
- <div id="inputs">
1063
- ${this.minLabelTemplate} ${this.minInputTemplate}
1064
- <div class="dash">-</div>
1065
- ${this.maxLabelTemplate} ${this.maxInputTemplate}
1066
- <slot name="inputs-right-side"></slot>
1067
- </div>
1068
- </div>
1069
- </div>
1070
- `;
1071
- }
1072
- }
1073
-
1074
- // help TypeScript provide strong typing when interacting with DOM APIs
1075
- // https://stackoverflow.com/questions/65148695/lit-element-typescript-project-global-interface-declaration-necessary
1076
- declare global {
1077
- interface HTMLElementTagNameMap {
1078
- 'histogram-date-range': HistogramDateRange;
1079
- }
1080
- }
1
+ import '@internetarchive/ia-activity-indicator';
2
+ import dayjs from 'dayjs/esm';
3
+ import customParseFormat from 'dayjs/esm/plugin/customParseFormat';
4
+ import fixFirstCenturyYears from './plugins/fix-first-century-years';
5
+ import {
6
+ css,
7
+ html,
8
+ LitElement,
9
+ nothing,
10
+ PropertyValues,
11
+ svg,
12
+ SVGTemplateResult,
13
+ TemplateResult,
14
+ } from 'lit';
15
+ import { customElement, property, state } from 'lit/decorators.js';
16
+ import { live } from 'lit/directives/live.js';
17
+ import { classMap } from 'lit/directives/class-map.js';
18
+
19
+ dayjs.extend(customParseFormat);
20
+ dayjs.extend(fixFirstCenturyYears);
21
+
22
+ // these values can be overridden via the component's HTML (camelCased) attributes
23
+ const WIDTH = 180;
24
+ const HEIGHT = 40;
25
+ const SLIDER_WIDTH = 10;
26
+ const TOOLTIP_WIDTH = 125;
27
+ const TOOLTIP_HEIGHT = 30;
28
+ const DATE_FORMAT = 'YYYY';
29
+ const MISSING_DATA = 'no data';
30
+ const UPDATE_DEBOUNCE_DELAY_MS = 0;
31
+
32
+ // this constant is not set up to be overridden
33
+ const SLIDER_CORNER_SIZE = 4;
34
+
35
+ // these CSS custom props can be overridden from the HTML that is invoking this component
36
+ const sliderColor = css`var(--histogramDateRangeSliderColor, #4B65FE)`;
37
+ const selectedRangeColor = css`var(--histogramDateRangeSelectedRangeColor, #DBE0FF)`;
38
+ const barIncludedFill = css`var(--histogramDateRangeBarIncludedFill, #2C2C2C)`;
39
+ const activityIndicatorColor = css`var(--histogramDateRangeActivityIndicator, #2C2C2C)`;
40
+ const barExcludedFill = css`var(--histogramDateRangeBarExcludedFill, #CCCCCC)`;
41
+ const inputRowMargin = css`var(--histogramDateRangeInputRowMargin, 0)`;
42
+ const inputBorder = css`var(--histogramDateRangeInputBorder, 0.5px solid #2C2C2C)`;
43
+ const inputWidth = css`var(--histogramDateRangeInputWidth, 35px)`;
44
+ const inputFontSize = css`var(--histogramDateRangeInputFontSize, 1.2rem)`;
45
+ const inputFontFamily = css`var(--histogramDateRangeInputFontFamily, sans-serif)`;
46
+ const tooltipBackgroundColor = css`var(--histogramDateRangeTooltipBackgroundColor, #2C2C2C)`;
47
+ const tooltipTextColor = css`var(--histogramDateRangeTooltipTextColor, #FFFFFF)`;
48
+ const tooltipFontSize = css`var(--histogramDateRangeTooltipFontSize, 1.1rem)`;
49
+ const tooltipFontFamily = css`var(--histogramDateRangeTooltipFontFamily, sans-serif)`;
50
+
51
+ type SliderId = 'slider-min' | 'slider-max';
52
+
53
+ export type BinSnappingInterval = 'none' | 'month' | 'year';
54
+
55
+ interface HistogramItem {
56
+ value: number;
57
+ height: number;
58
+ binStart: string;
59
+ binEnd: string;
60
+ tooltip: string;
61
+ }
62
+
63
+ interface BarDataset extends DOMStringMap {
64
+ numItems: string;
65
+ binStart: string;
66
+ binEnd: string;
67
+ }
68
+
69
+ @customElement('histogram-date-range')
70
+ export class HistogramDateRange extends LitElement {
71
+ /* eslint-disable lines-between-class-members */
72
+
73
+ // public reactive properties that can be set via HTML attributes
74
+ @property({ type: Number }) width = WIDTH;
75
+ @property({ type: Number }) height = HEIGHT;
76
+ @property({ type: Number }) sliderWidth = SLIDER_WIDTH;
77
+ @property({ type: Number }) tooltipWidth = TOOLTIP_WIDTH;
78
+ @property({ type: Number }) tooltipHeight = TOOLTIP_HEIGHT;
79
+ @property({ type: Number }) updateDelay = UPDATE_DEBOUNCE_DELAY_MS;
80
+ @property({ type: String }) dateFormat = DATE_FORMAT;
81
+ @property({ type: String }) missingDataMessage = MISSING_DATA;
82
+ @property({ type: String }) minDate = '';
83
+ @property({ type: String }) maxDate = '';
84
+ @property({ type: Boolean }) disabled = false;
85
+ @property({ type: Array }) bins: number[] = [];
86
+ /** If true, update events will not be canceled by the date inputs receiving focus */
87
+ @property({ type: Boolean }) updateWhileFocused = false;
88
+
89
+ /**
90
+ * What interval bins should be snapped to for determining their time ranges.
91
+ * - `none` (default): Bins should each represent an identical duration of time,
92
+ * without regard for the actual dates represented.
93
+ * - `month`: Bins should each represent one or more full, non-overlapping months.
94
+ * The bin ranges will be "snapped" to the nearest month boundaries, which can
95
+ * result in bins that represent different amounts of time, particularly if the
96
+ * provided bins do not evenly divide the provided date range, or if the months
97
+ * represented are of different lengths.
98
+ * - `year`: Same as `month`, but snapping to year boundaries instead of months.
99
+ */
100
+ @property({ type: String }) binSnapping: BinSnappingInterval = 'none';
101
+
102
+ // internal reactive properties not exposed as attributes
103
+ @state() private _tooltipOffset = 0;
104
+ @state() private _tooltipContent?: TemplateResult;
105
+ @state() private _tooltipVisible = false;
106
+ @state() private _tooltipDateFormat?: string;
107
+ @state() private _isDragging = false;
108
+ @state() private _isLoading = false;
109
+
110
+ // non-reactive properties (changes don't auto-trigger re-rendering)
111
+ private _minSelectedDate = '';
112
+ private _maxSelectedDate = '';
113
+ private _minDateMS = 0;
114
+ private _maxDateMS = 0;
115
+ private _dragOffset = 0;
116
+ private _histWidth = 0;
117
+ private _binWidth = 0;
118
+ private _currentSlider?: SVGRectElement;
119
+ private _histData: HistogramItem[] = [];
120
+ private _emitUpdatedEventTimer?: ReturnType<typeof setTimeout>;
121
+ private _previousDateRange = '';
122
+
123
+ /* eslint-enable lines-between-class-members */
124
+
125
+ disconnectedCallback(): void {
126
+ this.removeListeners();
127
+ super.disconnectedCallback();
128
+ }
129
+
130
+ willUpdate(changedProps: PropertyValues): void {
131
+ // check for changes that would affect bin data calculations
132
+ if (
133
+ changedProps.has('bins') ||
134
+ changedProps.has('minDate') ||
135
+ changedProps.has('maxDate') ||
136
+ changedProps.has('minSelectedDate') ||
137
+ changedProps.has('maxSelectedDate') ||
138
+ changedProps.has('width') ||
139
+ changedProps.has('height') ||
140
+ changedProps.has('binSnapping')
141
+ ) {
142
+ this.handleDataUpdate();
143
+ }
144
+ }
145
+
146
+ /**
147
+ * Set private properties that depend on the attribute bin data
148
+ *
149
+ * We're caching these values and not using getters to avoid recalculating all
150
+ * of the hist data every time the user drags a slider or hovers over a bar
151
+ * creating a tooltip.
152
+ */
153
+ private handleDataUpdate(): void {
154
+ if (!this.hasBinData) {
155
+ return;
156
+ }
157
+ this._histWidth = this.width - this.sliderWidth * 2;
158
+
159
+ this._minDateMS = this.snapTimestamp(this.getMSFromString(this.minDate));
160
+ // NB: The max date string, converted as-is to ms, represents the *start* of the
161
+ // final date interval; we want the *end*, so we add any snap interval/offset.
162
+ this._maxDateMS =
163
+ this.snapTimestamp(
164
+ this.getMSFromString(this.maxDate) + this.snapInterval
165
+ ) + this.snapEndOffset;
166
+
167
+ this._binWidth = this._histWidth / this._numBins;
168
+ this._previousDateRange = this.currentDateRangeString;
169
+ this._histData = this.calculateHistData();
170
+ this.minSelectedDate = this.minSelectedDate
171
+ ? this.minSelectedDate
172
+ : this.minDate;
173
+ this.maxSelectedDate = this.maxSelectedDate
174
+ ? this.maxSelectedDate
175
+ : this.maxDate;
176
+ }
177
+
178
+ /**
179
+ * Rounds the given timestamp to the next full second.
180
+ */
181
+ private snapToNextSecond(timestamp: number): number {
182
+ return Math.ceil(timestamp / 1000) * 1000;
183
+ }
184
+
185
+ /**
186
+ * Rounds the given timestamp to the (approximate) nearest start of a month,
187
+ * such that dates up to and including the 15th of the month are rounded down,
188
+ * while dates past the 15th are rounded up.
189
+ */
190
+ private snapToMonth(timestamp: number): number {
191
+ const d = dayjs(timestamp);
192
+ const monthsToAdd = d.date() < 16 ? 0 : 1;
193
+ const snapped = d
194
+ .add(monthsToAdd, 'month')
195
+ .date(1)
196
+ .hour(0)
197
+ .minute(0)
198
+ .second(0)
199
+ .millisecond(0); // First millisecond of the month
200
+ return snapped.valueOf();
201
+ }
202
+
203
+ /**
204
+ * Rounds the given timestamp to the (approximate) nearest start of a year,
205
+ * such that dates up to the end of June are rounded down, while dates in
206
+ * July or later are rounded up.
207
+ */
208
+ private snapToYear(timestamp: number): number {
209
+ const d = dayjs(timestamp);
210
+ const yearsToAdd = d.month() < 6 ? 0 : 1;
211
+ const snapped = d
212
+ .add(yearsToAdd, 'year')
213
+ .month(0)
214
+ .date(1)
215
+ .hour(0)
216
+ .minute(0)
217
+ .second(0)
218
+ .millisecond(0); // First millisecond of the year
219
+ return snapped.valueOf();
220
+ }
221
+
222
+ /**
223
+ * Rounds the given timestamp according to the `binSnapping` property.
224
+ * Default is simply to snap to the nearest full second.
225
+ */
226
+ private snapTimestamp(timestamp: number): number {
227
+ switch (this.binSnapping) {
228
+ case 'year':
229
+ return this.snapToYear(timestamp);
230
+ case 'month':
231
+ return this.snapToMonth(timestamp);
232
+ case 'none':
233
+ default:
234
+ // We still align it to second boundaries to resolve minor discrepancies
235
+ return this.snapToNextSecond(timestamp);
236
+ }
237
+ }
238
+
239
+ private calculateHistData(): HistogramItem[] {
240
+ const { bins, height, dateRangeMS, _numBins, _minDateMS } = this;
241
+ const minValue = Math.min(...this.bins);
242
+ const maxValue = Math.max(...this.bins);
243
+ // if there is no difference between the min and max values, use a range of
244
+ // 1 because log scaling will fail if the range is 0
245
+ const valueRange = minValue === maxValue ? 1 : Math.log1p(maxValue);
246
+ const valueScale = height / valueRange;
247
+ const dateScale = dateRangeMS / _numBins;
248
+
249
+ return bins.map((v: number, i: number) => {
250
+ const binStartMS = this.snapTimestamp(i * dateScale + _minDateMS);
251
+ const binStart = this.formatDate(binStartMS);
252
+
253
+ const binEndMS =
254
+ this.snapTimestamp((i + 1) * dateScale + _minDateMS) +
255
+ this.snapEndOffset;
256
+ const binEnd = this.formatDate(binEndMS);
257
+
258
+ const tooltipStart = this.formatDate(binStartMS, this.tooltipDateFormat);
259
+ const tooltipEnd = this.formatDate(binEndMS, this.tooltipDateFormat);
260
+ // If start/end are the same, just render a single value
261
+ const tooltip =
262
+ tooltipStart === tooltipEnd
263
+ ? tooltipStart
264
+ : `${tooltipStart} - ${tooltipEnd}`;
265
+
266
+ return {
267
+ value: v,
268
+ // use log scaling for the height of the bar to prevent tall bars from
269
+ // making the smaller ones too small to see
270
+ height: Math.floor(Math.log1p(v) * valueScale),
271
+ binStart,
272
+ binEnd,
273
+ tooltip,
274
+ };
275
+ });
276
+ }
277
+
278
+ private get hasBinData(): boolean {
279
+ return this._numBins > 0;
280
+ }
281
+
282
+ private get _numBins(): number {
283
+ if (!this.bins || !this.bins.length) {
284
+ return 0;
285
+ }
286
+ return this.bins.length;
287
+ }
288
+
289
+ private get histogramLeftEdgeX(): number {
290
+ return this.sliderWidth;
291
+ }
292
+
293
+ private get histogramRightEdgeX(): number {
294
+ return this.width - this.sliderWidth;
295
+ }
296
+
297
+ /**
298
+ * Approximate size in ms of the interval to which bins are snapped.
299
+ */
300
+ private get snapInterval(): number {
301
+ const yearMS = 31_536_000_000; // A 365-day approximation of ms in a year
302
+ const monthMS = 2_592_000_000; // A 30-day approximation of ms in a month
303
+ switch (this.binSnapping) {
304
+ case 'year':
305
+ return yearMS;
306
+ case 'month':
307
+ return monthMS;
308
+ case 'none':
309
+ default:
310
+ return 0;
311
+ }
312
+ }
313
+
314
+ /**
315
+ * Offset added to the end of each bin to ensure disjoint intervals,
316
+ * depending on whether snapping is enabled and there are multiple bins.
317
+ */
318
+ private get snapEndOffset(): number {
319
+ return this.binSnapping !== 'none' && this._numBins > 1 ? -1 : 0;
320
+ }
321
+
322
+ /**
323
+ * Optional date format to use for tooltips only.
324
+ * Falls back to `dateFormat` if not provided.
325
+ */
326
+ @property({ type: String }) get tooltipDateFormat(): string {
327
+ return this._tooltipDateFormat ?? this.dateFormat;
328
+ }
329
+
330
+ set tooltipDateFormat(value: string) {
331
+ this._tooltipDateFormat = value;
332
+ }
333
+
334
+ /** component's loading (and disabled) state */
335
+ @property({ type: Boolean }) get loading(): boolean {
336
+ return this._isLoading;
337
+ }
338
+
339
+ set loading(value: boolean) {
340
+ this.disabled = value;
341
+ this._isLoading = value;
342
+ }
343
+
344
+ /** formatted minimum date of selected date range */
345
+ @property() get minSelectedDate(): string {
346
+ return this.formatDate(this.getMSFromString(this._minSelectedDate));
347
+ }
348
+
349
+ /** updates minSelectedDate if new date is valid */
350
+ set minSelectedDate(rawDate: string) {
351
+ if (!this._minSelectedDate) {
352
+ // because the values needed to calculate valid max/min values are not
353
+ // available during the lit init when it's populating properties from
354
+ // attributes, fall back to just the raw date if nothing is already set
355
+ this._minSelectedDate = rawDate;
356
+ return;
357
+ }
358
+ const proposedDateMS = this.getMSFromString(rawDate);
359
+ const isValidDate = !Number.isNaN(proposedDateMS);
360
+ const isNotTooRecent =
361
+ proposedDateMS <= this.getMSFromString(this.maxSelectedDate);
362
+ if (isValidDate && isNotTooRecent) {
363
+ this._minSelectedDate = this.formatDate(proposedDateMS);
364
+ }
365
+ this.requestUpdate();
366
+ }
367
+
368
+ /** formatted maximum date of selected date range */
369
+ @property() get maxSelectedDate(): string {
370
+ return this.formatDate(this.getMSFromString(this._maxSelectedDate));
371
+ }
372
+
373
+ /** updates maxSelectedDate if new date is valid */
374
+ set maxSelectedDate(rawDate: string) {
375
+ if (!this._maxSelectedDate) {
376
+ // because the values needed to calculate valid max/min values are not
377
+ // available during the lit init when it's populating properties from
378
+ // attributes, fall back to just the raw date if nothing is already set
379
+ this._maxSelectedDate = rawDate;
380
+ return;
381
+ }
382
+ const proposedDateMS = this.getMSFromString(rawDate);
383
+ const isValidDate = !Number.isNaN(proposedDateMS);
384
+ const isNotTooOld =
385
+ proposedDateMS >= this.getMSFromString(this.minSelectedDate);
386
+ if (isValidDate && isNotTooOld) {
387
+ this._maxSelectedDate = this.formatDate(proposedDateMS);
388
+ }
389
+ this.requestUpdate();
390
+ }
391
+
392
+ /** horizontal position of min date slider */
393
+ get minSliderX(): number {
394
+ const x = this.translateDateToPosition(this.minSelectedDate);
395
+ return this.validMinSliderX(x);
396
+ }
397
+
398
+ /** horizontal position of max date slider */
399
+ get maxSliderX(): number {
400
+ const maxSelectedDateMS = this.snapTimestamp(
401
+ this.getMSFromString(this.maxSelectedDate) + this.snapInterval
402
+ );
403
+ const x = this.translateDateToPosition(this.formatDate(maxSelectedDateMS));
404
+ return this.validMaxSliderX(x);
405
+ }
406
+
407
+ private get dateRangeMS(): number {
408
+ return this._maxDateMS - this._minDateMS;
409
+ }
410
+
411
+ private showTooltip(e: PointerEvent): void {
412
+ if (this._isDragging || this.disabled) {
413
+ return;
414
+ }
415
+ const target = e.currentTarget as SVGRectElement;
416
+ const x = target.x.baseVal.value + this.sliderWidth / 2;
417
+ const dataset = target.dataset as BarDataset;
418
+ const itemsText = `item${dataset.numItems !== '1' ? 's' : ''}`;
419
+ const formattedNumItems = Number(dataset.numItems).toLocaleString();
420
+
421
+ this._tooltipOffset =
422
+ x + (this._binWidth - this.sliderWidth - this.tooltipWidth) / 2;
423
+
424
+ this._tooltipContent = html`
425
+ ${formattedNumItems} ${itemsText}<br />
426
+ ${dataset.tooltip}
427
+ `;
428
+ this._tooltipVisible = true;
429
+ }
430
+
431
+ private hideTooltip(): void {
432
+ this._tooltipContent = undefined;
433
+ this._tooltipVisible = false;
434
+ }
435
+
436
+ // use arrow functions (rather than standard JS class instance methods) so
437
+ // that `this` is bound to the histogramDateRange object and not the event
438
+ // target. for more info see
439
+ // https://lit-element.polymer-project.org/guide/events#using-this-in-event-listeners
440
+ private drag = (e: PointerEvent): void => {
441
+ // prevent selecting text or other ranges while dragging, especially in Safari
442
+ e.preventDefault();
443
+ if (this.disabled) {
444
+ return;
445
+ }
446
+ this.setDragOffset(e);
447
+ this._isDragging = true;
448
+ this.addListeners();
449
+ this.cancelPendingUpdateEvent();
450
+ };
451
+
452
+ private drop = (): void => {
453
+ if (this._isDragging) {
454
+ this.removeListeners();
455
+ this.beginEmitUpdateProcess();
456
+ }
457
+ this._isDragging = false;
458
+ };
459
+
460
+ /**
461
+ * Adjust the date range based on slider movement
462
+ *
463
+ * @param e PointerEvent from the slider being moved
464
+ */
465
+ private move = (e: PointerEvent): void => {
466
+ const histogramClientX = this.getBoundingClientRect().x;
467
+ const newX = e.clientX - histogramClientX - this._dragOffset;
468
+ const slider = this._currentSlider as SVGRectElement;
469
+ if ((slider.id as SliderId) === 'slider-min') {
470
+ this.minSelectedDate = this.translatePositionToDate(
471
+ this.validMinSliderX(newX)
472
+ );
473
+ } else {
474
+ this.maxSelectedDate = this.translatePositionToDate(
475
+ this.validMaxSliderX(newX)
476
+ );
477
+ if (this.getMSFromString(this.maxSelectedDate) > this._maxDateMS) {
478
+ this.maxSelectedDate = this.maxDate;
479
+ }
480
+ }
481
+ };
482
+
483
+ /**
484
+ * Constrain a proposed value for the minimum (left) slider
485
+ *
486
+ * If the value is less than the leftmost valid position, then set it to the
487
+ * left edge of the histogram (ie the slider width). If the value is greater
488
+ * than the rightmost valid position (the position of the max slider), then
489
+ * set it to the position of the max slider
490
+ */
491
+ private validMinSliderX(newX: number): number {
492
+ // allow the left slider to go right only to the right slider, even if the
493
+ // max selected date is out of range
494
+ const rightLimit = Math.min(
495
+ this.translateDateToPosition(this.maxSelectedDate),
496
+ this.histogramRightEdgeX
497
+ );
498
+ newX = this.clamp(newX, this.histogramLeftEdgeX, rightLimit);
499
+ const isInvalid =
500
+ Number.isNaN(newX) || rightLimit < this.histogramLeftEdgeX;
501
+ return isInvalid ? this.histogramLeftEdgeX : newX;
502
+ }
503
+
504
+ /**
505
+ * Constrain a proposed value for the maximum (right) slider
506
+ *
507
+ * If the value is greater than the rightmost valid position, then set it to
508
+ * the right edge of the histogram (ie histogram width - slider width). If the
509
+ * value is less than the leftmost valid position (the position of the min
510
+ * slider), then set it to the position of the min slider
511
+ */
512
+ private validMaxSliderX(newX: number): number {
513
+ // allow the right slider to go left only to the left slider, even if the
514
+ // min selected date is out of range
515
+ const leftLimit = Math.max(
516
+ this.histogramLeftEdgeX,
517
+ this.translateDateToPosition(this.minSelectedDate)
518
+ );
519
+ newX = this.clamp(newX, leftLimit, this.histogramRightEdgeX);
520
+ const isInvalid =
521
+ Number.isNaN(newX) || leftLimit > this.histogramRightEdgeX;
522
+ return isInvalid ? this.histogramRightEdgeX : newX;
523
+ }
524
+
525
+ private addListeners(): void {
526
+ window.addEventListener('pointermove', this.move);
527
+ window.addEventListener('pointerup', this.drop);
528
+ window.addEventListener('pointercancel', this.drop);
529
+ }
530
+
531
+ private removeListeners(): void {
532
+ window.removeEventListener('pointermove', this.move);
533
+ window.removeEventListener('pointerup', this.drop);
534
+ window.removeEventListener('pointercancel', this.drop);
535
+ }
536
+
537
+ /**
538
+ * start a timer to emit an update event. this timer can be canceled (and the
539
+ * event not emitted) if user drags a slider or focuses a date input within
540
+ * the update delay
541
+ */
542
+ private beginEmitUpdateProcess(): void {
543
+ this.cancelPendingUpdateEvent();
544
+ this._emitUpdatedEventTimer = setTimeout(() => {
545
+ if (this.currentDateRangeString === this._previousDateRange) {
546
+ // don't emit duplicate event if no change since last emitted event
547
+ return;
548
+ }
549
+ this._previousDateRange = this.currentDateRangeString;
550
+ const options = {
551
+ detail: {
552
+ minDate: this.minSelectedDate,
553
+ maxDate: this.maxSelectedDate,
554
+ },
555
+ bubbles: true,
556
+ composed: true,
557
+ };
558
+ this.dispatchEvent(new CustomEvent('histogramDateRangeUpdated', options));
559
+ }, this.updateDelay);
560
+ }
561
+
562
+ private cancelPendingUpdateEvent(): void {
563
+ if (this._emitUpdatedEventTimer === undefined) {
564
+ return;
565
+ }
566
+ clearTimeout(this._emitUpdatedEventTimer);
567
+ this._emitUpdatedEventTimer = undefined;
568
+ }
569
+
570
+ /**
571
+ * find position of pointer in relation to the current slider
572
+ */
573
+ private setDragOffset(e: PointerEvent): void {
574
+ this._currentSlider = e.currentTarget as SVGRectElement;
575
+ const sliderX =
576
+ (this._currentSlider.id as SliderId) === 'slider-min'
577
+ ? this.minSliderX
578
+ : this.maxSliderX;
579
+ const histogramClientX = this.getBoundingClientRect().x;
580
+ this._dragOffset = e.clientX - histogramClientX - sliderX;
581
+ }
582
+
583
+ /**
584
+ * @param x horizontal position of slider
585
+ * @returns string representation of date
586
+ */
587
+ private translatePositionToDate(x: number): string {
588
+ // Snap to the nearest second, fixing the case where input like 1/1/2010
589
+ // would get translated to 12/31/2009 due to slight discrepancies from
590
+ // pixel boundaries and floating point error.
591
+ const milliseconds = this.snapToNextSecond(
592
+ ((x - this.sliderWidth) * this.dateRangeMS) / this._histWidth
593
+ );
594
+ return this.formatDate(this._minDateMS + milliseconds);
595
+ }
596
+
597
+ /**
598
+ * Returns slider x-position corresponding to given date
599
+ *
600
+ * @param date
601
+ * @returns x-position of slider
602
+ */
603
+ private translateDateToPosition(date: string): number {
604
+ const milliseconds = this.getMSFromString(date);
605
+ return (
606
+ this.sliderWidth +
607
+ ((milliseconds - this._minDateMS) * this._histWidth) / this.dateRangeMS
608
+ );
609
+ }
610
+
611
+ /** ensure that the returned value is between minValue and maxValue */
612
+ private clamp(x: number, minValue: number, maxValue: number): number {
613
+ return Math.min(Math.max(x, minValue), maxValue);
614
+ }
615
+
616
+ private handleInputFocus(): void {
617
+ if (!this.updateWhileFocused) {
618
+ this.cancelPendingUpdateEvent();
619
+ }
620
+ }
621
+
622
+ private handleMinDateInput(e: Event): void {
623
+ const target = e.currentTarget as HTMLInputElement;
624
+ if (target.value !== this.minSelectedDate) {
625
+ this.minSelectedDate = target.value;
626
+ this.beginEmitUpdateProcess();
627
+ }
628
+ }
629
+
630
+ private handleMaxDateInput(e: Event): void {
631
+ const target = e.currentTarget as HTMLInputElement;
632
+ if (target.value !== this.maxSelectedDate) {
633
+ this.maxSelectedDate = target.value;
634
+ this.beginEmitUpdateProcess();
635
+ }
636
+ }
637
+
638
+ private handleKeyUp(e: KeyboardEvent): void {
639
+ if (e.key === 'Enter') {
640
+ const target = e.currentTarget as HTMLInputElement;
641
+ target.blur();
642
+ if (target.id === 'date-min') {
643
+ this.handleMinDateInput(e);
644
+ } else if (target.id === 'date-max') {
645
+ this.handleMaxDateInput(e);
646
+ }
647
+ }
648
+ }
649
+
650
+ private get currentDateRangeString(): string {
651
+ return `${this.minSelectedDate}:${this.maxSelectedDate}`;
652
+ }
653
+
654
+ private getMSFromString(date: unknown): number {
655
+ // It's possible that `date` is not a string in certain situations.
656
+ // For instance if you use LitElement bindings and the date is `2000`,
657
+ // it will be treated as a number instead of a string. This just makes sure
658
+ // we're dealing with a string.
659
+ const stringified = typeof date === 'string' ? date : String(date);
660
+ const digitGroupCount = (stringified.split(/(\d+)/).length - 1) / 2;
661
+ if (digitGroupCount === 1) {
662
+ // if there's just a single set of digits, assume it's a year
663
+ const dateObj = new Date(0, 0); // start at January 1, 1900
664
+ dateObj.setFullYear(Number(stringified)); // override year
665
+ return dateObj.getTime(); // get time in milliseconds
666
+ }
667
+ return dayjs(stringified, [this.dateFormat, DATE_FORMAT]).valueOf();
668
+ }
669
+
670
+ /**
671
+ * expand or narrow the selected range by moving the slider nearest the
672
+ * clicked bar to the outer edge of the clicked bar
673
+ *
674
+ * @param e Event click event from a histogram bar
675
+ */
676
+ private handleBarClick(e: Event): void {
677
+ const dataset = (e.currentTarget as SVGRectElement).dataset as BarDataset;
678
+ // use the midpoint of the width of the clicked bar to determine which is
679
+ // the nearest slider
680
+ const clickPosition =
681
+ (this.getMSFromString(dataset.binStart) +
682
+ this.getMSFromString(dataset.binEnd)) /
683
+ 2;
684
+ const distanceFromMinSlider = Math.abs(
685
+ clickPosition - this.getMSFromString(this.minSelectedDate)
686
+ );
687
+ const distanceFromMaxSlider = Math.abs(
688
+ clickPosition - this.getMSFromString(this.maxSelectedDate)
689
+ );
690
+ // update the selected range by moving the nearer slider
691
+ if (distanceFromMinSlider < distanceFromMaxSlider) {
692
+ this.minSelectedDate = dataset.binStart;
693
+ } else {
694
+ this.maxSelectedDate = dataset.binEnd;
695
+ }
696
+ this.beginEmitUpdateProcess();
697
+ }
698
+
699
+ private get minSliderTemplate(): SVGTemplateResult {
700
+ // width/height in pixels of curved part of the sliders (like
701
+ // border-radius); used as part of a SVG quadratic curve. see
702
+ // https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands
703
+ const cs = SLIDER_CORNER_SIZE;
704
+
705
+ const sliderShape = `
706
+ M${this.minSliderX},0
707
+ h-${this.sliderWidth - cs}
708
+ q-${cs},0 -${cs},${cs}
709
+ v${this.height - cs * 2}
710
+ q0,${cs} ${cs},${cs}
711
+ h${this.sliderWidth - cs}
712
+ `;
713
+ return this.generateSliderSVG(this.minSliderX, 'slider-min', sliderShape);
714
+ }
715
+
716
+ private get maxSliderTemplate(): SVGTemplateResult {
717
+ const cs = SLIDER_CORNER_SIZE;
718
+ const sliderShape = `
719
+ M${this.maxSliderX},0
720
+ h${this.sliderWidth - cs}
721
+ q${cs},0 ${cs},${cs}
722
+ v${this.height - cs * 2}
723
+ q0,${cs} -${cs},${cs}
724
+ h-${this.sliderWidth - cs}
725
+ `;
726
+ return this.generateSliderSVG(this.maxSliderX, 'slider-max', sliderShape);
727
+ }
728
+
729
+ private generateSliderSVG(
730
+ sliderPositionX: number,
731
+ id: SliderId,
732
+ sliderShape: string
733
+ ): SVGTemplateResult {
734
+ // whether the curved part of the slider is facing towards the left (1), ie
735
+ // minimum, or facing towards the right (-1), ie maximum
736
+ const k = id === 'slider-min' ? 1 : -1;
737
+
738
+ const sliderClasses = classMap({
739
+ slider: true,
740
+ draggable: !this.disabled,
741
+ dragging: this._isDragging,
742
+ });
743
+
744
+ return svg`
745
+ <svg
746
+ id=${id}
747
+ class=${sliderClasses}
748
+ @pointerdown=${this.drag}
749
+ >
750
+ <path d="${sliderShape} z" fill="${sliderColor}" />
751
+ <rect
752
+ x="${
753
+ sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k
754
+ }"
755
+ y="${this.height / 3}"
756
+ width="1"
757
+ height="${this.height / 3}"
758
+ fill="white"
759
+ />
760
+ <rect
761
+ x="${
762
+ sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k
763
+ }"
764
+ y="${this.height / 3}"
765
+ width="1"
766
+ height="${this.height / 3}"
767
+ fill="white"
768
+ />
769
+ </svg>
770
+ `;
771
+ }
772
+
773
+ get selectedRangeTemplate(): SVGTemplateResult {
774
+ return svg`
775
+ <rect
776
+ x="${this.minSliderX}"
777
+ y="0"
778
+ width="${this.maxSliderX - this.minSliderX}"
779
+ height="${this.height}"
780
+ fill="${selectedRangeColor}"
781
+ />`;
782
+ }
783
+
784
+ get histogramTemplate(): SVGTemplateResult[] {
785
+ const xScale = this._histWidth / this._numBins;
786
+ const barWidth = xScale - 1;
787
+ let x = this.sliderWidth; // start at the left edge of the histogram
788
+
789
+ return this._histData.map(data => {
790
+ const { minSelectedDate, maxSelectedDate } = this;
791
+ const barHeight = data.height;
792
+
793
+ const binIsBeforeMin = this.isBefore(data.binEnd, minSelectedDate);
794
+ const binIsAfterMax = this.isAfter(data.binStart, maxSelectedDate);
795
+ const barFill =
796
+ binIsBeforeMin || binIsAfterMax ? barExcludedFill : barIncludedFill;
797
+
798
+ // the stroke-dasharray style below creates a transparent border around the
799
+ // right edge of the bar, which prevents user from encountering a gap
800
+ // between adjacent bars (eg when viewing the tooltips or when trying to
801
+ // extend the range by clicking on a bar)
802
+ const barStyle = `stroke-dasharray: 0 ${barWidth} ${barHeight} ${barWidth} 0 ${barHeight}`;
803
+
804
+ const bar = svg`
805
+ <rect
806
+ class="bar"
807
+ style=${barStyle}
808
+ x=${x}
809
+ y=${this.height - barHeight}
810
+ width=${barWidth}
811
+ height=${barHeight}
812
+ @pointerenter=${this.showTooltip}
813
+ @pointerleave=${this.hideTooltip}
814
+ @click=${this.handleBarClick}
815
+ fill=${barFill}
816
+ data-num-items=${data.value}
817
+ data-bin-start=${data.binStart}
818
+ data-bin-end=${data.binEnd}
819
+ data-tooltip=${data.tooltip}
820
+ />`;
821
+ x += xScale;
822
+ return bar;
823
+ });
824
+ }
825
+
826
+ /** Whether the first arg represents a date strictly before the second arg */
827
+ private isBefore(date1: string, date2: string): boolean {
828
+ const date1MS = this.getMSFromString(date1);
829
+ const date2MS = this.getMSFromString(date2);
830
+ return date1MS < date2MS;
831
+ }
832
+
833
+ /** Whether the first arg represents a date strictly after the second arg */
834
+ private isAfter(date1: string, date2: string): boolean {
835
+ const date1MS = this.getMSFromString(date1);
836
+ const date2MS = this.getMSFromString(date2);
837
+ return date1MS > date2MS;
838
+ }
839
+
840
+ private formatDate(dateMS: number, format: string = this.dateFormat): string {
841
+ if (Number.isNaN(dateMS)) {
842
+ return '';
843
+ }
844
+ const date = dayjs(dateMS);
845
+ if (date.year() < 1000) {
846
+ // years before 1000 don't play well with dayjs custom formatting, so work around dayjs
847
+ // by setting the year to a sentinel value and then replacing it instead.
848
+ // this is a bit hacky but it does the trick for essentially all reasonable cases
849
+ // until such time as we replace dayjs.
850
+ const tmpDate = date.year(199999);
851
+ return tmpDate.format(format).replace(/199999/g, date.year().toString());
852
+ }
853
+ return date.format(format);
854
+ }
855
+
856
+ /**
857
+ * NOTE: we are relying on the lit `live` directive in the template to
858
+ * ensure that the change to minSelectedDate is noticed and the input value
859
+ * gets properly re-rendered. see
860
+ * https://lit.dev/docs/templates/directives/#live
861
+ */
862
+ get minInputTemplate(): TemplateResult {
863
+ return html`
864
+ <input
865
+ id="date-min"
866
+ placeholder=${this.dateFormat}
867
+ type="text"
868
+ @focus=${this.handleInputFocus}
869
+ @blur=${this.handleMinDateInput}
870
+ @keyup=${this.handleKeyUp}
871
+ .value=${live(this.minSelectedDate)}
872
+ ?disabled=${this.disabled}
873
+ />
874
+ `;
875
+ }
876
+
877
+ get maxInputTemplate(): TemplateResult {
878
+ return html`
879
+ <input
880
+ id="date-max"
881
+ placeholder=${this.dateFormat}
882
+ type="text"
883
+ @focus=${this.handleInputFocus}
884
+ @blur=${this.handleMaxDateInput}
885
+ @keyup=${this.handleKeyUp}
886
+ .value=${live(this.maxSelectedDate)}
887
+ ?disabled=${this.disabled}
888
+ />
889
+ `;
890
+ }
891
+
892
+ get minLabelTemplate(): TemplateResult {
893
+ return html`<label for="date-min" class="sr-only">Minimum date:</label>`;
894
+ }
895
+
896
+ get maxLabelTemplate(): TemplateResult {
897
+ return html`<label for="date-max" class="sr-only">Maximum date:</label>`;
898
+ }
899
+
900
+ get tooltipTemplate(): TemplateResult {
901
+ return html`
902
+ <style>
903
+ #tooltip {
904
+ width: ${this.tooltipWidth}px;
905
+ height: ${this.tooltipHeight}px;
906
+ top: ${-9 - this.tooltipHeight}px;
907
+ left: ${this._tooltipOffset}px;
908
+ display: ${this._tooltipVisible ? 'block' : 'none'};
909
+ }
910
+ #tooltip:after {
911
+ left: ${this.tooltipWidth / 2}px;
912
+ }
913
+ </style>
914
+ <div id="tooltip">${this._tooltipContent}</div>
915
+ `;
916
+ }
917
+
918
+ private get noDataTemplate(): TemplateResult {
919
+ return html`
920
+ <div class="missing-data-message">${this.missingDataMessage}</div>
921
+ `;
922
+ }
923
+
924
+ private get activityIndicatorTemplate(): TemplateResult | typeof nothing {
925
+ if (!this.loading) {
926
+ return nothing;
927
+ }
928
+ return html`
929
+ <ia-activity-indicator mode="processing"> </ia-activity-indicator>
930
+ `;
931
+ }
932
+
933
+ static styles = css`
934
+ .missing-data-message {
935
+ text-align: center;
936
+ }
937
+ #container {
938
+ margin: 0;
939
+ touch-action: none;
940
+ position: relative;
941
+ }
942
+ .disabled {
943
+ opacity: 0.3;
944
+ }
945
+ ia-activity-indicator {
946
+ position: absolute;
947
+ left: calc(50% - 10px);
948
+ top: 10px;
949
+ width: 20px;
950
+ height: 20px;
951
+ --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
952
+ --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
953
+ }
954
+
955
+ /* prevent selection from interfering with tooltip, especially on mobile */
956
+ /* https://stackoverflow.com/a/4407335/1163042 */
957
+ .noselect {
958
+ -webkit-touch-callout: none; /* iOS Safari */
959
+ -webkit-user-select: none; /* Safari */
960
+ -moz-user-select: none; /* Old versions of Firefox */
961
+ -ms-user-select: none; /* Internet Explorer/Edge */
962
+ user-select: none; /* current Chrome, Edge, Opera and Firefox */
963
+ }
964
+ .bar {
965
+ /* create a transparent border around the hist bars to prevent "gaps" and
966
+ flickering when moving around between bars. this also helps with handling
967
+ clicks on the bars, preventing users from being able to click in between
968
+ bars */
969
+ stroke: rgba(0, 0, 0, 0);
970
+ /* ensure transparent stroke wide enough to cover gap between bars */
971
+ stroke-width: 2px;
972
+ }
973
+ .bar:hover {
974
+ /* highlight currently hovered bar */
975
+ fill-opacity: 0.7;
976
+ }
977
+ .disabled .bar:hover {
978
+ /* ensure no visual hover interaction when disabled */
979
+ fill-opacity: 1;
980
+ }
981
+ /****** histogram ********/
982
+ #tooltip {
983
+ position: absolute;
984
+ background: ${tooltipBackgroundColor};
985
+ color: ${tooltipTextColor};
986
+ text-align: center;
987
+ border-radius: 3px;
988
+ padding: 2px;
989
+ font-size: ${tooltipFontSize};
990
+ font-family: ${tooltipFontFamily};
991
+ touch-action: none;
992
+ pointer-events: none;
993
+ }
994
+ #tooltip:after {
995
+ content: '';
996
+ position: absolute;
997
+ margin-left: -5px;
998
+ top: 100%;
999
+ /* arrow */
1000
+ border: 5px solid ${tooltipTextColor};
1001
+ border-color: ${tooltipBackgroundColor} transparent transparent
1002
+ transparent;
1003
+ }
1004
+ /****** slider ********/
1005
+ .slider {
1006
+ shape-rendering: crispEdges; /* So the slider doesn't get blurry if dragged between pixels */
1007
+ }
1008
+ .draggable:hover {
1009
+ cursor: grab;
1010
+ }
1011
+ .dragging {
1012
+ cursor: grabbing !important;
1013
+ }
1014
+ /****** inputs ********/
1015
+ #inputs {
1016
+ display: flex;
1017
+ justify-content: center;
1018
+ margin: ${inputRowMargin};
1019
+ }
1020
+ #inputs .dash {
1021
+ position: relative;
1022
+ bottom: -1px;
1023
+ align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
1024
+ }
1025
+ input {
1026
+ width: ${inputWidth};
1027
+ margin: 0 3px;
1028
+ border: ${inputBorder};
1029
+ border-radius: 2px !important;
1030
+ text-align: center;
1031
+ font-size: ${inputFontSize};
1032
+ font-family: ${inputFontFamily};
1033
+ }
1034
+ .sr-only {
1035
+ position: absolute !important;
1036
+ width: 1px !important;
1037
+ height: 1px !important;
1038
+ margin: 0 !important;
1039
+ padding: 0 !important;
1040
+ border: 0 !important;
1041
+ overflow: hidden !important;
1042
+ white-space: nowrap !important;
1043
+ clip: rect(1px, 1px, 1px, 1px) !important;
1044
+ -webkit-clip-path: inset(50%) !important;
1045
+ clip-path: inset(50%) !important;
1046
+ }
1047
+ `;
1048
+
1049
+ render(): TemplateResult {
1050
+ if (!this.hasBinData) {
1051
+ return this.noDataTemplate;
1052
+ }
1053
+ return html`
1054
+ <div
1055
+ id="container"
1056
+ class="
1057
+ noselect
1058
+ ${this._isDragging ? 'dragging' : ''}
1059
+ "
1060
+ style="width: ${this.width}px"
1061
+ >
1062
+ ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
1063
+ <div
1064
+ class="inner-container
1065
+ ${this.disabled ? 'disabled' : ''}"
1066
+ >
1067
+ <svg
1068
+ width="${this.width}"
1069
+ height="${this.height}"
1070
+ @pointerleave="${this.drop}"
1071
+ >
1072
+ ${this.selectedRangeTemplate}
1073
+ <svg id="histogram">${this.histogramTemplate}</svg>
1074
+ ${this.minSliderTemplate} ${this.maxSliderTemplate}
1075
+ </svg>
1076
+ <div id="inputs">
1077
+ ${this.minLabelTemplate} ${this.minInputTemplate}
1078
+ <div class="dash">-</div>
1079
+ ${this.maxLabelTemplate} ${this.maxInputTemplate}
1080
+ <slot name="inputs-right-side"></slot>
1081
+ </div>
1082
+ </div>
1083
+ </div>
1084
+ `;
1085
+ }
1086
+ }
1087
+
1088
+ // help TypeScript provide strong typing when interacting with DOM APIs
1089
+ // https://stackoverflow.com/questions/65148695/lit-element-typescript-project-global-interface-declaration-necessary
1090
+ declare global {
1091
+ interface HTMLElementTagNameMap {
1092
+ 'histogram-date-range': HistogramDateRange;
1093
+ }
1094
+ }