npm - @internetarchive/histogram-date-range - Versions diffs - 0.1.0 → 0.1.1-alpha - Mend

@internetarchive/histogram-date-range 0.1.0 → 0.1.1-alpha

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.

Files changed (20) hide show

package/demo/index.css +23 -0
package/demo/index.html +37 -31
package/dist/src/histogram-date-range.d.ts +7 -5
package/dist/src/histogram-date-range.js +86 -47
package/dist/src/histogram-date-range.js.map +1 -1
package/dist/test/histogram-date-range.test.js +27 -9
package/dist/test/histogram-date-range.test.js.map +1 -1
package/docs/_snowpack/pkg/common/lit-html-bb3fcd20.js +8 -0
package/docs/_snowpack/pkg/dayjs/esm/plugin/customParseFormat.js +327 -0
package/docs/_snowpack/pkg/import-map.json +1 -0
package/docs/_snowpack/pkg/lit/decorators.js +8 -2
package/docs/_snowpack/pkg/lit/directives/live.js +4 -4
package/docs/_snowpack/pkg/lit.js +6 -6
package/docs/demo/index.css +23 -0
package/docs/demo/index.html +37 -31
package/docs/dist/src/histogram-date-range.js +69 -40
package/package.json +3 -3
package/src/histogram-date-range.ts +108 -53
package/test/histogram-date-range.test.ts +33 -9
package/docs/_snowpack/pkg/common/lit-html-e67c9f49.js +0 -8

package/demo/index.css ADDED Viewed

@@ -0,0 +1,23 @@
+html {
+  font-size: 10px;
+  font-family: sans-serif;
+}
+body {
+  background: white;
+}
+.container {
+  margin-top: 20px;
+  display: grid;
+  justify-content: center;
+}
+.description {
+  margin: 10px auto;
+}
+.received-events {
+  position: absolute;
+  top: 0;
+}
+button {
+  font-size: 100%;
+  margin: 10px auto;
+}

package/demo/index.html CHANGED Viewed

@@ -3,40 +3,16 @@
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta charset="utf-8" />
-    <style>
-      html {
-        font-size: 10px;
-        font-family: sans-serif;
-      }
-      body {
-        background: white;
-      }
-      .container {
-        margin-top: 20px;
-        display: grid;
-        justify-content: center;
-      }
-      .description {
-        margin: 10px auto;
-      }
-      .received-events {
-        position: absolute;
-        top: 0;
-      }
-      button {
-        font-size: 100%;
-        margin: 10px auto;
-      }
-    </style>
+    <link rel="stylesheet" href="index.css">
   </head>
   <script type="module">
     import '../dist/src/histogram-date-range.js';
+    let eventCount = 0;
     // listen to events from the component and display the data received from them
     document.addEventListener('histogramDateRangeUpdated', e => {
-      document.querySelector('.received-events').innerHTML = JSON.stringify(
-        e.detail
-      );
+      document.querySelector('.received-events').innerHTML =
+      ++eventCount + ': ' + JSON.stringify(e.detail);
     });
   </script>
   <body>
@@ -60,6 +36,27 @@
       ></histogram-date-range>
     </div>
+    <div class="container">
+      <div class="description">range spanning negative to positive years</div>
+      <histogram-date-range
+        mindate="-1050" maxdate="2200"
+        bins="[ 74, 67, 17, 66, 49, 93, 47, 61, 32, 46, 53, 2,
+                13, 45, 28, 1, 8, 70, 37, 74, 67, 17, 66, 49, 93,
+                47, 61, 70, 37, 74, 67, 17, 66, 49, 93, 47, 61, 32,
+                32, 70, 37, 74, 67, 17, 66, 49, 93, 47, 61, 32
+              ]"
+      ></histogram-date-range>
+    </div>
+    <div class="container">
+      <div class="description">small year range and few bins</div>
+      <histogram-date-range width="175" tooltipwidth="120"
+        mindate="2008" maxdate="2016" bins="[76104,866978,1151617,986331,218672,107410,3324]">
+      </histogram-date-range>
+    </div>
     <div class="container">
       <div class="description">
         default range with custom styling and date format
@@ -77,8 +74,8 @@
           --histogramDateRangeTooltipFontSize: 1rem;
           --histogramDateRangeInputWidth: 85px;
         "
-        minDate="May 1, 1972"
-        maxDate="12/21/1980"
+        minDate="05 May 1972"
+        maxDate="21 Dec 1980"
         bins="[ 85, 25, 200, 0, 0, 34, 0, 2, 5, 10, 0, 56, 10, 45, 100, 70, 50 ]"
       ></histogram-date-range>
     </div>
@@ -123,9 +120,18 @@
       });
     </script>
+    <!-- <div class="container">
+      <div class="description">
+        single bin
+      </div>
+      <histogram-date-range mindate="1926" maxdate="1926" bins="[8]">
+      </histogram-date-range>
+    </div>
     <div class="container">
       <div class="description">empty data</div>
       <histogram-date-range missingDataMessage="no data..."></histoghistogram-date-range>
-    </div>
+    </div> -->
   </body>
 </html>

package/dist/src/histogram-date-range.d.ts CHANGED Viewed

@@ -47,9 +47,11 @@ export declare class HistogramDateRange extends LitElement {
     set loading(value: boolean);
     /** formatted minimum date of selected date range */
     get minSelectedDate(): string;
+    /** updates minSelectedDate if new date is valid */
     set minSelectedDate(rawDate: string);
     /** formatted maximum date of selected date range */
     get maxSelectedDate(): string;
+    /** updates maxSelectedDate if new date is valid */
     set maxSelectedDate(rawDate: string);
     /** horizontal position of min date slider */
     get minSliderX(): number;
@@ -110,13 +112,13 @@ export declare class HistogramDateRange extends LitElement {
      * @returns x-position of slider
      */
     private translateDateToPosition;
+    /** ensure that the returned value is between minValue and maxValue */
+    private clamp;
     private handleMinDateInput;
     private handleMaxDateInput;
+    private handleKeyUp;
     private get currentDateRangeString();
-    /** minimum selected date in milliseconds */
-    private get minSelectedDateMS();
-    /** maximum selected date in milliseconds */
-    private get maxSelectedDateMS();
+    private getMSFromString;
     private handleBarClick;
     private get minSliderTemplate();
     private get maxSliderTemplate();
@@ -135,7 +137,7 @@ export declare class HistogramDateRange extends LitElement {
     get tooltipTemplate(): TemplateResult;
     private get noDataTemplate();
     private get activityIndicatorTemplate();
-    static styles: import("lit").CSSResultGroup;
+    static styles: import("lit").CSSResult;
     render(): TemplateResult;
 }
 declare global {

package/dist/src/histogram-date-range.js CHANGED Viewed

@@ -3,6 +3,8 @@ import { css, html, nothing, LitElement, svg, } from 'lit';
 import { property, state, customElement } from 'lit/decorators.js';
 import { live } from 'lit/directives/live.js';
 import dayjs from 'dayjs/esm/index.js';
+import customParseFormat from 'dayjs/esm/plugin/customParseFormat';
+dayjs.extend(customParseFormat);
 import '@internetarchive/ia-activity-indicator/ia-activity-indicator';
 // these values can be overridden via the component's HTML (camelCased) attributes
 const WIDTH = 180;
@@ -91,12 +93,11 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         this.move = (e) => {
             const newX = e.offsetX - this._dragOffset;
             const slider = this._currentSlider;
-            const date = this.translatePositionToDate(newX);
             if (slider.id === 'slider-min') {
-                this.minSelectedDate = date;
+                this.minSelectedDate = this.translatePositionToDate(this.validMinSliderX(newX));
             }
             else {
-                this.maxSelectedDate = date;
+                this.maxSelectedDate = this.translatePositionToDate(this.validMaxSliderX(newX));
             }
         };
     }
@@ -127,8 +128,8 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
             return;
         }
         this._histWidth = this.width - this.sliderWidth * 2;
-        this._minDateMS = dayjs(this.minDate).valueOf();
-        this._maxDateMS = dayjs(this.maxDate).valueOf();
+        this._minDateMS = this.getMSFromString(this.minDate);
+        this._maxDateMS = this.getMSFromString(this.maxDate);
         this._binWidth = this._histWidth / this._numBins;
         this._previousDateRange = this.currentDateRangeString;
         this._histData = this.calculateHistData();
@@ -143,11 +144,16 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
     calculateHistData() {
         const minValue = Math.min(...this.bins);
         const maxValue = Math.max(...this.bins);
-        const valueScale = this.height / Math.log1p(maxValue - minValue);
+        // if there is no difference between the min and max values, use a range of
+        // 1 because log scaling will fail if the range is 0
+        const valueRange = minValue === maxValue ? 1 : Math.log1p(maxValue - minValue);
+        const valueScale = this.height / valueRange;
         const dateScale = this.dateRangeMS / this._numBins;
         return this.bins.map((v, i) => {
             return {
                 value: v,
+                // use log scaling for the height of the bar to prevent tall bars from
+                // making the smaller ones too small to see
                 height: Math.floor(Math.log1p(v) * valueScale),
                 binStart: `${this.formatDate(i * dateScale + this._minDateMS)}`,
                 binEnd: `${this.formatDate((i + 1) * dateScale + this._minDateMS)}`,
@@ -173,51 +179,55 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
     }
     /** formatted minimum date of selected date range */
     get minSelectedDate() {
-        return this.formatDate(this._minSelectedDate);
+        return this.formatDate(this.getMSFromString(this._minSelectedDate));
     }
+    /** updates minSelectedDate if new date is valid */
     set minSelectedDate(rawDate) {
         if (!this._minSelectedDate) {
             // because the values needed to calculate valid max/min values are not
             // available during the lit init when it's populating properties from
             // attributes, fall back to just the raw date if nothing is already set
             this._minSelectedDate = rawDate;
+            return;
         }
-        const x = this.translateDateToPosition(rawDate);
-        if (x) {
-            const validX = this.validMinSliderX(x);
-            this._minSelectedDate = this.translatePositionToDate(validX);
+        let ms = this.getMSFromString(rawDate);
+        if (!Number.isNaN(ms)) {
+            ms = Math.min(ms, this.getMSFromString(this._maxSelectedDate));
+            this._minSelectedDate = this.formatDate(ms);
         }
         this.requestUpdate();
     }
     /** formatted maximum date of selected date range */
     get maxSelectedDate() {
-        return this.formatDate(this._maxSelectedDate);
+        return this.formatDate(this.getMSFromString(this._maxSelectedDate));
     }
+    /** updates maxSelectedDate if new date is valid */
     set maxSelectedDate(rawDate) {
         if (!this._maxSelectedDate) {
-            // see comment above in the minSelectedDate setter
+            // because the values needed to calculate valid max/min values are not
+            // available during the lit init when it's populating properties from
+            // attributes, fall back to just the raw date if nothing is already set
             this._maxSelectedDate = rawDate;
+            return;
         }
-        const x = this.translateDateToPosition(rawDate);
-        if (x) {
-            const validX = this.validMaxSliderX(x);
-            this._maxSelectedDate = this.translatePositionToDate(validX);
+        let ms = this.getMSFromString(rawDate);
+        if (!Number.isNaN(ms)) {
+            ms = Math.max(this.getMSFromString(this._minSelectedDate), ms);
+            this._maxSelectedDate = this.formatDate(ms);
         }
         this.requestUpdate();
     }
     /** horizontal position of min date slider */
     get minSliderX() {
-        var _a;
-        return (
         // default to leftmost position if missing or invalid min position
-        (_a = this.translateDateToPosition(this.minSelectedDate)) !== null && _a !== void 0 ? _a : this.sliderWidth);
+        const x = this.translateDateToPosition(this.minSelectedDate);
+        return this.validMinSliderX(x);
     }
     /** horizontal position of max date slider */
     get maxSliderX() {
-        var _a;
-        return (
         // default to rightmost position if missing or invalid max position
-        (_a = this.translateDateToPosition(this.maxSelectedDate)) !== null && _a !== void 0 ? _a : this.width - this.sliderWidth);
+        const x = this.translateDateToPosition(this.maxSelectedDate);
+        return this.validMaxSliderX(x);
     }
     get dateRangeMS() {
         return this._maxDateMS - this._minDateMS;
@@ -230,10 +240,11 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         const x = target.x.baseVal.value + this.sliderWidth / 2;
         const dataset = target.dataset;
         const itemsText = `item${dataset.numItems !== '1' ? 's' : ''}`;
+        const formattedNumItems = Number(dataset.numItems).toLocaleString();
         this._tooltipOffset =
             x + (this._binWidth - this.sliderWidth - this.tooltipWidth) / 2;
         this._tooltipContent = html `
-      ${dataset.numItems} ${itemsText}<br />
+      ${formattedNumItems} ${itemsText}<br />
       ${dataset.binStart} - ${dataset.binEnd}
     `;
         this._tooltipVisible = true;
@@ -251,8 +262,10 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * to the position of the max slider
      */
     validMinSliderX(newX) {
-        const validX = Math.max(newX, this.sliderWidth);
-        return Math.min(validX, this.maxSliderX);
+        if (Number.isNaN(newX)) {
+            return this.sliderWidth;
+        }
+        return this.clamp(newX, this.sliderWidth, this.translateDateToPosition(this.maxSelectedDate));
     }
     /**
      * Constrain a proposed value for the maximum (right) slider
@@ -263,8 +276,10 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * then set it to the position of the min slider
      */
     validMaxSliderX(newX) {
-        const validX = Math.max(newX, this.minSliderX);
-        return Math.min(validX, this.width - this.sliderWidth);
+        if (Number.isNaN(newX)) {
+            return this.width - this.sliderWidth;
+        }
+        return this.clamp(newX, this.translateDateToPosition(this.minSelectedDate), this.width - this.sliderWidth);
     }
     addListeners() {
         window.addEventListener('pointermove', this.move);
@@ -341,10 +356,13 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * @returns x-position of slider
      */
     translateDateToPosition(date) {
-        const milliseconds = dayjs(date).valueOf();
-        const xPosition = this.sliderWidth +
-            ((milliseconds - this._minDateMS) * this._histWidth) / this.dateRangeMS;
-        return isNaN(milliseconds) || isNaN(xPosition) ? null : xPosition;
+        const milliseconds = this.getMSFromString(date);
+        return (this.sliderWidth +
+            ((milliseconds - this._minDateMS) * this._histWidth) / this.dateRangeMS);
+    }
+    /** ensure that the returned value is between minValue and maxValue */
+    clamp(x, minValue, maxValue) {
+        return Math.min(Math.max(x, minValue), maxValue);
     }
     handleMinDateInput(e) {
         const target = e.currentTarget;
@@ -356,25 +374,36 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         this.maxSelectedDate = target.value;
         this.beginEmitUpdateProcess();
     }
+    handleKeyUp(e) {
+        if (e.key === 'Enter') {
+            const target = e.currentTarget;
+            target.blur();
+        }
+    }
     get currentDateRangeString() {
         return `${this.minSelectedDate}:${this.maxSelectedDate}`;
     }
-    /** minimum selected date in milliseconds */
-    get minSelectedDateMS() {
-        return dayjs(this.minSelectedDate).valueOf();
-    }
-    /** maximum selected date in milliseconds */
-    get maxSelectedDateMS() {
-        return dayjs(this.maxSelectedDate).valueOf();
+    getMSFromString(date) {
+        const digitGroupCount = (date.split(/(\d+)/).length - 1) / 2;
+        if (digitGroupCount === 1) {
+            // if there's just a single set of digits, assume it's a year
+            const dateObj = new Date(0, 0); // start at January 1, 1900
+            dateObj.setFullYear(Number(date)); // override year (=> 0099-01-01) = 99 CE
+            return dateObj.getTime(); // get time in milliseconds
+        }
+        return dayjs(date, [this.dateFormat, DATE_FORMAT]).valueOf();
     }
     handleBarClick(e) {
         const dataset = e.currentTarget.dataset;
-        const binStartDateMS = dayjs(dataset.binStart).valueOf();
-        if (binStartDateMS < this.minSelectedDateMS) {
+        const distanceFromMinSlider = this.getMSFromString(dataset.binStart) -
+            this.getMSFromString(this.minSelectedDate);
+        const distanceFromMaxSlider = this.getMSFromString(this.maxSelectedDate) -
+            this.getMSFromString(dataset.binEnd);
+        // update the selection by moving the nearer slider
+        if (distanceFromMinSlider < distanceFromMaxSlider) {
             this.minSelectedDate = dataset.binStart;
         }
-        const binEndDateMS = dayjs(dataset.binEnd).valueOf();
-        if (binEndDateMS > this.maxSelectedDateMS) {
+        else {
             this.maxSelectedDate = dataset.binEnd;
         }
         this.beginEmitUpdateProcess();
@@ -466,7 +495,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
           @pointerenter="${this.showTooltip}"
           @pointerleave="${this.hideTooltip}"
           @click="${this.handleBarClick}"
-          fill="${x >= this.minSliderX && x <= this.maxSliderX
+          fill="${x + barWidth >= this.minSliderX && x <= this.maxSliderX
                 ? barIncludedFill
                 : barExcludedFill}"
           data-num-items="${data.value}"
@@ -477,9 +506,17 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
             return bar;
         });
     }
-    formatDate(rawDate) {
-        const date = dayjs(rawDate);
-        return date.isValid() ? date.format(this.dateFormat) : '';
+    formatDate(dateMS) {
+        if (Number.isNaN(dateMS)) {
+            return '';
+        }
+        const date = dayjs(dateMS);
+        if (date.year() < 1000) {
+            // years before 1000 don't play well with dayjs custom formatting, so fall
+            // back to displaying only the year
+            return String(date.year());
+        }
+        return date.format(this.dateFormat);
     }
     /**
      * NOTE: we are relying on the lit `live` directive in the template to
@@ -495,6 +532,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         type="text"
         @focus="${this.cancelPendingUpdateEvent}"
         @blur="${this.handleMinDateInput}"
+        @keyup="${this.handleKeyUp}"
         .value="${live(this.minSelectedDate)}"
         ?disabled="${this.disabled}"
       />
@@ -508,6 +546,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         type="text"
         @focus="${this.cancelPendingUpdateEvent}"
         @blur="${this.handleMaxDateInput}"
+        @keyup="${this.handleKeyUp}"
         .value="${live(this.maxSelectedDate)}"
         ?disabled="${this.disabled}"
       />