sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
45 lines
1.4 KiB
TypeScript
45 lines
1.4 KiB
TypeScript
/**
|
|
* @module ol/size
|
|
*/
|
|
/**
|
|
* An array of numbers representing a size: `[width, height]`.
|
|
* @typedef {Array<number>} Size
|
|
* @api
|
|
*/
|
|
/**
|
|
* Returns a buffered size.
|
|
* @param {Size} size Size.
|
|
* @param {number} num The amount by which to buffer.
|
|
* @param {Size} [opt_size] Optional reusable size array.
|
|
* @return {Size} The buffered size.
|
|
*/
|
|
export function buffer(size: Size, num: number, opt_size?: Size | undefined): Size;
|
|
/**
|
|
* Determines if a size has a positive area.
|
|
* @param {Size} size The size to test.
|
|
* @return {boolean} The size has a positive area.
|
|
*/
|
|
export function hasArea(size: Size): boolean;
|
|
/**
|
|
* Returns a size scaled by a ratio. The result will be an array of integers.
|
|
* @param {Size} size Size.
|
|
* @param {number} ratio Ratio.
|
|
* @param {Size} [opt_size] Optional reusable size array.
|
|
* @return {Size} The scaled size.
|
|
*/
|
|
export function scale(size: Size, ratio: number, opt_size?: Size | undefined): Size;
|
|
/**
|
|
* Returns an `Size` array for the passed in number (meaning: square) or
|
|
* `Size` array.
|
|
* (meaning: non-square),
|
|
* @param {number|Size} size Width and height.
|
|
* @param {Size} [opt_size] Optional reusable size array.
|
|
* @return {Size} Size.
|
|
* @api
|
|
*/
|
|
export function toSize(size: number | Size, opt_size?: Size | undefined): Size;
|
|
/**
|
|
* An array of numbers representing a size: `[width, height]`.
|
|
*/
|
|
export type Size = Array<number>;
|
|
//# sourceMappingURL=size.d.ts.map
|