Class XYPlot

src/plots/xyPlot.ts:16–379

import { Plot } from "./plot";

export class XYPlot<X, Y> extends Plot {
  protected static _X_KEY = "x";
  protected static _Y_KEY = "y";

  private _autoAdjustXScaleDomain = false;
  private _autoAdjustYScaleDomain = false;
  private _adjustYDomainOnChangeFromXCallback: IScaleCallback<Scale<any, any>>;
  private _adjustXDomainOnChangeFromYCallback: IScaleCallback<Scale<any, any>>;

  private _deferredRendering = false;
  private _deferredRenderer: DeferredRenderer<X, Y>;

  /**
   * An XYPlot is a Plot that displays data along two primary directions, X and Y.
   *
   * @constructor
   * @param {Scale} xScale The x scale to use.
   * @param {Scale} yScale The y scale to use.
   */
  constructor() {
    super();
    this.addClass("xy-plot");

    this._adjustYDomainOnChangeFromXCallback = (scale) => this._adjustYDomainOnChangeFromX();
    this._adjustXDomainOnChangeFromYCallback = (scale) => this._adjustXDomainOnChangeFromY();

    this._renderCallback = () => {
      if (this.deferredRendering()) {
        const scaleX = this.x() && this.x().scale;
        const scaleY = this.y() && this.y().scale;
        this._deferredRenderer.updateDomains(scaleX, scaleY);
      } else {
        this.render();
      }
    };

    this._deferredRenderer = new DeferredRenderer<X, Y>(() => this.render(), this._applyDeferredRenderingTransform);
  }

  public render() {
    if (this.deferredRendering()) {
      this._deferredRenderer.resetTransforms();
    }
    return super.render();
  }

  /**
   * Returns the whether or not the rendering is deferred for performance boost.
   *
   * @return {boolean} The deferred rendering option
   */
  public deferredRendering(): boolean;
  /**
   * Sets / unsets the deferred rendering option Activating this option improves
   * the performance of plot interaction (pan / zoom) by performing lazy
   * renders, only after the interaction has stopped. Because re-rendering is no
   * longer performed during the interaction, the zooming might experience a
   * small resolution degradation, before the lazy re-render is performed.