Merge pull request #22353 from DefinitelyTyped/not-needed-svg-pan-zoom

svg-pan-zoom: Provides its own types
This commit is contained in:
Paul van Brenk
2017-12-28 16:41:21 -08:00
committed by GitHub
8 changed files with 6 additions and 687 deletions

View File

@@ -1,213 +0,0 @@
// Type definitions for svg-pan-zoom v3.3.0
// Project: https://github.com/ariutta/svg-pan-zoom
// Definitions by: César Vidril <https://github.com/Yimiprod>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace SvgPanZoom {
interface Options {
viewportSelector?: string|HTMLElement|SVGElement; // can be querySelector string or SVGElement (default enabled)
panEnabled?: boolean; // enable or disable panning (default enabled)
controlIconsEnabled?: boolean; // insert icons to give user an option in addition to mouse events to control pan/zoom (default disabled)
zoomEnabled?: boolean; // enable or disable zooming (default enabled)
dblClickZoomEnabled?: boolean; // enable or disable zooming by double clicking (default enabled)
mouseWheelZoomEnabled?: boolean; // (default enabled)
preventMouseEventsDefault?: boolean; // (default enabled)
zoomScaleSensitivity?: number; // Zoom sensitivity (Default 0.2)
minZoom?: number; // Minimum Zoom level (Default 0.5)
maxZoom?: number; // Maximum Zoom level (Default 10)
fit?: boolean; // enable or disable viewport fit in SVG (default true)
contain?: boolean; // (default true)
center?: boolean; // enable or disable viewport centering in SVG (default true)
refreshRate?: number | 'auto'; // (default 'auto')
beforeZoom?: (oldScale:number, newScale:number) => boolean;
onZoom?: (newScale:number) => void;
beforePan?: (oldPan:Point, newPan:Point) => boolean | PointModifier;
onPan?: (newPan:Point) => void;
customEventsHandler?: CustomEventHandler; // (default null)
eventsListenerElement?: SVGElement; // (default null)
}
interface CustomEventHandler {
haltEventListeners: string[],
init: (options: CustomEventOptions) => void,
destroy: Function
}
interface CustomEventOptions {
svgElement: SVGSVGElement,
instance: Instance
}
interface Point {
x: number;
y: number;
}
interface PointModifier {
x: number|boolean;
y: number|boolean;
}
interface Instance {
/**
* Creates a new SvgPanZoom instance with given element selector.
*
* @param {string|HTMLElement|SVGElement} svg selector of the tag on which it is to be applied.
* @param {Object} options provides customization options at the initialization of the object.
* @return {Instance} Current instance
*/
(svg:string|HTMLElement|SVGElement, options?:Options): Instance;
/**
* Enables Panning on svg element
* @return {Instance} Current instance
*/
enablePan(): Instance;
/**
* Disables panning on svg element
* @return {Instance} Current instance
*/
disablePan(): Instance;
/**
* Checks if Panning is enabled or not
* @return {Boolean} true or false based on panning settings
*/
isPanEnabled(): boolean;
setBeforePan(fn: (point:Point)=> void): Instance;
setOnPan(fn: (x:number, y:number)=> void): Instance;
/**
* Pan to a rendered position
*
* @param {Object} point {x: 0, y: 0}
* @return {Instance} Current instance
*/
pan(point: Point): Instance;
/**
* Relatively pan the graph by a specified rendered position vector
*
* @param {Object} point {x: 0, y: 0}
* @return {Instance} Current instance
*/
panBy(point: Point): Instance;
/**
* Get pan vector
*
* @return {Object} {x: 0, y: 0}
* @return {Instance} Current instance
*/
getPan(): Point;
resetPan(): Instance;
enableZoom(): Instance;
disableZoom(): Instance;
isZoomEnabled(): boolean;
enableControlIcons(): Instance;
disableControlIcons(): Instance;
isControlIconsEnabled(): boolean;
enableDblClickZoom(): Instance;
disableDblClickZoom(): Instance;
isDblClickZoomEnabled(): boolean;
enableMouseWheelZoom(): Instance;
disableMouseWheelZoom(): Instance;
isMouseWheelZoomEnabled(): boolean;
setZoomScaleSensitivity(scale: number): Instance;
setMinZoom(zoom: number): Instance;
setMaxZoom(zoom: number): Instance;
setBeforeZoom(fn: (scale: number) => void): Instance;
setOnZoom(fn: (scale: number) => void): Instance;
zoom(scale: number):void;
zoomIn(): Instance;
zoomOut(): Instance;
zoomBy(scale: number): Instance;
zoomAtPoint(scale:number, point:Point): Instance;
zoomAtPointBy(scale:number, point:Point): Instance;
resetZoom(): Instance;
/**
* Get zoom scale/level
*
* @return {float} zoom scale
*/
getZoom(): number;
/**
* Adjust viewport size (only) so it will fit in SVG
* Does not center image
*
* @return {Instance} Current instance
*/
fit(): Instance;
/**
* Adjust viewport size (only) so it will contain in SVG
* Does not center image
*
* @return {Instance} Current instance
*/
contain(): Instance;
/**
* Adjust viewport pan (only) so it will be centered in SVG
* Does not zoom/fit image
*
* @return {Instance} Current instance
*/
center(): Instance;
/**
* Recalculates cached svg dimensions and controls position
*
* @return {Instance} Current instance
*/
resize(): Instance;
reset(): Instance;
/**
* Update content cached BorderBox
* Use when viewport contents change
*
* @return {Instance} Current instance
*/
updateBBox(): Instance;
destroy(): void;
}
}
declare const svgPanZoom:SvgPanZoom.Instance;
declare module 'svg-pan-zoom' {
export = svgPanZoom;
}

View File

@@ -1,113 +0,0 @@
var svgPanZoomOptions : SvgPanZoom.Options = {
panEnabled: true // enable or disable panning (default enabled)
, controlIconsEnabled: false // insert icons to give user an option in addition to mouse events to control pan/zoom (default disabled)
, zoomEnabled: true // enable or disable zooming (default enabled)
, dblClickZoomEnabled: true // enable or disable zooming by double clicking (default enabled)
, zoomScaleSensitivity: 0.2 // Zoom sensitivity
, minZoom: 0.5 // Minimum Zoom level
, maxZoom: 10 // Maximum Zoom level
, fit: true // enable or disable viewport fit in SVG (default true)
, center: true // enable or disable viewport centering in SVG (default true)
, beforeZoom: null
, onZoom: function(){}
, beforePan: null
, onPan: function(){}
, refreshRate: 60 // in hz
};
var panZoomTiger: SvgPanZoom.Instance = svgPanZoom('#demo-tiger');
var svgElement = <SVGElement>document.querySelector('#demo-tiger');
panZoomTiger = svgPanZoom(svgElement);
panZoomTiger = svgPanZoom('#demo-tiger', {
panEnabled: true
, controlIconsEnabled: false
, zoomEnabled: true
, dblClickZoomEnabled: true
, mouseWheelZoomEnabled: true
, preventMouseEventsDefault: true
, zoomScaleSensitivity: 0.2
, minZoom: 0.5
, maxZoom: 10
, fit: true
, contain: false
, center: true
, refreshRate: 'auto'
, beforeZoom: function(oldScale, newScale){ return true; }
, onZoom: function(newScale){}
, beforePan: function(oldPan, newPan){ return {x: true, y: true}; }
, customEventsHandler: null
, eventsListenerElement: null
});
/**
* PAN
*/
// Pan to rendered point x = 50, y = 50
panZoomTiger.pan({x: 50, y: 50});
// Pan by x = 50, y = 50 of rendered pixels
panZoomTiger.panBy({x: 50, y: 50});
panZoomTiger.getPan();
panZoomTiger.resetPan();
panZoomTiger.enablePan();
panZoomTiger.disablePan();
panZoomTiger.isPanEnabled();
/**
* ZOOM
*/
// Set zoom level to 2
panZoomTiger.zoom(2);
// Zoom by 130%
panZoomTiger.zoomBy(1.3);
// Set zoom level to 2 at point
panZoomTiger.zoomAtPoint(2, {x: 50, y: 50});
// Zoom by 130% at point
panZoomTiger.zoomAtPointBy(1.3, {x: 50, y: 50});
panZoomTiger.zoomIn();
panZoomTiger.zoomOut();
panZoomTiger.getZoom();
panZoomTiger.resetZoom();
panZoomTiger.enableZoom();
panZoomTiger.disableZoom();
panZoomTiger.isZoomEnabled();
/**
* controls
*/
panZoomTiger.enableControlIcons();
panZoomTiger.disableControlIcons();
panZoomTiger.isControlIconsEnabled();
panZoomTiger.enableDblClickZoom();
panZoomTiger.disableDblClickZoom();
panZoomTiger.isDblClickZoomEnabled();
panZoomTiger.enableMouseWheelZoom();
panZoomTiger.disableMouseWheelZoom();
panZoomTiger.isMouseWheelZoomEnabled();
panZoomTiger.center();
panZoomTiger.fit();
panZoomTiger.contain();
panZoomTiger.resize(); // update SVG cached size and controls positions
panZoomTiger.updateBBox();
panZoomTiger.fit().center(); // can chain method
panZoomTiger.destroy(); // destroy instance

View File

@@ -1,24 +0,0 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6",
"dom"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": false,
"strictFunctionTypes": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"svg-pan-zoom-tests.ts"
]
}

View File

@@ -1,79 +0,0 @@
{
"extends": "dtslint/dt.json",
"rules": {
"adjacent-overload-signatures": false,
"array-type": false,
"arrow-return-shorthand": false,
"ban-types": false,
"callable-types": false,
"comment-format": false,
"dt-header": false,
"eofline": false,
"export-just-namespace": false,
"import-spacing": false,
"interface-name": false,
"interface-over-type-literal": false,
"jsdoc-format": false,
"max-line-length": false,
"member-access": false,
"new-parens": false,
"no-any-union": false,
"no-boolean-literal-compare": false,
"no-conditional-assignment": false,
"no-consecutive-blank-lines": false,
"no-construct": false,
"no-declare-current-package": false,
"no-duplicate-imports": false,
"no-duplicate-variable": false,
"no-empty-interface": false,
"no-for-in-array": false,
"no-inferrable-types": false,
"no-internal-module": false,
"no-irregular-whitespace": false,
"no-mergeable-namespace": false,
"no-misused-new": false,
"no-namespace": false,
"no-object-literal-type-assertion": false,
"no-padding": false,
"no-redundant-jsdoc": false,
"no-redundant-jsdoc-2": false,
"no-redundant-undefined": false,
"no-reference-import": false,
"no-relative-import-in-test": false,
"no-self-import": false,
"no-single-declare-module": false,
"no-string-throw": false,
"no-unnecessary-callback-wrapper": false,
"no-unnecessary-class": false,
"no-unnecessary-generics": false,
"no-unnecessary-qualifier": false,
"no-unnecessary-type-assertion": false,
"no-useless-files": false,
"no-var-keyword": false,
"no-var-requires": false,
"no-void-expression": false,
"no-trailing-whitespace": false,
"object-literal-key-quotes": false,
"object-literal-shorthand": false,
"one-line": false,
"one-variable-per-declaration": false,
"only-arrow-functions": false,
"prefer-conditional-expression": false,
"prefer-const": false,
"prefer-declare-function": false,
"prefer-for-of": false,
"prefer-method-signature": false,
"prefer-template": false,
"radix": false,
"semicolon": false,
"space-before-function-paren": false,
"space-within-parens": false,
"strict-export-declare-modifiers": false,
"trim-file": false,
"triple-equals": false,
"typedef-whitespace": false,
"unified-signatures": false,
"void-return": false,
"whitespace": false
}
}

View File

@@ -1,151 +0,0 @@
// Type definitions for svg-pan-zoom v2.3.9
// Project: https://github.com/ariutta/svg-pan-zoom
// Definitions by: Chintan Shah <https://github.com/Promact>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace SvgPanZoom {
interface OptionConfig {
panEnabled?: boolean; // enable or disable panning (default enabled)
controlIconsEnabled?: boolean; // insert icons to give user an option in addition to mouse events to control pan/zoom (default disabled)
zoomEnabled?: boolean; // enable or disable zooming (default enabled)
dblClickZoomEnabled?: boolean; // enable or disable zooming by double clicking (default enabled)
zoomScaleSensitivity?: number; // Zoom sensitivity
minZoom?: number; // Minimum Zoom level
maxZoom?: number; // Maximum Zoom level
fit?: boolean; // enable or disable viewport fit in SVG (default true)
center?: boolean; // enable or disable viewport centering in SVG (default true)
beforeZoom?: (scale:number) => void;
onZoom?: (scale:number) => void;
beforePan?: (point:IPoint) => void;
onPan?: (x:number, y:number) => void;
refreshRate?: any; // in hz
}
interface IPoint {
x: number;
y: number;
}
interface ISvgPanZoom {
/**
* Creates a new SvgPanZoom instance with given element selector.
*
* @param svg selector of the tag on which it is to be applied.
* @param options provides customization options at the initialization of the object.
*/
(svg:any, options?:OptionConfig): ISvgPanZoom;
/**
* Enables Panning on svg element
*/
enablePan(): void;
/**
* Disables panning on svg element
*/
disablePan(): void;
/**
* Checks if Panning is enabled or not
* @return true or false based on panning settings
*/
isPanEnabled(): boolean;
setBeforePan(fn: (point:IPoint)=> void): void;
setOnPan(fn: (x:number, y:number)=> void): void;
enableZoom(): void;
disableZoom(): void;
isZoomEnabled(): boolean;
enableControlIcons(): void;
disableControlIcons(): void;
isControlIconsEnabled(): boolean;
enableDblClickZoom(): void;
disableDblClickZoom(): void;
setZoomScaleSensitivity(scale: number): void;
setMinZoom(zoom: number): void;
setMaxZoom(zoom: number): void;
setBeforeZoom(fn: (scale: number) => void): void;
setOnZoom(fn: (scale: number) => void): void;
zoom(scale: number):void;
zoomIn(): void;
zoomOut(): void;
zoomBy(scale: number): void;
resetZoom(): void;
/**
* Get zoom scale/level
*
* @return {float} zoom scale
*/
getZoom(): number;
/**
* Adjust viewport size (only) so it will fit in SVG
* Does not center image
*
* @param {bool} dropCache drop viewBox cache and recalculate SVG's viewport sizes. Default false
*/
fit(dropCache?: boolean): void;
/**
* Adjust viewport pan (only) so it will be centered in SVG
* Does not zoom/fit image
*
* @param {bool} dropCache drop viewBox cache and recalculate SVG's viewport sizes. Default false
*/
center(dropCache?: boolean): void;
/**
* Recalculates cached svg dimensions and controls position
*/
resize(): void;
/**
* Pan to a rendered position
*
* @param {object} point {x: 0, y: 0}
*/
pan(point: IPoint): void;
/**
* Relatively pan the graph by a specified rendered position vector
*
* @param {object} point {x: 0, y: 0}
*/
panBy(point: IPoint): void;
/**
* Get pan vector
*
* @return {object} {x: 0, y: 0}
*/
getPan(): IPoint;
zoomAtPoint(scale:number, point:IPoint): boolean;
zoomAtPointBy(scale:number, point:IPoint): boolean;
}
}
declare var svgPanZoom:SvgPanZoom.ISvgPanZoom;

View File

@@ -1,28 +0,0 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6",
"dom"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../../",
"typeRoots": [
"../../"
],
"types": [],
"paths": {
"svg-pan-zoom": [
"svg-pan-zoom/v2"
]
},
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts"
]
}

View File

@@ -1,79 +0,0 @@
{
"extends": "dtslint/dt.json",
"rules": {
"adjacent-overload-signatures": false,
"array-type": false,
"arrow-return-shorthand": false,
"ban-types": false,
"callable-types": false,
"comment-format": false,
"dt-header": false,
"eofline": false,
"export-just-namespace": false,
"import-spacing": false,
"interface-name": false,
"interface-over-type-literal": false,
"jsdoc-format": false,
"max-line-length": false,
"member-access": false,
"new-parens": false,
"no-any-union": false,
"no-boolean-literal-compare": false,
"no-conditional-assignment": false,
"no-consecutive-blank-lines": false,
"no-construct": false,
"no-declare-current-package": false,
"no-duplicate-imports": false,
"no-duplicate-variable": false,
"no-empty-interface": false,
"no-for-in-array": false,
"no-inferrable-types": false,
"no-internal-module": false,
"no-irregular-whitespace": false,
"no-mergeable-namespace": false,
"no-misused-new": false,
"no-namespace": false,
"no-object-literal-type-assertion": false,
"no-padding": false,
"no-redundant-jsdoc": false,
"no-redundant-jsdoc-2": false,
"no-redundant-undefined": false,
"no-reference-import": false,
"no-relative-import-in-test": false,
"no-self-import": false,
"no-single-declare-module": false,
"no-string-throw": false,
"no-unnecessary-callback-wrapper": false,
"no-unnecessary-class": false,
"no-unnecessary-generics": false,
"no-unnecessary-qualifier": false,
"no-unnecessary-type-assertion": false,
"no-useless-files": false,
"no-var-keyword": false,
"no-var-requires": false,
"no-void-expression": false,
"no-trailing-whitespace": false,
"object-literal-key-quotes": false,
"object-literal-shorthand": false,
"one-line": false,
"one-variable-per-declaration": false,
"only-arrow-functions": false,
"prefer-conditional-expression": false,
"prefer-const": false,
"prefer-declare-function": false,
"prefer-for-of": false,
"prefer-method-signature": false,
"prefer-template": false,
"radix": false,
"semicolon": false,
"space-before-function-paren": false,
"space-within-parens": false,
"strict-export-declare-modifiers": false,
"trim-file": false,
"triple-equals": false,
"typedef-whitespace": false,
"unified-signatures": false,
"void-return": false,
"whitespace": false
}
}