@internetarchive/elements 1.0.0 → 1.0.1-webdev-9121.1

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

@@ -0,0 +1,243 @@
+import '../../elements/ia-status-indicator/ia-status-indicator.js';
+import { LitElement, PropertyValues, SVGTemplateResult, TemplateResult } from 'lit';
+import type { BarScalingOption, BinSnappingInterval } from './models.js';
+export declare class IAHistogramDateRange extends LitElement {
+    width: number;
+    height: number;
+    sliderWidth: number;
+    tooltipWidth: number;
+    tooltipHeight: number;
+    updateDelay: number;
+    dateFormat: string;
+    missingDataMessage: string;
+    minDate: string;
+    maxDate: string;
+    disabled: boolean;
+    bins: number[];
+    /** If true, update events will not be canceled by the date inputs receiving focus */
+    updateWhileFocused: boolean;
+    /**
+     * What interval bins should be snapped to for determining their time ranges.
+     *  - `none` (default): Bins should each represent an identical duration of time,
+     *     without regard for the actual dates represented.
+     *  - `month`: Bins should each represent one or more full, non-overlapping months.
+     *     The bin ranges will be "snapped" to the nearest month boundaries, which can
+     *     result in bins that represent different amounts of time, particularly if the
+     *     provided bins do not evenly divide the provided date range, or if the months
+     *     represented are of different lengths.
+     *  - `year`: Same as `month`, but snapping to year boundaries instead of months.
+     */
+    binSnapping: BinSnappingInterval;
+    /**
+     * What label to use on tooltips to identify the type of data being represented.
+     * Defaults to `'item(s)'`.
+     */
+    tooltipLabel: string;
+    /**
+     * A function or preset value indicating how the height of each bar relates to its
+     * corresponding bin value. Current presets available are 'logarithmic' and 'linear',
+     * but a custom function may be provided instead if other behavior is desired.
+     *
+     * The default scaling (`'logarithmic'`) uses the logarithm of each bin value, yielding
+     * more prominent bars for smaller values. This ensures that even when the difference
+     * between the min & max values is large, small values are unlikely to completely disappear
+     * visually. However, the cost is that bars have less noticeable variation among values of
+     * a similar magnitude, and their heights are not a direct representation of the bin values.
+     *
+     * The `'linear'` preset option instead sizes the bars in linear proportion to their bin
+     * values.
+     */
+    barScaling: BarScalingOption;
+    private _tooltipOffsetX;
+    private _tooltipOffsetY;
+    private _tooltipContent?;
+    private _tooltipDateFormat?;
+    private _isDragging;
+    private _isLoading;
+    private _tooltip;
+    private _minSelectedDate;
+    private _maxSelectedDate;
+    private _minDateMS;
+    private _maxDateMS;
+    private _dragOffset;
+    private _histWidth;
+    private _binWidth;
+    private _currentSlider?;
+    private _histData;
+    private _emitUpdatedEventTimer?;
+    private _previousDateRange;
+    private _updateDeferredWhileFocused;
+    updated(): void;
+    disconnectedCallback(): void;
+    willUpdate(changedProps: PropertyValues): void;
+    /**
+     * Set private properties that depend on the attribute bin data
+     *
+     * We're caching these values and not using getters to avoid recalculating all
+     * of the hist data every time the user drags a slider or hovers over a bar
+     * creating a tooltip.
+     */
+    private handleDataUpdate;
+    /**
+     * Rounds the given timestamp to the next full second.
+     */
+    private snapToNextSecond;
+    /**
+     * Rounds the given timestamp to the (approximate) nearest start of a month,
+     * such that dates up to and including the 15th of the month are rounded down,
+     * while dates past the 15th are rounded up.
+     */
+    private snapToMonth;
+    /**
+     * Rounds the given timestamp to the (approximate) nearest start of a year,
+     * such that dates up to the end of June are rounded down, while dates in
+     * July or later are rounded up.
+     */
+    private snapToYear;
+    /**
+     * Rounds the given timestamp according to the `binSnapping` property.
+     * Default is simply to snap to the nearest full second.
+     */
+    private snapTimestamp;
+    /**
+     * Function to scale bin values, whether from a preset or a provided custom function.
+     */
+    private get barScalingFunction();
+    private calculateHistData;
+    private get hasBinData();
+    private get _numBins();
+    private get histogramLeftEdgeX();
+    private get histogramRightEdgeX();
+    /**
+     * Approximate size in ms of the interval to which bins are snapped.
+     */
+    private get snapInterval();
+    /**
+     * Offset added to the end of each bin to ensure disjoint intervals,
+     * depending on whether snapping is enabled and there are multiple bins.
+     */
+    private get snapEndOffset();
+    /**
+     * Optional date format to use for tooltips only.
+     * Falls back to `dateFormat` if not provided.
+     */
+    get tooltipDateFormat(): string;
+    set tooltipDateFormat(value: string);
+    /** component's loading (and disabled) state */
+    get loading(): boolean;
+    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;
+    /** horizontal position of max date slider */
+    get maxSliderX(): number;
+    private get dateRangeMS();
+    private showTooltip;
+    private hideTooltip;
+    private drag;
+    private drop;
+    /**
+     * Adjust the date range based on slider movement
+     *
+     * @param e PointerEvent from the slider being moved
+     */
+    private move;
+    /**
+     * Constrain a proposed value for the minimum (left) slider
+     *
+     * If the value is less than the leftmost valid position, then set it to the
+     * left edge of the histogram (ie the slider width). If the value is greater
+     * than the rightmost valid position (the position of the max slider), then
+     * set it to the position of the max slider
+     */
+    private validMinSliderX;
+    /**
+     * Constrain a proposed value for the maximum (right) slider
+     *
+     * If the value is greater than the rightmost valid position, then set it to
+     * the right edge of the histogram (ie histogram width - slider width). If the
+     * value is less than the leftmost valid position (the position of the min
+     * slider), then set it to the position of the min slider
+     */
+    private validMaxSliderX;
+    private addListeners;
+    private removeListeners;
+    /**
+     * start a timer to emit an update event. this timer can be canceled (and the
+     * event not emitted) if user drags a slider or focuses a date input within
+     * the update delay
+     */
+    private beginEmitUpdateProcess;
+    /** @returns whether there was a pending update event to cancel */
+    private cancelPendingUpdateEvent;
+    /**
+     * find position of pointer in relation to the current slider
+     */
+    private setDragOffset;
+    /**
+     * @param x horizontal position of slider
+     * @returns string representation of date
+     */
+    private translatePositionToDate;
+    /**
+     * Returns slider x-position corresponding to given date
+     *
+     * @param date
+     * @returns x-position of slider
+     */
+    private translateDateToPosition;
+    /** ensure that the returned value is between minValue and maxValue */
+    private clamp;
+    private handleInputFocus;
+    private handleMinDateInput;
+    private handleMaxDateInput;
+    private handleKeyUp;
+    private get currentDateRangeString();
+    private getMSFromString;
+    /**
+     * expand or narrow the selected range by moving the slider nearest the
+     * clicked bar to the outer edge of the clicked bar
+     *
+     * @param e Event click event from a histogram bar
+     */
+    private handleBarClick;
+    private get minSliderTemplate();
+    private get maxSliderTemplate();
+    private generateSliderSVG;
+    get selectedRangeTemplate(): SVGTemplateResult;
+    get histogramTemplate(): SVGTemplateResult[];
+    /** Whether the first arg represents a date strictly before the second arg */
+    private isBefore;
+    /** Whether the first arg represents a date strictly after the second arg */
+    private isAfter;
+    private formatDate;
+    /**
+     * NOTE: we are relying on the lit `live` directive in the template to
+     * ensure that the change to minSelectedDate is noticed and the input value
+     * gets properly re-rendered. see
+     * https://lit.dev/docs/templates/directives/#live
+     */
+    get minInputTemplate(): TemplateResult;
+    get maxInputTemplate(): TemplateResult;
+    get minLabelTemplate(): TemplateResult;
+    get maxLabelTemplate(): TemplateResult;
+    get tooltipTemplate(): TemplateResult;
+    private get histogramAccessibilityTemplate();
+    private get noDataTemplate();
+    private get activityIndicatorTemplate();
+    static styles: import("lit").CSSResult;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'ia-histogram-date-range': IAHistogramDateRange;
+    }
+}
+//# sourceMappingURL=ia-histogram-date-range.d.ts.map

package/dist/src/elements/ia-histogram-date-range/ia-histogram-date-range.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ia-histogram-date-range.d.ts","sourceRoot":"","sources":["../../../../src/elements/ia-histogram-date-range/ia-histogram-date-range.ts"],"names":[],"mappings":"AAAA,OAAO,uDAAuD,CAAC;AAI/D,OAAO,EAGL,UAAU,EAEV,cAAc,EAEd,iBAAiB,EACjB,cAAc,EACf,MAAM,KAAK,CAAC;AAMb,OAAO,KAAK,EAEV,gBAAgB,EAEhB,mBAAmB,EACpB,MAAM,UAAU,CAAC;AA2DlB,qBACa,oBAAqB,SAAQ,UAAU;IAEtB,KAAK,SAAS;IACd,MAAM,SAAU;IAChB,WAAW,SAAgB;IAC3B,YAAY,SAAiB;IAC7B,aAAa,SAAkB;IAC/B,WAAW,SAA4B;IACvC,UAAU,SAAe;IACzB,kBAAkB,SAAgB;IAClC,OAAO,SAAM;IACb,OAAO,SAAM;IACZ,QAAQ,UAAS;IACnB,IAAI,EAAE,MAAM,EAAE,CAAM;IAC/C,qFAAqF;IACxD,kBAAkB,UAAS;IAExD;;;;;;;;;;OAUG;IACyB,WAAW,EAAE,mBAAmB,CAAU;IAEtE;;;OAGG;IACyB,YAAY,SAAiB;IAEzD;;;;;;;;;;;;;OAaG;IACyB,UAAU,EAAE,gBAAgB,CAAiB;IAGhE,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,OAAO,CAAC,kBAAkB,CAAC,CAAS;IACpC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAS;IAEjB,OAAO,CAAC,QAAQ,CAAkB;IAGrD,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,sBAAsB,CAAC,CAAgC;IAC/D,OAAO,CAAC,kBAAkB,CAAM;IAChC,OAAO,CAAC,2BAA2B,CAAS;IAE5C,OAAO,IAAI,IAAI;IAUf,oBAAoB,IAAI,IAAI;IAK5B,UAAU,CAAC,YAAY,EAAE,cAAc,GAAG,IAAI;IAiB9C;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAwBxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAanB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAclB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,OAAO,KAAK,kBAAkB,GAM7B;IAED,OAAO,CAAC,iBAAiB;IAuCzB,OAAO,KAAK,UAAU,GAErB;IAED,OAAO,KAAK,QAAQ,GAKnB;IAED,OAAO,KAAK,kBAAkB,GAE7B;IAED,OAAO,KAAK,mBAAmB,GAE9B;IAED;;OAEG;IACH,OAAO,KAAK,YAAY,GAYvB;IAED;;;OAGG;IACH,OAAO,KAAK,aAAa,GAExB;IAED;;;OAGG;IACH,IAAgC,iBAAiB,IAAI,MAAM,CAE1D;IAED,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAElC;IAED,+CAA+C;IAC/C,IAAiC,OAAO,IAAI,OAAO,CAElD;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAGzB;IAED,oDAAoD;IACpD,IAAgB,eAAe,IAAI,MAAM,CAExC;IAED,mDAAmD;IACnD,IAAI,eAAe,CAAC,OAAO,EAAE,MAAM,EAgBlC;IAED,oDAAoD;IACpD,IAAgB,eAAe,IAAI,MAAM,CAExC;IAED,mDAAmD;IACnD,IAAI,eAAe,CAAC,OAAO,EAAE,MAAM,EAgBlC;IAED,6CAA6C;IAC7C,IAAI,UAAU,IAAI,MAAM,CAGvB;IAED,6CAA6C;IAC7C,IAAI,UAAU,IAAI,MAAM,CAMvB;IAED,OAAO,KAAK,WAAW,GAEtB;IAED,OAAO,CAAC,WAAW;IAqCnB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,IAAI,CAUV;IAEF,OAAO,CAAC,IAAI,CAMV;IAEF;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAgBV;IAEF;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAavB;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,eAAe;IAMvB;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAuB9B,kEAAkE;IAClE,OAAO,CAAC,wBAAwB;IAShC;;OAEG;IACH,OAAO,CAAC,aAAa;IAUrB;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAU/B;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAQ/B,sEAAsE;IACtE,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,WAAW;IAYnB,OAAO,KAAK,sBAAsB,GAEjC;IAED,OAAO,CAAC,eAAe;IAgBvB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAuBtB,OAAO,KAAK,iBAAiB,GAe5B;IAED,OAAO,KAAK,iBAAiB,GAW5B;IAED,OAAO,CAAC,iBAAiB;IA4CzB,IAAI,qBAAqB,IAAI,iBAAiB,CAS7C;IAED,IAAI,iBAAiB,IAAI,iBAAiB,EAAE,CAgD3C;IAED,6EAA6E;IAC7E,OAAO,CAAC,QAAQ;IAMhB,4EAA4E;IAC5E,OAAO,CAAC,OAAO;IAMf,OAAO,CAAC,UAAU;IAgBlB;;;;;OAKG;IACH,IAAI,gBAAgB,IAAI,cAAc,CAarC;IAED,IAAI,gBAAgB,IAAI,cAAc,CAarC;IAED,IAAI,gBAAgB,IAAI,cAAc,CAErC;IAED,IAAI,gBAAgB,IAAI,cAAc,CAErC;IAED,IAAI,eAAe,IAAI,cAAc,CAWpC;IAED,OAAO,KAAK,8BAA8B,GAezC;IAED,OAAO,KAAK,cAAc,GAIzB;IAED,OAAO,KAAK,yBAAyB,GAQpC;IAED,MAAM,CAAC,MAAM,0BAyHX;IAEF,MAAM,IAAI,cAAc;CAsCzB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,yBAAyB,EAAE,oBAAoB,CAAC;KACjD;CACF"}