@internetarchive/histogram-date-range 1.1.1-alpha.4 → 1.2.1-alpha-webdev7377.0

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

@@ -8,6 +8,8 @@ export declare class HistogramDateRange extends LitElement {
     tooltipHeight: number;
     updateDelay: number;
     dateFormat: string;
+    /** Optional; falls back to `dateFormat` if not provided */
+    tooltipDateFormat?: string;
     missingDataMessage: string;
     minDate: string;
     maxDate: string;
@@ -32,7 +34,7 @@ export declare class HistogramDateRange extends LitElement {
     private _emitUpdatedEventTimer?;
     private _previousDateRange;
     disconnectedCallback(): void;
-    updated(changedProps: PropertyValues): void;
+    willUpdate(changedProps: PropertyValues): void;
     /**
      * Set private properties that depend on the attribute bin data
      *
@@ -46,6 +48,7 @@ export declare class HistogramDateRange extends LitElement {
     private get _numBins();
     private get histogramLeftEdgeX();
     private get histogramRightEdgeX();
+    private get resolvedTooltipDateFormat();
     /** component's loading (and disabled) state */
     get loading(): boolean;
     set loading(value: boolean);

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

@@ -117,7 +117,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         this.removeListeners();
         super.disconnectedCallback();
     }
-    updated(changedProps) {
+    willUpdate(changedProps) {
         // check for changes that would affect bin data calculations
         if (changedProps.has('bins') ||
             changedProps.has('minDate') ||
@@ -152,7 +152,6 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         this.maxSelectedDate = this.maxSelectedDate
             ? this.maxSelectedDate
             : this.maxDate;
-        this.requestUpdate();
     }
     calculateHistData() {
         const minValue = Math.min(...this.bins);
@@ -168,8 +167,8 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
                 // 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)}`,
+                binStart: `${this.formatDate(i * dateScale + this._minDateMS, this.resolvedTooltipDateFormat)}`,
+                binEnd: `${this.formatDate((i + 1) * dateScale + this._minDateMS, this.resolvedTooltipDateFormat)}`,
             };
         });
     }
@@ -188,6 +187,12 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
     get histogramRightEdgeX() {
         return this.width - this.sliderWidth;
     }
+    get resolvedTooltipDateFormat() {
+        var _a;
+        if (this.tooltipDateFormat)
+            return this.tooltipDateFormat;
+        return (_a = this.dateFormat) !== null && _a !== void 0 ? _a : DATE_FORMAT;
+    }
     /** component's loading (and disabled) state */
     get loading() {
         return this._isLoading;
@@ -262,9 +267,9 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         const formattedNumItems = Number(dataset.numItems).toLocaleString();
         this._tooltipOffset =
             x + (this._binWidth - this.sliderWidth - this.tooltipWidth) / 2;
-        this._tooltipContent = html `
-      ${formattedNumItems} ${itemsText}<br />
-      ${dataset.binStart} - ${dataset.binEnd}
+        this._tooltipContent = html `
+      ${formattedNumItems} ${itemsText}<br />
+      ${dataset.binStart} - ${dataset.binEnd}
     `;
         this._tooltipVisible = true;
     }
@@ -459,25 +464,25 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         // border-radius); used as part of a SVG quadratic curve. see
         // https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands
         const cs = SLIDER_CORNER_SIZE;
-        const sliderShape = `
-            M${this.minSliderX},0
-            h-${this.sliderWidth - cs}
-            q-${cs},0 -${cs},${cs}
-            v${this.height - cs * 2}
-            q0,${cs} ${cs},${cs}
-            h${this.sliderWidth - cs}
+        const sliderShape = `
+            M${this.minSliderX},0
+            h-${this.sliderWidth - cs}
+            q-${cs},0 -${cs},${cs}
+            v${this.height - cs * 2}
+            q0,${cs} ${cs},${cs}
+            h${this.sliderWidth - cs}
           `;
         return this.generateSliderSVG(this.minSliderX, 'slider-min', sliderShape);
     }
     get maxSliderTemplate() {
         const cs = SLIDER_CORNER_SIZE;
-        const sliderShape = `
-            M${this.maxSliderX},0
-            h${this.sliderWidth - cs}
-            q${cs},0 ${cs},${cs}
-            v${this.height - cs * 2}
-            q0,${cs} -${cs},${cs}
-            h-${this.sliderWidth - cs}
+        const sliderShape = `
+            M${this.maxSliderX},0
+            h${this.sliderWidth - cs}
+            q${cs},0 ${cs},${cs}
+            v${this.height - cs * 2}
+            q0,${cs} -${cs},${cs}
+            h-${this.sliderWidth - cs}
           `;
         return this.generateSliderSVG(this.maxSliderX, 'slider-max', sliderShape);
     }
@@ -485,40 +490,40 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         // whether the curved part of the slider is facing towards the left (1), ie
         // minimum, or facing towards the right (-1), ie maximum
         const k = id === 'slider-min' ? 1 : -1;
-        return svg `
-    <svg
-      id="${id}"
-      class="
-      ${this.disabled ? '' : 'draggable'}
-      ${this._isDragging ? 'dragging' : ''}"
-      @pointerdown="${this.drag}"
-    >
-      <path d="${sliderShape} z" fill="${sliderColor}" />
-      <rect
-        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k}"
-        y="${this.height / 3}"
-        width="1"
-        height="${this.height / 3}"
-        fill="white"
-      />
-      <rect
-        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k}"
-        y="${this.height / 3}"
-        width="1"
-        height="${this.height / 3}"
-        fill="white"
-      />
-    </svg>
+        return svg `
+    <svg
+      id="${id}"
+      class="
+      ${this.disabled ? '' : 'draggable'}
+      ${this._isDragging ? 'dragging' : ''}"
+      @pointerdown="${this.drag}"
+    >
+      <path d="${sliderShape} z" fill="${sliderColor}" />
+      <rect
+        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.4 * k}"
+        y="${this.height / 3}"
+        width="1"
+        height="${this.height / 3}"
+        fill="white"
+      />
+      <rect
+        x="${sliderPositionX - this.sliderWidth * k + this.sliderWidth * 0.6 * k}"
+        y="${this.height / 3}"
+        width="1"
+        height="${this.height / 3}"
+        fill="white"
+      />
+    </svg>
     `;
     }
     get selectedRangeTemplate() {
-        return svg `
-      <rect
-        x="${this.minSliderX}"
-        y="0"
-        width="${this.maxSliderX - this.minSliderX}"
-        height="${this.height}"
-        fill="${selectedRangeColor}"
+        return svg `
+      <rect
+        x="${this.minSliderX}"
+        y="0"
+        width="${this.maxSliderX - this.minSliderX}"
+        height="${this.height}"
+        fill="${selectedRangeColor}"
       />`;
     }
     get histogramTemplate() {
@@ -530,29 +535,29 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         // between adjacent bars (eg when viewing the tooltips or when trying to
         // extend the range by clicking on a bar)
         return this._histData.map(data => {
-            const bar = svg `
-        <rect
-          class="bar"
-          style='stroke-dasharray: 0 ${barWidth} ${data.height} ${barWidth} 0 ${data.height};'
-          x="${x}"
-          y="${this.height - data.height}"
-          width="${barWidth}"
-          height="${data.height}"
-          @pointerenter="${this.showTooltip}"
-          @pointerleave="${this.hideTooltip}"
-          @click="${this.handleBarClick}"
+            const bar = svg `
+        <rect
+          class="bar"
+          style='stroke-dasharray: 0 ${barWidth} ${data.height} ${barWidth} 0 ${data.height};'
+          x="${x}"
+          y="${this.height - data.height}"
+          width="${barWidth}"
+          height="${data.height}"
+          @pointerenter="${this.showTooltip}"
+          @pointerleave="${this.hideTooltip}"
+          @click="${this.handleBarClick}"
           fill="${x + barWidth >= this.minSliderX && x <= this.maxSliderX
                 ? barIncludedFill
-                : barExcludedFill}"
-          data-num-items="${data.value}"
-          data-bin-start="${data.binStart}"
-          data-bin-end="${data.binEnd}"
+                : barExcludedFill}"
+          data-num-items="${data.value}"
+          data-bin-start="${data.binStart}"
+          data-bin-end="${data.binEnd}"
         />`;
             x += xScale;
             return bar;
         });
     }
-    formatDate(dateMS) {
+    formatDate(dateMS, format = this.dateFormat) {
         if (Number.isNaN(dateMS)) {
             return '';
         }
@@ -562,7 +567,7 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
             // back to displaying only the year
             return String(date.year());
         }
-        return date.format(this.dateFormat);
+        return date.format(format);
     }
     /**
      * NOTE: we are relying on the lit `live` directive in the template to
@@ -571,31 +576,31 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
      * https://lit.dev/docs/templates/directives/#live
      */
     get minInputTemplate() {
-        return html `
-      <input
-        id="date-min"
-        placeholder="${this.dateFormat}"
-        type="text"
-        @focus="${this.handleInputFocus}"
-        @blur="${this.handleMinDateInput}"
-        @keyup="${this.handleKeyUp}"
-        .value="${live(this.minSelectedDate)}"
-        ?disabled="${this.disabled}"
-      />
+        return html `
+      <input
+        id="date-min"
+        placeholder="${this.dateFormat}"
+        type="text"
+        @focus="${this.handleInputFocus}"
+        @blur="${this.handleMinDateInput}"
+        @keyup="${this.handleKeyUp}"
+        .value="${live(this.minSelectedDate)}"
+        ?disabled="${this.disabled}"
+      />
     `;
     }
     get maxInputTemplate() {
-        return html `
-      <input
-        id="date-max"
-        placeholder="${this.dateFormat}"
-        type="text"
-        @focus="${this.handleInputFocus}"
-        @blur="${this.handleMaxDateInput}"
-        @keyup="${this.handleKeyUp}"
-        .value="${live(this.maxSelectedDate)}"
-        ?disabled="${this.disabled}"
-      />
+        return html `
+      <input
+        id="date-max"
+        placeholder="${this.dateFormat}"
+        type="text"
+        @focus="${this.handleInputFocus}"
+        @blur="${this.handleMaxDateInput}"
+        @keyup="${this.handleKeyUp}"
+        .value="${live(this.maxSelectedDate)}"
+        ?disabled="${this.disabled}"
+      />
     `;
     }
     get minLabelTemplate() {
@@ -605,184 +610,184 @@ let HistogramDateRange = class HistogramDateRange extends LitElement {
         return html `<label for="date-max" class="sr-only">Maximum date:</label>`;
     }
     get tooltipTemplate() {
-        return html `
-      <style>
-        #tooltip {
-          width: ${this.tooltipWidth}px;
-          height: ${this.tooltipHeight}px;
-          top: ${-9 - this.tooltipHeight}px;
-          left: ${this._tooltipOffset}px;
-          display: ${this._tooltipVisible ? 'block' : 'none'};
-        }
-        #tooltip:after {
-          left: ${this.tooltipWidth / 2}px;
-        }
-      </style>
-      <div id="tooltip">${this._tooltipContent}</div>
+        return html `
+      <style>
+        #tooltip {
+          width: ${this.tooltipWidth}px;
+          height: ${this.tooltipHeight}px;
+          top: ${-9 - this.tooltipHeight}px;
+          left: ${this._tooltipOffset}px;
+          display: ${this._tooltipVisible ? 'block' : 'none'};
+        }
+        #tooltip:after {
+          left: ${this.tooltipWidth / 2}px;
+        }
+      </style>
+      <div id="tooltip">${this._tooltipContent}</div>
     `;
     }
     get noDataTemplate() {
-        return html `
-      <div class="missing-data-message">${this.missingDataMessage}</div>
+        return html `
+      <div class="missing-data-message">${this.missingDataMessage}</div>
     `;
     }
     get activityIndicatorTemplate() {
         if (!this.loading) {
             return nothing;
         }
-        return html `
-      <ia-activity-indicator mode="processing"> </ia-activity-indicator>
+        return html `
+      <ia-activity-indicator mode="processing"> </ia-activity-indicator>
     `;
     }
     render() {
         if (!this.hasBinData) {
             return this.noDataTemplate;
         }
-        return html `
-      <div
-        id="container"
-        class="
-          noselect
-          ${this._isDragging ? 'dragging' : ''}
-        "
-        style="width: ${this.width}px"
-      >
-        ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
-        <div
-          class="inner-container
-          ${this.disabled ? 'disabled' : ''}"
-        >
-          <svg
-            width="${this.width}"
-            height="${this.height}"
-            @pointerleave="${this.drop}"
-          >
-            ${this.selectedRangeTemplate}
-            <svg id="histogram">${this.histogramTemplate}</svg>
-            ${this.minSliderTemplate} ${this.maxSliderTemplate}
-          </svg>
-          <div id="inputs">
-            ${this.minLabelTemplate} ${this.minInputTemplate}
-            <div class="dash">-</div>
-            ${this.maxLabelTemplate} ${this.maxInputTemplate}
-            <slot name="inputs-right-side"></slot>
-          </div>
-        </div>
-      </div>
+        return html `
+      <div
+        id="container"
+        class="
+          noselect
+          ${this._isDragging ? 'dragging' : ''}
+        "
+        style="width: ${this.width}px"
+      >
+        ${this.activityIndicatorTemplate} ${this.tooltipTemplate}
+        <div
+          class="inner-container
+          ${this.disabled ? 'disabled' : ''}"
+        >
+          <svg
+            width="${this.width}"
+            height="${this.height}"
+            @pointerleave="${this.drop}"
+          >
+            ${this.selectedRangeTemplate}
+            <svg id="histogram">${this.histogramTemplate}</svg>
+            ${this.minSliderTemplate} ${this.maxSliderTemplate}
+          </svg>
+          <div id="inputs">
+            ${this.minLabelTemplate} ${this.minInputTemplate}
+            <div class="dash">-</div>
+            ${this.maxLabelTemplate} ${this.maxInputTemplate}
+            <slot name="inputs-right-side"></slot>
+          </div>
+        </div>
+      </div>
     `;
     }
 };
-HistogramDateRange.styles = css `
-    .missing-data-message {
-      text-align: center;
-    }
-    #container {
-      margin: 0;
-      touch-action: none;
-      position: relative;
-    }
-    .disabled {
-      opacity: 0.3;
-    }
-    ia-activity-indicator {
-      position: absolute;
-      left: calc(50% - 10px);
-      top: 10px;
-      width: 20px;
-      height: 20px;
-      --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
-      --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
-    }
-
-    /* prevent selection from interfering with tooltip, especially on mobile */
-    /* https://stackoverflow.com/a/4407335/1163042 */
-    .noselect {
-      -webkit-touch-callout: none; /* iOS Safari */
-      -webkit-user-select: none; /* Safari */
-      -moz-user-select: none; /* Old versions of Firefox */
-      -ms-user-select: none; /* Internet Explorer/Edge */
-      user-select: none; /* current Chrome, Edge, Opera and Firefox */
-    }
-    .bar {
-      /* create a transparent border around the hist bars to prevent "gaps" and
-      flickering when moving around between bars. this also helps with handling
-      clicks on the bars, preventing users from being able to click in between
-      bars */
-      stroke: rgba(0, 0, 0, 0);
-      /* ensure transparent stroke wide enough to cover gap between bars */
-      stroke-width: 2px;
-    }
-    .bar:hover {
-      /* highlight currently hovered bar */
-      fill-opacity: 0.7;
-    }
-    .disabled .bar:hover {
-      /* ensure no visual hover interaction when disabled */
-      fill-opacity: 1;
-    }
-    /****** histogram ********/
-    #tooltip {
-      position: absolute;
-      background: ${tooltipBackgroundColor};
-      color: ${tooltipTextColor};
-      text-align: center;
-      border-radius: 3px;
-      padding: 2px;
-      font-size: ${tooltipFontSize};
-      font-family: ${tooltipFontFamily};
-      touch-action: none;
-      pointer-events: none;
-    }
-    #tooltip:after {
-      content: '';
-      position: absolute;
-      margin-left: -5px;
-      top: 100%;
-      /* arrow */
-      border: 5px solid ${tooltipTextColor};
-      border-color: ${tooltipBackgroundColor} transparent transparent
-        transparent;
-    }
-    /****** slider ********/
-    .draggable:hover {
-      cursor: grab;
-    }
-    .dragging {
-      cursor: grabbing !important;
-    }
-    /****** inputs ********/
-    #inputs {
-      display: flex;
-      justify-content: center;
-      margin: ${inputRowMargin};
-    }
-    #inputs .dash {
-      position: relative;
-      bottom: -1px;
-      align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
-    }
-    input {
-      width: ${inputWidth};
-      margin: 0 3px;
-      border: ${inputBorder};
-      border-radius: 2px !important;
-      text-align: center;
-      font-size: ${inputFontSize};
-      font-family: ${inputFontFamily};
-    }
-    .sr-only {
-      position: absolute !important;
-      width: 1px !important;
-      height: 1px !important;
-      margin: 0 !important;
-      padding: 0 !important;
-      border: 0 !important;
-      overflow: hidden !important;
-      white-space: nowrap !important;
-      clip: rect(1px, 1px, 1px, 1px) !important;
-      -webkit-clip-path: inset(50%) !important;
-      clip-path: inset(50%) !important;
-    }
+HistogramDateRange.styles = css `
+    .missing-data-message {
+      text-align: center;
+    }
+    #container {
+      margin: 0;
+      touch-action: none;
+      position: relative;
+    }
+    .disabled {
+      opacity: 0.3;
+    }
+    ia-activity-indicator {
+      position: absolute;
+      left: calc(50% - 10px);
+      top: 10px;
+      width: 20px;
+      height: 20px;
+      --activityIndicatorLoadingDotColor: rgba(0, 0, 0, 0);
+      --activityIndicatorLoadingRingColor: ${activityIndicatorColor};
+    }
+
+    /* prevent selection from interfering with tooltip, especially on mobile */
+    /* https://stackoverflow.com/a/4407335/1163042 */
+    .noselect {
+      -webkit-touch-callout: none; /* iOS Safari */
+      -webkit-user-select: none; /* Safari */
+      -moz-user-select: none; /* Old versions of Firefox */
+      -ms-user-select: none; /* Internet Explorer/Edge */
+      user-select: none; /* current Chrome, Edge, Opera and Firefox */
+    }
+    .bar {
+      /* create a transparent border around the hist bars to prevent "gaps" and
+      flickering when moving around between bars. this also helps with handling
+      clicks on the bars, preventing users from being able to click in between
+      bars */
+      stroke: rgba(0, 0, 0, 0);
+      /* ensure transparent stroke wide enough to cover gap between bars */
+      stroke-width: 2px;
+    }
+    .bar:hover {
+      /* highlight currently hovered bar */
+      fill-opacity: 0.7;
+    }
+    .disabled .bar:hover {
+      /* ensure no visual hover interaction when disabled */
+      fill-opacity: 1;
+    }
+    /****** histogram ********/
+    #tooltip {
+      position: absolute;
+      background: ${tooltipBackgroundColor};
+      color: ${tooltipTextColor};
+      text-align: center;
+      border-radius: 3px;
+      padding: 2px;
+      font-size: ${tooltipFontSize};
+      font-family: ${tooltipFontFamily};
+      touch-action: none;
+      pointer-events: none;
+    }
+    #tooltip:after {
+      content: '';
+      position: absolute;
+      margin-left: -5px;
+      top: 100%;
+      /* arrow */
+      border: 5px solid ${tooltipTextColor};
+      border-color: ${tooltipBackgroundColor} transparent transparent
+        transparent;
+    }
+    /****** slider ********/
+    .draggable:hover {
+      cursor: grab;
+    }
+    .dragging {
+      cursor: grabbing !important;
+    }
+    /****** inputs ********/
+    #inputs {
+      display: flex;
+      justify-content: center;
+      margin: ${inputRowMargin};
+    }
+    #inputs .dash {
+      position: relative;
+      bottom: -1px;
+      align-self: center; /* Otherwise the dash sticks to the top while the inputs grow */
+    }
+    input {
+      width: ${inputWidth};
+      margin: 0 3px;
+      border: ${inputBorder};
+      border-radius: 2px !important;
+      text-align: center;
+      font-size: ${inputFontSize};
+      font-family: ${inputFontFamily};
+    }
+    .sr-only {
+      position: absolute !important;
+      width: 1px !important;
+      height: 1px !important;
+      margin: 0 !important;
+      padding: 0 !important;
+      border: 0 !important;
+      overflow: hidden !important;
+      white-space: nowrap !important;
+      clip: rect(1px, 1px, 1px, 1px) !important;
+      -webkit-clip-path: inset(50%) !important;
+      clip-path: inset(50%) !important;
+    }
   `;
 __decorate([
     property({ type: Number })
@@ -805,6 +810,9 @@ __decorate([
 __decorate([
     property({ type: String })
 ], HistogramDateRange.prototype, "dateFormat", void 0);
+__decorate([
+    property({ type: String })
+], HistogramDateRange.prototype, "tooltipDateFormat", void 0);
 __decorate([
     property({ type: String })
 ], HistogramDateRange.prototype, "missingDataMessage", void 0);
@@ -818,7 +826,7 @@ __decorate([
     property({ type: Boolean })
 ], HistogramDateRange.prototype, "disabled", void 0);
 __decorate([
-    property({ type: Object })
+    property({ type: Array })
 ], HistogramDateRange.prototype, "bins", void 0);
 __decorate([
     property({ type: Boolean })