Prepare release 3.5.4 (#3405)

* Prepare release 3.5.4

* Deprecate entitiesIn. Use names entitiesInBounds, entitiesInXBound, entitiesInYBounds.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "plottable",
   "description": "A modular charting library built on D3",
-  "version": "3.5.3",
+  "version": "3.5.4",
   "license": "MIT",
   "repository": {
     "type": "git",

src/core/interfaces.ts

@@ -88,7 +88,7 @@ export type Bounds = {
 };
 
 /**
- * Client bounds
+ * Client bounds in pixel-space.
  */
 export interface IEntityBounds {
   x: number;

src/plots/plot.ts

@@ -869,13 +869,17 @@ export class Plot extends Component {
   }
 
   /**
+   * @deprecated Use `entitiesInBounds` instead
+   *
    * Gets the Entities that intersect the Bounds.
    *
    * @param {Bounds} bounds
    * @returns {PlotEntity[]}
    */
   public entitiesIn(bounds: Bounds): Plots.IPlotEntity[];
   /**
+   * @deprecated Use `entitiesInBounds` instead
+   *
    * Gets the Entities that intersect the area defined by the ranges.
    *
    * @param {Range} xRange
@@ -907,6 +911,8 @@ export class Plot extends Component {
 
   /**
    * Returns the entites whose bounding boxes overlap the parameter.
+   *
+   * `queryBounds` are in pixel space, measured from the origin of this plot.
    */
   public entitiesInBounds(queryBounds: IEntityBounds): Plots.IPlotEntity[] {
     const found = this._getEntityStore().entitiesInBounds(queryBounds);
@@ -917,23 +923,27 @@ export class Plot extends Component {
   }
 
   /**
-   * Returns the entites whose bounding boxes overlap the parameter on the
-   * x-axis.
+   * Returns the entites whose bounding boxes overlap the `queryBounds`
+   * parameter on the x-axis.
+   *
+   * `queryBounds` are in pixel space, measured from the origin of this plot.
    */
-  public entitiesInXRange(queryBounds: IEntityBounds): Plots.IPlotEntity[] {
-    const found = this._getEntityStore().entitiesInXRange(queryBounds);
+  public entitiesInXBounds(queryBounds: IEntityBounds): Plots.IPlotEntity[] {
+    const found = this._getEntityStore().entitiesInXBounds(queryBounds);
     if (!found) {
       return undefined;
     }
     return found.map((entity) => this._lightweightPlotEntityToPlotEntity(entity));
   }
 
   /**
-   * Returns the entites whose bounding boxes overlap the parameter on the
-   * y-axis.
+   * Returns the entites whose bounding boxes overlap the `queryBounds`
+   * parameter on the y-axis.
+   *
+   * `queryBounds` are in pixel space, measured from the origin of this plot.
    */
-  public entitiesInYRange(queryBounds: IEntityBounds): Plots.IPlotEntity[] {
-    const found = this._getEntityStore().entitiesInYRange(queryBounds);
+  public entitiesInYBounds(queryBounds: IEntityBounds): Plots.IPlotEntity[] {
+    const found = this._getEntityStore().entitiesInYBounds(queryBounds);
     if (!found) {
       return undefined;
     }

src/utils/entityStore.ts

@@ -56,15 +56,15 @@ export interface IEntityStore<T extends IPositionedEntity> {
    *
    * @param {IEntityBounds} [bounds] The query bounding box.
    */
-  entitiesInXRange(bounds: IEntityBounds): T[];
+  entitiesInXBounds(bounds: IEntityBounds): T[];
 
   /**
    * Returns the entites whose bounding boxes overlap the parameter on the
    * y-axis.
    *
    * @param {IEntityBounds} [bounds] The query bounding box.
    */
-  entitiesInYRange(bounds: IEntityBounds): T[];
+  entitiesInYBounds(bounds: IEntityBounds): T[];
 
   /**
    * Returns the current internal array of all entities.
@@ -129,11 +129,11 @@ export class EntityStore<T extends IPositionedEntity> implements IEntityStore<T>
     return this._rtree.intersect(RTreeBounds.entityBounds(bounds));
   }
 
-  public entitiesInXRange(bounds: IEntityBounds) {
+  public entitiesInXBounds(bounds: IEntityBounds) {
     return this._rtree.intersectX(RTreeBounds.entityBounds(bounds));
   }
 
-  public entitiesInYRange(bounds: IEntityBounds) {
+  public entitiesInYBounds(bounds: IEntityBounds) {
     return this._rtree.intersectY(RTreeBounds.entityBounds(bounds));
   }