mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
90 lines
3.0 KiB
TypeScript
90 lines
3.0 KiB
TypeScript
// Type definitions for D3JS d3-hsv module 0.1
|
||
// Project: https://github.com/d3/d3-hsv/, https://d3js.org/d3-hsv
|
||
// Definitions by: Yuri Feldman <https://github.com/arrayjam>, denisname <https://github.com/denisname>
|
||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||
|
||
// Last module patch version validated against: 0.1.0
|
||
|
||
import { Color, RGBColor, ColorSpaceObject, ColorCommonInstance } from 'd3-color';
|
||
|
||
export type ColorSpaceObjectWithHSV = ColorSpaceObject | HSVColor;
|
||
|
||
export interface HSVColorFactory extends Function {
|
||
/**
|
||
* Constructs a new HSV color.
|
||
* @param h The hue of the returned color.
|
||
* @param s The saturation of the returned color.
|
||
* @param v The value of the returned color.
|
||
* @param opacity The opacity of the returned color.
|
||
*/
|
||
(h: number, s: number, v: number, opacity?: number): HSVColor;
|
||
/**
|
||
* Constructs a new HSV color.
|
||
* @param cssColorSpecifier A CSS Color Module Level 3 specifier string,
|
||
* it is parsed and then converted to the HSV color space.
|
||
*/
|
||
(cssColorSpecifier: string): HSVColor;
|
||
/**
|
||
* Constructs a new HSV color.
|
||
* @param color A color instance, it will be converted to the RGB color space
|
||
* using `color.rgb` and then converted to HSV.
|
||
*/
|
||
(color: HSVColor | ColorSpaceObject | ColorCommonInstance): HSVColor;
|
||
|
||
readonly prototype: HSVColor;
|
||
}
|
||
|
||
export interface HSVColor extends Color {
|
||
/**
|
||
* The color hue.
|
||
*/
|
||
h: number;
|
||
/**
|
||
* The color saturation.
|
||
*/
|
||
s: number;
|
||
/**
|
||
* The color value.
|
||
*/
|
||
v: number;
|
||
/**
|
||
* The color opacity.
|
||
*/
|
||
opacity: number;
|
||
|
||
/**
|
||
* Returns a brighter copy of this color.
|
||
* @param k Controls how much brighter the returned color should be (defaults to 1).
|
||
*/
|
||
brighter(k?: number): this;
|
||
|
||
/**
|
||
* Returns a darker copy of this color.
|
||
* @param k Controls how much darker the returned color should be (defaults to 1).
|
||
*/
|
||
darker(k?: number): this;
|
||
|
||
/**
|
||
* Returns the RGB equivalent of this color.
|
||
*/
|
||
rgb(): RGBColor;
|
||
}
|
||
|
||
export const hsv: HSVColorFactory;
|
||
|
||
/**
|
||
* Returns an HSV color space interpolator between the two colors a and b.
|
||
* If either color’s hue or chroma is NaN, the opposing color’s channel value is used.
|
||
* The shortest path between hues is used. The return value of the interpolator is an RGB string.
|
||
* @param a The starting color; it will be converted to HSV using `d3.hsv`.
|
||
* @param b The ending color; it will be converted to HSV using `d3.hsv`.
|
||
*/
|
||
export function interpolateHsv(a: string | ColorCommonInstance, b: string | ColorCommonInstance): (t: number) => string;
|
||
|
||
/**
|
||
* Like `interpolateHsv`, but does not use the shortest path between hues.
|
||
* @param a The starting color; it will be converted to HSV using `d3.hsv`.
|
||
* @param b The ending color; it will be converted to HSV using `d3.hsv`.
|
||
*/
|
||
export function interpolateHsvLong(a: string | ColorCommonInstance, b: string | ColorCommonInstance): (t: number) => string;
|