@internetarchive/histogram-date-range 1.2.2-alpha-webdev7377.7 → 1.3.0

package/.github/workflows/ci.yml

@@ -17,10 +17,10 @@ jobs:
         node-version: latest
 
     - name: Install dependencies
-      run: yarn install
+      run: npm install
 
     - name: Run tests
-      run: yarn run test
+      run: npm run test
 
     - name: Upload Codecov reports
       uses: codecov/codecov-action@main

package/demo/index.html

@@ -80,7 +80,7 @@
     </div>
 
     <div class="container">
-      <div class="description">bins rounded to nearest month</div>
+      <div class="description">bins snapped to nearest month</div>
       <histogram-date-range
         width="175"
         tooltipwidth="120"
@@ -95,14 +95,14 @@
     </div>
 
     <div class="container">
-      <div class="description">bins rounded to nearest year</div>
+      <div class="description">bins snapped to nearest year</div>
       <histogram-date-range
         width="175"
         dateFormat="YYYY"
         binSnapping="year"
         minDate="2009"
-        maxDate="2014"
-        bins="[100,5000,2000,100,5000,2000]"
+        maxDate="2018"
+        bins="[100,1000,10000,100,1000,10000,100,1000,10000,100]"
       ></histogram-date-range>
     </div>
 

package/dist/index.d.ts

@@ -1 +1 @@
-export { HistogramDateRange, BinSnappingInterval as BinRoundingInterval, } from './src/histogram-date-range';
+export { HistogramDateRange, BinSnappingInterval, } from './src/histogram-date-range';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAEnB,MAAM,4BAA4B,CAAC","sourcesContent":["export {\n  HistogramDateRange,\n  BinSnappingInterval as BinRoundingInterval,\n} from './src/histogram-date-range';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAEnB,MAAM,4BAA4B,CAAC","sourcesContent":["export {\r\n  HistogramDateRange,\r\n  BinSnappingInterval,\r\n} from './src/histogram-date-range';\r\n"]}

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

@@ -16,7 +16,17 @@ export declare class HistogramDateRange extends LitElement {
     bins: number[];
     /** If true, update events will not be canceled by the date inputs receiving focus */
     updateWhileFocused: boolean;
-    /** What interval bins should be rounded to for display */
+    /**
+     * 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;
     private _tooltipOffset;
     private _tooltipContent?;
@@ -76,7 +86,8 @@ export declare class HistogramDateRange extends LitElement {
      */
     private get snapInterval();
     /**
-     * Offset added to the end of each bin to ensure disjoin intervals, if applicable.
+     * 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();
     /**