Merge remote-tracking branch 'github-private/master' into release

Author: emilefokkema

README.md

@@ -23,7 +23,7 @@ var context = infiniteCanvas.getContext("2d");
 Include `InfiniteCanvas` in your web page:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/[email protected].4-alpha/dist/infinite-canvas.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected].7-alpha/dist/infinite-canvas.js"></script>
 ```
 
 or install it using npm:

dist/infinite-canvas.js

@@ -0,0 +1,9 @@
+/**
+ * Options that can be provided when adding an event listener to an {@link InfiniteCanvas}
+ */
+export interface AddEventListenerOptions {
+    /**
+     * If `true`, the listener will be invoked at most once
+     */
+    once: boolean;
+}

dist/types/add-event-listener-options.d.ts

@@ -0,0 +1,24 @@
+import { Units } from "./units";
+/**
+ * This interface contains properties that determine the behavior of the {@link InfiniteCanvas}.
+ */
+export interface Config {
+    /**
+     * Determines whether rotating the {@link InfiniteCanvas} is possible or not
+     *
+     * @defaultValue true
+     */
+    rotationEnabled: boolean;
+    /**
+     * If `true`, this means that the {@link InfiniteCanvas} will pan when touched with one finger, and that it will zoom when the user scrolls without pressing the Ctrl key
+     *
+     * @defaultValue false
+     */
+    greedyGestureHandling: boolean;
+    /**
+     * Determines the units to use when drawing on an {@link InfiniteCanvas}
+     *
+     * @defaultValue {@link Units.CANVAS}
+     */
+    units: Units;
+}

dist/types/config.d.ts

@@ -0,0 +1,3 @@
+import { Transformed } from "./transformed";
+export interface DrawEvent extends Transformed {
+}

dist/types/config/infinite-canvas-config.d.ts

@@ -0,0 +1,2 @@
+import { EventMap } from "./event-map";
+export declare type EventListener<K extends keyof EventMap> = (ev: EventMap[K]) => void;

dist/types/custom-events/event-listener.d.ts

@@ -0,0 +1,23 @@
+import { DrawEvent } from "./draw-event";
+import { TransformationEvent } from "./transformation-event";
+export interface EventMap {
+    /**
+     * Emitted when the {@link InfiniteCanvas} has drawn its content on the underlying `<canvas>`
+     */
+    "draw": DrawEvent;
+    /**
+     * Emitted when {@link InfiniteCanvas} begins transforming (for example when the user begins to pan)
+     */
+    "transformationStart": TransformationEvent;
+    /**
+     * Emitted when {@link InfiniteCanvas} transforms (for example when the user pans)
+     */
+    "transformationChange": TransformationEvent;
+    /**
+     * Emitted when {@link InfiniteCanvas} has finished transforming
+     */
+    "transformationEnd": TransformationEvent;
+}
+export * from './draw-event';
+export * from './transformation-event';
+export * from './transformed';

dist/types/custom-events/infinite-canvas-add-event-listener-options.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This interface inherits all properties and methods from [`CanvasRenderingContext2D`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D)
+ *
+ * @remarks
+ * `InfiniteCanvasRenderingContext2D` currently does **not** support [`getImageData()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getImageData), [`createImageData()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createImageData), [`globalAlpha`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalAlpha), [`globalCompositeOperation`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation), [`isPointInPath()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/isPointInPath), [`isPointInStroke()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/isPointInStroke), [`filter`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/filter), [`imageSmoothingEnabled`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/imageSmoothingEnabled), [`imageSmoothingQuality`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/imageSmoothingQuality), [`lineJoin`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin), [`miterLimit`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit), [`drawFocusIfNeeded()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawFocusIfNeeded) and [`scrollPathIntoView()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/scrollPathIntoView)
+ */
+export interface InfiniteCanvasRenderingContext2D extends CanvasRenderingContext2D {
+    /**
+     * Modifies the current sub-path by adding a ray that starts at the sub-path's last point and extends to infinity in the direction of a given vector
+     * @param x The horizontal component of the vector that indicates the direction of the line
+     * @param y The vertical component of the vector that indicates the direction of the line
+     */
+    lineToInfinityInDirection(x: number, y: number): void;
+    /**
+     * Begins a new sub-path at a 'point at infinity' that lies in the direction indicated by a given vector
+     * @param x The horizontal component of the vector that indicates the direction of the 'point at infinity' at which to begin a new sub-path
+     * @param y The vertical component of the vector that indicates the direction of the 'point at infinity' at which to begin a new sub-path
+     */
+    moveToInfinityInDirection(x: number, y: number): void;
+}

dist/types/custom-events/infinite-canvas-draw-event.d.ts

@@ -0,0 +1,60 @@
+import { Config } from "./config";
+import { Units } from "./units";
+import { InfiniteCanvasRenderingContext2D } from "./infinite-canvas-rendering-context-2d";
+import { EventMap } from "./event-map";
+import { AddEventListenerOptions } from "./add-event-listener-options";
+import { EventListener } from "./event-listener";
+export interface InfiniteCanvas extends Config {
+    /**
+     * This methods return the {@link InfiniteCanvasRenderingContext2D} belonging to this instance of {@link InfiniteCanvas}
+     *
+     * @param contextType for (partial) compatibility with the other [getContext()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/getContext)
+     */
+    getContext(contextType?: '2d'): InfiniteCanvasRenderingContext2D;
+    /**
+     * Adds an event listener to an {@link InfiniteCanvas}
+     *
+     * @example
+     * ```js
+     * infCanvas.addEventListener('draw', () => {
+     *     console.log('drawn!')
+     * })
+     * ```
+     * @param type The type of event to listen to
+     * @param listener The listener to add
+     * @param options An optional options object
+     */
+    addEventListener<K extends keyof EventMap>(type: K, listener: EventListener<K>, options?: AddEventListenerOptions): void;
+    /**
+     * Removes an event listener
+     * @param type The type of event that the listener to remove is listening to
+     * @param listener The listener to remove
+     */
+    removeEventListener<K extends keyof EventMap>(type: K, listener: EventListener<K>): void;
+}
+export interface InfiniteCanvasCtr {
+    /**
+     * Creates a new instance of an {@link InfiniteCanvas}
+     *
+     * @param canvas The canvas on which to draw the {@link InfiniteCanvas}
+     * @param config The {@link InfiniteCanvas}'s initial configuration
+     */
+    new (canvas: HTMLCanvasElement, config?: Partial<Config>): InfiniteCanvas;
+    prototype: InfiniteCanvas;
+    /**
+     * Static property with a value of {@link Units.CANVAS}
+     */
+    CANVAS_UNITS: Units;
+    /**
+     * Static property with a value of {@link Units.CSS}
+     */
+    CSS_UNITS: Units;
+}
+declare var InfiniteCanvasConstructor: InfiniteCanvasCtr;
+export * from './add-event-listener-options';
+export * from './config';
+export * from './event-map';
+export * from './event-listener';
+export * from './infinite-canvas-rendering-context-2d';
+export * from './units';
+export default InfiniteCanvasConstructor;

dist/types/custom-events/infinite-canvas-event-listener.d.ts

@@ -0,0 +1,3 @@
+import { Transformed } from "./transformed";
+export interface TransformationEvent extends Transformed {
+}

dist/types/custom-events/infinite-canvas-event-map.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A plain object containing number-valued properties `a`, `b`, `c`, `d`, `e` and `f`, which mean the same as the parameters of the same name in [`setTransform()`](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters).
+ */
+export interface TransformationRepresentation {
+    /**
+     * See "a" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    a: number;
+    /**
+     * See "b" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    b: number;
+    /**
+     * See "c" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    c: number;
+    /**
+     * See "d" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    d: number;
+    /**
+     * See "e" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    e: number;
+    /**
+     * See "f" on [this](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform#parameters) page
+     */
+    f: number;
+}

dist/types/custom-events/infinite-canvas-transformation-event.d.ts

@@ -0,0 +1,12 @@
+import { TransformationRepresentation } from "./transformation-representation";
+export interface Transformed {
+    /**
+     * The transformation that, when applied to a point `(x, y)` in the CSS-pixel-base coordinate system of the `<canvas>` (which has its origin at the top-left corner of the canvas), returns the corresponding point in the {@link InfiniteCanvas}'s coordinate system
+     */
+    readonly transformation: TransformationRepresentation;
+    /**
+     * The inverse of {@link transformation}
+     */
+    readonly inverseTransformation: TransformationRepresentation;
+}
+export * from './transformation-representation';

dist/types/custom-events/transformation-representation.d.ts

@@ -0,0 +1,10 @@
+export declare enum Units {
+    /**
+     * This value indicates that the {@link InfiniteCanvas} will use a coordinate system whose units correspond to CSS pixels.
+     */
+    CSS = 0,
+    /**
+     * This value indicates that the {@link InfiniteCanvas} will use a coordinate system that corresponds to the underlying `<canvas>`'s `width` and `height` properties.
+     */
+    CANVAS = 1
+}

dist/types/draw-event.d.ts

@@ -1,5 +1,5 @@
 * [Home](/)
 * [Live demo](live-demo.md)
 * [Getting started](getting-started.md)
-* [API Reference](api_reference.md)
+* [API Reference](api/)
 * [Infinity](infinity.md)

dist/types/event-listener.d.ts

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

dist/types/event-map.d.ts

@@ -0,0 +1,60 @@
+ef-infinite-canvas
+
+# ef-infinite-canvas
+
+## Enumerations
+
+- [Units](api/enums/Units.md)
+
+## Interfaces
+
+- [AddEventListenerOptions](api/interfaces/AddEventListenerOptions.md)
+- [Config](api/interfaces/Config.md)
+- [DrawEvent](api/interfaces/DrawEvent.md)
+- [EventMap](api/interfaces/EventMap.md)
+- [InfiniteCanvas](api/interfaces/InfiniteCanvas.md)
+- [InfiniteCanvasCtr](api/interfaces/InfiniteCanvasCtr.md)
+- [InfiniteCanvasRenderingContext2D](api/interfaces/InfiniteCanvasRenderingContext2D.md)
+- [TransformationEvent](api/interfaces/TransformationEvent.md)
+- [TransformationRepresentation](api/interfaces/TransformationRepresentation.md)
+- [Transformed](api/interfaces/Transformed.md)
+
+## Type Aliases
+
+### EventListener
+
+Ƭ **EventListener**<`K`\>: (`ev`: [`EventMap`](api/interfaces/EventMap.md)[`K`]) => `void`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`EventMap`](api/interfaces/EventMap.md) |
+
+#### Type declaration
+
+▸ (`ev`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ev` | [`EventMap`](api/interfaces/EventMap.md)[`K`] |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[event-listener.ts:4](https://github.com/emilefokkema/infinite-canvas/blob/c465771/src/api-surface/event-listener.ts#L4)
+
+## Variables
+
+### default
+
+• **default**: [`InfiniteCanvasCtr`](api/interfaces/InfiniteCanvasCtr.md)
+
+#### Defined in
+
+[infinite-canvas.ts:56](https://github.com/emilefokkema/infinite-canvas/blob/c465771/src/api-surface/infinite-canvas.ts#L56)

dist/types/infinite-canvas-declaration.d.ts

@@ -0,0 +1,27 @@
+[ef-infinite-canvas](api/README.md) / Units
+
+# Enumeration: Units
+
+## Enumeration Members
+
+### CANVAS
+
+• **CANVAS** = ``1``
+
+This value indicates that the [InfiniteCanvas](api/interfaces/InfiniteCanvas.md) will use a coordinate system that corresponds to the underlying `<canvas>`'s `width` and `height` properties.
+
+#### Defined in
+
+[units.ts:9](https://github.com/emilefokkema/infinite-canvas/blob/c465771/src/api-surface/units.ts#L9)
+
+___
+
+### CSS
+
+• **CSS** = ``0``
+
+This value indicates that the [InfiniteCanvas](api/interfaces/InfiniteCanvas.md) will use a coordinate system whose units correspond to CSS pixels.
+
+#### Defined in
+
+[units.ts:5](https://github.com/emilefokkema/infinite-canvas/blob/c465771/src/api-surface/units.ts#L5)