pencil.js
Version:
Nice modular interactive 2D drawing library.
52 lines (51 loc) • 1.44 kB
TypeScript
/**
* ProgressPie class
* <br><img src="./media/examples/progress-pie.png" alt="progress-pie demo"/>
* @class
* @extends {module:Input}
*/
export default class ProgressPie {
/**
* @typedef {Object} ProgressPieOptions
* @extends InputOptions
* @prop {Number} [value=0] - Initial value
* @prop {Number} [radius=100] - Size of the progress-pie
* @prop {Number} [speed=0.3] - Transition speed between two value (0 mean no change, 1 mean instant change)
*/
/**
* @type {ProgressPieOptions}
*/
static get defaultOptions(): any;
/**
* ProgressPie constructor
* @param {PositionDefinition} positionDefinition - Position of the progress-pie center
* @param {ProgressPieOptions} [options] - Specific options
*/
constructor(positionDefinition: PositionDefinition, options?: any);
progress: Pie;
/**
* @inheritDoc
*/
click(): void;
/**
* Change this size
* @param {Number} newRadius - A new size in pixels
*/
set radius(newRadius: number);
/**
* Return this size
* @return {Number}
*/
get radius(): number;
/**
* Change this current value
* @param {Number} newValue - A new value to be set (between 0 and 1)
*/
set value(newValue: number);
/**
* Returns this current value
* @return {Number}
*/
get value(): number;
}
import Pie from "@pencil.js/pie";