flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[paper] Include Base class definition + type save getters and setters (#35285)

Browse Source 
* [paper] Add Base class

* [paper] Type save getters and setters

* [paper] import/export test

* [paper] Fix: "Common mistakes"

* [paper] Tabs to spaces
This commit is contained in:
Михайлов Антон 2019-05-14 03:52:32 +05:00 committed by Nathan Shively-Sanders
parent fd9556065b
commit 3db468885f
2 changed files with 2984 additions and 2967 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

349
types/paper/index.d.ts vendored
View File

@ -4,7 +4,9 @@
// Jon Lucas <https://github.com/Xakaloz>,
// Sebastian Lopez <https://github.com/sebaswebdev>
// Ryan Friedman <https://github.com/rfried>
// Mikhaylov Anton <https://github.com/anion155>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
type NativeMouseEvent = MouseEvent;
@ -13,6 +15,68 @@ type NativeMouseEvent = MouseEvent;
*/
declare module paper {
/**
* Base class for all library classes.
*/
class Base {
/**
* Checks if two values or objects are equals to each other, by using their
* equals() methods if available, and also comparing elements of arrays and
* properties of objects.
*/
static equals(obj1: any, obj2: any): boolean;
/**
* Imports (deserializes) the stored JSON data into the target, if the
* classes match. If they do not match, a newly created object is returned
* instead.
*/
static importJSON(json: object | any[] | string, target?: any): any;
static importJSON<T extends Base>(json: T, target?: T): T;
/**
* Exports (serializes) object to a JSON data object or string.
*
*
* @param options [optional] - the serialization options
* @option [options.asString=true] - whether the JSON is returned as a Object or a String.
* @option [options.precision=5] - the amount of fractional digits in numbers used in JSON data.
* @return the exported JSON data
*/
static exportJSON(obj: any, options?: { asString?: true; precision?: number; }): string;
static exportJSON(obj: any, options: { asString: false; precision?: number; }): object | any[];
/**
* Imports (deserializes) the stored JSON data into the object, if the
* classes match. If they do not match, a newly created object is returned
* instead.
*/
importJSON(json: string): void;
importJSON<T extends Base>(json: T): T;
/**
* Exports (serializes) this object to a JSON data object or string.
*
*
* @param options [optional] - the serialization options
* @option [options.asString=true] - whether the JSON is returned as a Object or a String.
* @option [options.precision=5] - the amount of fractional digits in numbers used in JSON data.
* @return the exported JSON data
*/
exportJSON(options?: { asString?: true; precision?: number; }): string;
exportJSON(options: { asString: false; precision?: number; }): object | any[];
/**
* Renders base objects to strings in object literal notation.
*/
toString(): string;
/**
* Same as `exportJSON({ asString: false })`.
*/
toJSON(): string;
}
/**
* The version of Paper.js, as a string.
*/
@ -72,8 +136,7 @@ declare module paper {
* Such a coordinate transformation can be represented by a 3 row by 3 column matrix with an implied last row of [ 0 0 1 ]. This matrix transforms source coordinates (x,y) into destination coordinates (x',y') by considering them to be a column vector and multiplying the coordinate vector by the matrix according to the following process:
* This class is optimized for speed and minimizes calculations based on its knowledge of the underlying matrix (as opposed to say simply performing matrix multiplication).
*/
export class Matrix {
export class Matrix extends Base {
/**
* Creates a 2D affine transform.
* @param a - the a property of the transform
@ -190,11 +253,6 @@ declare module paper {
*/
equals(matrix: Matrix): boolean;
/**
* returns a string representation of this transform
*/
toString(): string;
/**
* Resets the matrix by setting its values to the ones of the identity matrix that results in no transformation.
*/
@ -360,7 +418,7 @@ declare module paper {
* Attempts to decompose the affine transformation described by this matrix into scaling, rotation and shearing, and returns an object with these properties if it succeeded, null otherwise.
*/
decompose(): any;
/**
* Inverts the matrix, causing it to perform the opposite transformation. If the matrix is not invertible (in which case isSingular() returns true), null is returned.
*/
@ -381,7 +439,7 @@ declare module paper {
/**
* The Point object represents a point in the two dimensional space of the Paper.js project. It is also used to represent two dimensional vector objects.
*/
export class Point {
export class Point extends Base {
/**
* Returns a new point object with the smallest x and y of the supplied points.
@ -514,11 +572,6 @@ declare module paper {
*/
clone(): Point;
/**
* a string representation of the point
*/
toString(): string;
/**
* Returns the smaller angle between two vectors. The angle is unsigned, no information about rotational direction is given.
* @param point -
@ -692,7 +745,7 @@ declare module paper {
/**
* A Rectangle specifies an area that is enclosed by it's top-left point (x, y), its width, and its height. It should not be confused with a rectangular path, it is not an item.
*/
export class Rectangle {
export class Rectangle extends Base {
/**
* Creates a Rectangle object.
@ -882,11 +935,6 @@ declare module paper {
*/
equals(rect: Rectangle): boolean;
/**
* a string representation of this rectangle
*/
toString(): string;
/**
* Returns true if the rectangle is empty, false otherwise
*/
@ -962,7 +1010,7 @@ declare module paper {
/**
* The Size object is used to describe the size or dimensions of something, through its width and height properties.
*/
export class Size {
export class Size extends Base {
/**
* Returns a new size object with the smallest width and height of the supplied sizes.
@ -1034,11 +1082,6 @@ declare module paper {
*/
clone(): Size;
/**
* a string representation of the size
*/
toString(): string;
/**
* Checks if this size has both the width and height set to 0.
*/
@ -1109,32 +1152,32 @@ declare module paper {
modulo(size: number[]): Size;
modulo(size: number): Size;
/**
* Sets the size with the given width and height values.
/**
* Sets the size with the given width and height values.
* @param width - the width
* @param height - the height
*/
set(width: number, height: number): Size;
*/
set(width: number, height: number): Size;
/**
* Sets the size using the numbers in the given array as dimensions.
/**
* Sets the size using the numbers in the given array as dimensions.
* @param array - an array of numbers
*/
set(array: number[]): Size;
/**
* Sets the size using the properties in the given object.
*/
set(array: number[]): Size;
/**
* Sets the size using the properties in the given object.
* @param object - the object literal containing properies (width:10, height:10 etc)
*/
set(object: any): Size;
/**
* Sets the size using the coordinates of the given Size object.
*/
set(object: any): Size;
/**
* Sets the size using the coordinates of the given Size object.
* @param size - the size to duplicate from
*/
set(size: Size): Size;
/**
set(size: Size): Size;
/**
* Sets the size using the point.x and point.y values of the given Point object.
* @param point - the point from which to create a size
*/
@ -1165,7 +1208,7 @@ declare module paper {
* Paper classes can only be accessed through PaperScope objects. Thus in PaperScript they are global, while in JavaScript, they are available on the global paper object. For JavaScript you can use paperScope.install(scope) to install the Paper classes and objects on the global scope. Note that when working with more than one scope, this still works for classes, but not for objects like paperScope.project, since they are not updated in the injected scope if scopes are switched.
* The global paper object is simply a reference to the currently active PaperScope.
*/
export class PaperScope {
export class PaperScope extends Base {
/**
* The version of Paper.js, as a string.
@ -1308,12 +1351,12 @@ declare module paper {
* only hit selected items.
*/
selected?: boolean;
}
/**
* The Item type allows you to access and modify the items in Paper.js projects. Its functionality is inherited by different project item types such as Path, CompoundPath, Group, Layer and Raster. They each add a layer of functionality that is unique to their type, but share the underlying properties and functions that they inherit from Item.
*/
export class Item {
export class Item extends Base {
/**
* The tangential vector to the #curve at the given location.
@ -1350,13 +1393,15 @@ declare module paper {
/**
* The path style of the item.
*/
style: Style;
style: Partial<Style>;
getStyle(): Style;
setStyle(value: Partial<Style>): void;
/**
* Specifies whether the item is locked. When set to true, item interactions with the mouse are disabled.
*/
locked: boolean;
/**
* Specifies whether the item is visible. When set to false, the item won't be drawn.
*/
@ -1377,7 +1422,7 @@ declare module paper {
* Specifies whether the item is selected. This will also return true for Group items if they are partially selected, e.g. groups containing selected or partially selected paths.
* Paper.js draws the visual outlines of selected items on top of your project. This can be useful for debugging, as it allows you to see the construction of paths, position of path curves, individual segment points and bounding boxes of symbol and raster items.
*/
selected: boolean;
selected: boolean;
/**
* Specifies whether the item and all children are selected.
@ -1511,6 +1556,8 @@ declare module paper {
* The color of the stroke.
*/
strokeColor: Color | string | null;
getStrokeColor(): Color;
setStrokeColor(value: Color | string | null): void;
/**
* The width of the stroke.
@ -1559,6 +1606,8 @@ declare module paper {
* The fill color of the item.
*/
fillColor: Color | string | null;
getFillColor(): Color;
setFillColor(value: Color | string | null): void;
/**
* The fill-rule with which the shape gets filled. Please note that only modern browsers support fill-rules other than 'nonzero'.
@ -1571,6 +1620,8 @@ declare module paper {
* The shadow color.
*/
shadowColor: Color | string | null;
getShadowColor(): Color;
setShadowColor(value: Color | string | null): void;
/**
* The shadow’s blur radius.
@ -1588,6 +1639,8 @@ declare module paper {
* The color the item is highlighted with when selected. If the item does not specify its own color, the color defined by its layer is used instead.
*/
selectedColor: Color | string;
getSelectedColor(): Color;
setSelectedColor(value: Color | string): void;
/**
* Item level handler function to be called on each frame of an animation.
@ -1621,7 +1674,7 @@ declare module paper {
onClick: (event: MouseEvent) => void | boolean;
/**
* The function to be called when the mouse double clicks on the item. The function receives a MouseEvent object which contains information about the mouse event. *
* The function to be called when the mouse double clicks on the item. The function receives a MouseEvent object which contains information about the mouse event. *
* Note that such mouse events bubble up the scene graph hierarchy and will reach the view, unless they are stopped with event.stopPropagation() or by returning false from the handler.
*/
onDoubleClick: (event: MouseEvent) => void | boolean;
@ -1772,20 +1825,6 @@ declare module paper {
*/
getItem(match: any): Item;
/**
* Exports (serializes) the project with all its layers and child items to a JSON data string.
* @param options [optional] - default {asString: true, precision: 5}
* @param options.asString - whether the JSON is returned as a Object or a String.
* @param options.precision - the amount of fractional digits in numbers used in JSON data.
*/
exportJSON(options?: { asString?: boolean; precision?: number; }): string;
/**
* Imports (deserializes) the stored JSON data into the project.
* Note that the project is not cleared first. You can call project.clear() to do so.
*/
importJSON(json: string): void;
/**
* Exports the project with all its layers and child items as an SVG DOM, all contained in one top level SVG group node.
* @param options [optional] the export options, default: { asString: false, precision: 5, matchShapes: false, bounds: 'view', matrix: paper.view.matrix, embedImages: true }
@ -1818,7 +1857,7 @@ declare module paper {
* @param onLoad [optional] - the callback function to call once the SVG content is loaded from the given URL receiving two arguments: the converted item and the original svg data as a string. Only required when loading from external resources.
*/
importSVG(svg: SVGElement | string, onLoad?: (item: Item, svg: string) => void): Item;
/**
* Adds the specified item as a child of this item at the end of the its children list. You can use this function for groups, compound paths and layers.
* @param item - the item to add as a child
@ -1898,13 +1937,13 @@ declare module paper {
* @param owner - the item or project to add the item to
*/
addTo(owner: Project | Layer | Group | CompoundPath): Item;
/**
* Clones the item and adds it to the specified owner, which can be either a Item or a Project.
* @param owner - the item or project to copy the item to
*/
copyTo(owner: Project | Layer | Group | CompoundPath): Item;
/**
* If this is a group, layer or compound-path with only one child-item, the child-item is moved outside and the parent is erased. Otherwise, the item itself is returned unmodified.
* @param options [optional]
@ -2561,7 +2600,7 @@ declare module paper {
/**
* A HitResult object contains information about the results of a hit test. It is returned by item.hitTest(point) and project.hitTest(point).
*/
export class HitResult {
export class HitResult extends Base {
/**
* Describes the type of the hit result. For example, if you hit a segment point, the type would be 'segment'.
@ -2633,7 +2672,7 @@ declare module paper {
* Specifies whether the path as a whole is oriented clock-wise, by looking at the path’s area. Note that self-intersecting paths and sub-paths of different orientation can result in areas that cancel each other out.
*/
clockwise: boolean;
/**
* The path's geometry, formatted as SVG style path data.
*/
@ -2660,7 +2699,7 @@ declare module paper {
* @param path - the path to intersect with
* @param options [optional] - the boolean operation options. default { insert: true, trace: true }
* @param options.insert - whether the resulting item should be inserted back into the scene graph, above both paths involved in the operation.
* @param options.trace - whether the tracing method is used, treating both paths as areas when determining which parts of the paths are to be kept in the result, or whether the first path is only to be split at intersections, keeping the parts of the curves that intersect with the area of the second path.
* @param options.trace - whether the tracing method is used, treating both paths as areas when determining which parts of the paths are to be kept in the result, or whether the first path is only to be split at intersections, keeping the parts of the curves that intersect with the area of the second path.
*/
intersect(path: PathItem, options?: { insert?: boolean; trace?: boolean; }): PathItem;
@ -2669,7 +2708,7 @@ declare module paper {
* @param path - the path to subtract
* @param options [optional] - the boolean operation options. default { insert: true, trace: true }
* @param options.insert - whether the resulting item should be inserted back into the scene graph, above both paths involved in the operation.
* @param options.trace - whether the tracing method is used, treating both paths as areas when determining which parts of the paths are to be kept in the result, or whether the first path is only to be split at intersections, keeping the parts of the curves that intersect with the area of the second path.
* @param options.trace - whether the tracing method is used, treating both paths as areas when determining which parts of the paths are to be kept in the result, or whether the first path is only to be split at intersections, keeping the parts of the curves that intersect with the area of the second path.
*/
subtract(path: PathItem, options?: { insert?: boolean; trace?: boolean; }): PathItem;
@ -2787,7 +2826,7 @@ declare module paper {
* @param point - the end point of the line
*/
lineTo(point: Point): void;
/**
* Draws an arc from the position of the last segment point in the path that goes through the specified through point, to the specified to point by adding one or more segments to the path.
* @param through - the point where the arc should pass through
@ -3027,7 +3066,7 @@ declare module paper {
* Clears the path’s handles by setting their coordinates to zero, turning the path into a polygon (or a polyline if it isn’t closed).
*/
clearHandles(): void;
/**
* Divides the path on the curve at the given location into two curves, by inserting a new segment at the given location.
* @param location - the curve location at which to divide the existing curve by inserting a new segment
@ -3244,8 +3283,8 @@ declare module paper {
* @param object - an object literal containing properties describing the path's attributes
*/
constructor(object: any);
/**
* Clones the item within the same project and places the copy above the item.
* @param options [optional] - default: { insert: true, deep: true }
@ -3269,7 +3308,7 @@ declare module paper {
* @param object - an object literal containing properties describing the path's attributes
*/
constructor(object: any);
/**
* Clones the item within the same project and places the copy above the item.
* @param options [optional] - default: { insert: true, deep: true }
@ -3293,7 +3332,7 @@ declare module paper {
* @param object - an object literal containing properties describing the path's attributes
*/
constructor(object: any);
/**
* Clones the item within the same project and places the copy above the item.
* @param options [optional] - default: { insert: true, deep: true }
@ -3318,7 +3357,7 @@ declare module paper {
* @param object - an object literal containing properties describing the path's attributes
*/
constructor(object: any);
/**
* Clones the item within the same project and places the copy above the item.
* @param options [optional] - default: { insert: true, deep: true }
@ -3345,7 +3384,7 @@ declare module paper {
* @param pathData - the SVG path-data that describes the geometry of this path.
*/
constructor(pathData: string);
/**
* Specifies whether the path is closed. If it is closed, Paper.js connects the first and last segments.
*/
@ -3392,7 +3431,7 @@ declare module paper {
* Read only.
*/
readonly length: number;
/**
* Clones the item within the same project and places the copy above the item.
* @param options [optional] - default: { insert: true, deep: true }
@ -3405,7 +3444,7 @@ declare module paper {
* The Segment object represents the points of a path through which its Curve objects pass. The segments of a path can be accessed through its path.segments array.
* Each segment consists of an anchor point (segment.point) and optionaly an incoming and an outgoing handle (segment.handleIn and segment.handleOut), describing the tangents of the two Curve objects that are connected by this segment.
*/
export class Segment {
export class Segment extends Base {
/**
* Creates a new Segment object.
@ -3544,11 +3583,6 @@ declare module paper {
*/
clone(): Segment;
/**
* A string representation of the segment
*/
toString(): string;
/**
* Transform the segment by the specified matrix.
* @param matrix - the matrix to transform the segment by
@ -3568,7 +3602,7 @@ declare module paper {
* The Curve object represents the parts of a path that are connected by two following Segment objects. The curves of a path can be accessed through its path.curves array.
* While a segment describe the anchor point and its incoming and outgoing handles, a Curve object describes the curve passing between two such segments. Curves and segments represent two different ways of looking at the same thing, but focusing on different aspects. Curves for example offer many convenient ways to work with parts of the path, finding lengths, positions or tangents at given offsets.
*/
export class Curve {
export class Curve extends Base {
/**
* Creates a new curve object.
@ -3693,11 +3727,6 @@ declare module paper {
*/
clone(): Curve;
/**
* Returns a string representation of the curve
*/
toString(): string;
/**
* Determines the type of cubic Bézier curve via discriminant classification, as well as the curve-time parameters of the associated points of inflection, loops, cusps, etc.
* Returns the curve classification information as an object
@ -3775,7 +3804,7 @@ declare module paper {
* Returns a reversed version of the curve, without modifying the curve itself.
*/
reversed(): Curve;
/**
* Clears the curve’s handles by setting their coordinates to zero, turning the curve into a straight line.
*/
@ -3936,7 +3965,7 @@ declare module paper {
* CurveLocation objects describe a location on Curve objects, as defined by the curve parameter, a value between 0 (beginning of the curve) and 1 (end of the curve). If the curve is part of a Path item, its index inside the path.curves array is also provided.
* The class is in use in many places, such as path.getLocationAt(offset, isParameter), path.getLocationOf(point), Path#getNearestLocation(point),{@linkPathItem#getIntersections(path), etc.
*/
export class CurveLocation {
export class CurveLocation extends Base {
/**
* Creates a new CurveLocation object.
@ -4037,11 +4066,6 @@ declare module paper {
*/
equals(location: CurveLocation): boolean;
/**
* Returns a string representation of the curve location
*/
toString(): string;
/**
* Checks if the location is an intersection with another curve and is merely touching the other curve, as opposed to crossing it.
*/
@ -4064,7 +4088,7 @@ declare module paper {
* The currently active project can be accessed through the paperScope.project variable.
* An array of all open projects is accessible through the paperScope.projects variable.
*/
export class Project {
export class Project extends Base {
/**
* Creates a Paper.js project containing one empty Layer, referenced by project.activeLayer.
@ -4081,7 +4105,9 @@ declare module paper {
/**
* The currently active path style. All selected items and newly created items will be styled with this style.
*/
currentStyle: Style;
currentStyle: Partial<Style>;
getCurrentStyle(): Style;
setCurrentStyle(value: Partial<Style>): void;
/**
* The index of the project in the paperScope.projects list.
@ -4212,20 +4238,6 @@ declare module paper {
*/
getItem(match: any): Item;
/**
* Exports (serializes) the project with all its layers and child items to a JSON data string.
* @param options [optional] - default {asString: true, precision: 5}
* @param options.asString - whether the JSON is returned as a Object or a String.
* @param options.precision - the amount of fractional digits in numbers used in JSON data.
*/
exportJSON(options?: { asString?: boolean; precision?: number }): string;
/**
* Imports (deserializes) the stored JSON data into the project.
* Note that the project is not cleared first. You can call project.clear() to do so.
*/
importJSON(json: string): void;
/**
* Exports the project with all its layers and child items as an SVG DOM, all contained in one top level SVG group node.
* @param options [optional] the export options, default: { asString: false, precision: 5, matchShapes: false, bounds: 'view', matrix: paper.view.matrix, embedImages: true }
@ -4258,12 +4270,12 @@ declare module paper {
* @param onLoad [optional] - the callback function to call once the SVG content is loaded from the given URL receiving two arguments: the converted item and the original svg data as a string. Only required when loading from external resources.
*/
importSVG(svg: SVGElement | string, onLoad?: (item: Item, svg: string) => void): Item;
}
/**
* Symbols allow you to place multiple instances of an item in your project. This can save memory, since all instances of a symbol simply refer to the original item and it can speed up moving around complex objects, since internal properties such as segment lists and gradient positions don't need to be updated with every transformation.
*/
export class Symbol {
export class Symbol extends Base {
/**
* Creates a Symbol item.
@ -4306,127 +4318,135 @@ declare module paper {
* All properties of Style are also reflected directly in Item, i.e.: item.fillColor.
* To set multiple style properties in one go, you can pass an object to item.style. This is a convenient way to define a style once and apply it to a series of items:
*/
export class Style {
export class Style extends Base {
/**
* The view that this style belongs to.
* Read only.
*/
readonly view?: View;
readonly view: View;
/**
* The color of the stroke.
*/
strokeColor?: Color | string;
strokeColor: Color | string | null;
getStrokeColor(): Color;
setStrokeColor(value: Color | string | null): void;
/**
* The width of the stroke.
* Default: 1
*/
strokeWidth?: number;
strokeWidth: number;
/**
* The shape to be used at the beginning and end of open Path items, when they have a stroke.
* Values: 'round', 'square', 'butt'
* Default: 'butt'
*/
strokeCap?: string;
strokeCap: string;
/**
* The shape to be used at the segments and corners of Path items when they have a stroke.
* Values: 'miter', 'round', 'bevel'
* Default: 'miter'
*/
strokeJoin?: string;
strokeJoin: string;
/**
* Specifies whether the stroke is to be drawn taking the current affine transformation into account (the default behavior), or whether it should appear as a non-scaling stroke.
* Default: true
*/
strokeScaling?: boolean;
strokeScaling: boolean;
/**
* The dash offset of the stroke.
* Default: 0
*/
dashOffset?: number;
dashOffset: number;
/**
* Specifies an array containing the dash and gap lengths of the stroke.
* Default: []
*/
dashArray?: number[];
dashArray: number[];
/**
* The miter limit of the stroke. When two line segments meet at a sharp angle and miter joins have been specified for strokeJoin, it is possible for the miter to extend far beyond the strokeWidth of the path. The miterLimit imposes a limit on the ratio of the miter length to the strokeWidth.
* Default: 10
*/
miterLimit?: number;
miterLimit: number;
/**
* The fill color.
*/
fillColor?: Color | string;
fillColor: Color | string | null;
getFillColor(): Color;
setFillColor(value: Color | string | null): void;
/**
* The fill-rule with which the shape gets filled. Please note that only modern browsers support fill-rules other than 'nonzero'.
* Values: 'nonzero', 'evenodd'
* Default: 'nonzero'
*/
fillRule?: string;
fillRule: string;
/**
* The shadow color.
*/
shadowColor?: Color | string;
shadowColor: Color | string | null;
getShadowColor(): Color;
setShadowColor(value: Color | string | null): void;
/**
* The shadow's blur radius.
* Default: 0
*/
shadowBlur?: number;
shadowBlur: number;
/**
* The shadow's offset.
* Default: 0
*/
shadowOffset?: number | number[] | {x: number, y: number} | Point;
shadowOffset: number | number[] | {x: number, y: number} | Point;
/**
* The color the item is highlighted with when selected. If the item does not specify its own color, the color defined by its layer is used instead.
*/
selectedColor?: Color | string;
selectedColor: Color | string | null;
getSelectedColor(): Color;
setSelectedColor(value: Color | string | null): void;
/**
* The font-family to be used in text content.
* Default: 'sans-serif'
*/
fontFamily?: string;
fontFamily: string;
/**
* The font-weight to be used in text content.
* Default: 'normal'
*/
fontWeight?: string | number;
fontWeight: string | number;
/**
* The font size of text content, as {@Number} in pixels, or as {@String} with optional units 'px', 'pt' and 'em'.
* Default: 10
*/
fontSize?: string | number;
fontSize: string | number;
/**
* The text leading of text content.
* Default: fontSize * 1.2
*/
leading?: number | string;
leading: number | string;
/**
* The justification of text paragraphs.
* Values: 'left', 'right', 'center'
* Default: 'left'
*/
justification?: string;
justification: string;
}
export interface IHSBColor {
@ -4490,7 +4510,7 @@ declare module paper {
/**
* All properties and functions that expect color values in the form of instances of Color objects, also accept named colors and hex values as strings which are then converted to instances of Color internally.
*/
export class Color {
export class Color extends Base {
/**
* Creates a RGB Color object.
@ -4667,11 +4687,6 @@ declare module paper {
*/
clone(): Color;
/**
* a string representation of the color
*/
toString(): string;
/**
* Returns the color as a CSS string.
* @param hex - whether to return the color in hexadecial representation or as a CSS RGB / RGBA string.
@ -4695,7 +4710,7 @@ declare module paper {
* @param color - the color to add
*/
add(color: Color): Color;
/**
* Returns the subtraction of the supplied value to both coordinates of the color as a new color. The object itself is not modified!
* @param number - the number to subtract
@ -4707,7 +4722,7 @@ declare module paper {
* @param color - the color to subtract
*/
subtract(color: Color): Color;
/**
* Returns the multiplication of the supplied value to both coordinates of the color as a new color. The object itself is not modified!
* @param number - the number to multiply
@ -4736,7 +4751,7 @@ declare module paper {
/**
* The Gradient object.
*/
export class Gradient {
export class Gradient extends Base {
/**
* Creates a Gradient object.
@ -4744,7 +4759,7 @@ declare module paper {
* @param radial [optional] - Whether the gradient is radial or linear
*/
constructor(stops?:GradientStop[] | string[] | (string|number)[][], radial?:boolean);
/**
* Creates a Gradient object.
* @param object [optional] - an object literal containing the properties to be set on the group.
@ -4776,7 +4791,7 @@ declare module paper {
/**
* The GradientStop object.
*/
export class GradientStop {
export class GradientStop extends Base {
/**
* Creates a GradientStop object.
@ -4784,7 +4799,7 @@ declare module paper {
* @param rampPoint [optional] - the position of the stop on the gradient ramp as a value between 0 and 1, default: 0
*/
constructor(color?: Color | string, rampPoint?: number);
/**
* Creates a new GradientStop object.
* @param object [optional] - an object literal containing the properties to be set on the group.
@ -4811,7 +4826,9 @@ declare module paper {
/**
* The color of the gradient stop.
*/
color: Color;
color: Color | string;
getColor(): Color;
setColor(value: Color | string): void;
/**
* Returns a copy of the gradient-stop
@ -4822,7 +4839,7 @@ declare module paper {
/**
* The View object wraps an HTML element and handles drawing and user interaction through mouse and keyboard for it. It offer means to scroll the view, find the currently visible bounds in project coordinates, or the center, both useful for constructing artwork that should appear centered on screen.
*/
export class View {
export class View extends Base {
/**
* Controls whether the view is automatically updated in the next animation frame on changes, or whether you prefer to manually call update() or requestUpdate() after changes. Note that this is true by default, except for Node.js, where manual updates make more sense.
@ -5098,7 +5115,7 @@ declare module paper {
* Detach an event handler from the view.
* @param type - the event type: ‘frame’, ‘resize’, ‘mousedown’, ‘mouseup’, ‘mousedrag’, ‘click’, ‘doubleclick’, ‘mousemove’, ‘mouseenter’, ‘mouseleave’
* @param callback - The function to be detached
*/
*/
off(type: string, callback: (event: IFrameEvent) => void | boolean): Item;
/**
@ -5130,7 +5147,7 @@ declare module paper {
* The Tool object refers to a script that the user can interact with by using the mouse and keyboard and can be accessed through the global tool variable. All its properties are also available in the paper scope.
* The global tool variable only exists in scripts that contain mouse handler functions (onMouseMove, onMouseDown, onMouseDrag, onMouseUp) or a keyboard handler function (onKeyDown, onKeyUp).
*/
export class Tool {
export class Tool extends Base {
/**
* The minimum distance the mouse has to drag before firing the onMouseDrag event, since the last onMouseDrag event.
@ -5231,7 +5248,7 @@ declare module paper {
responds(type: string): boolean;
}
export class Event {
export class Event extends Base {
/**
* The time at which the event was created, in milliseconds since the epoch.
@ -5308,16 +5325,11 @@ declare module paper {
*/
item: Item;
/**
* a string representation of the tool event
*/
toString(): string;
}
export class Key {
/**
*
*
* The current state of the keyboard modifiers.
* modifiers.shift - true if the shift key is pressed, false otherwise.
* modifiers.control - true if the control key is pressed, false otherwise.
@ -5358,11 +5370,6 @@ declare module paper {
*/
key: string;
/**
* a string representation of the key event
*/
toString(): string;
}
/**
* The TextItem type allows you to create typography. Its functionality is inherited by different text item types such as PointText, and AreaText (coming soon). They each add a layer of functionality that is unique to their type, but share the underlying properties and functions that they inherit from TextItem.
@ -5487,8 +5494,8 @@ declare module paper {
type: 'mousedown' | 'mouseup' | 'mousedrag' | 'click' | 'doubleclick' | 'mousemove' | 'mouseenter' | 'mouseleave';
}
export interface Settings {
export interface Settings {
/**
* controls whether newly created items are automatically inserted into the scene graph, by adding them to project.activeLayer — default: true
*/

5602
types/paper/paper-tests.ts
View File

File diff suppressed because it is too large Load Diff