crlf -> lf docs
This commit is contained in:
Родитель
da5b9dfbe3
Коммит
88c6e3e3d1
|
@ -1,21 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [(constructor)](./color.color._constructor_.md)
|
||||
|
||||
## Color.(constructor)
|
||||
|
||||
Constructs a new instance of the `Color` class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constructor(css: string, alpha?: number);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [(constructor)](./color.color._constructor_.md)
|
||||
|
||||
## Color.(constructor)
|
||||
|
||||
Constructs a new instance of the `Color` class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
constructor(css: string, alpha?: number);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [css](./color.color.css.md)
|
||||
|
||||
## Color.css() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
css(alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [css](./color.color.css.md)
|
||||
|
||||
## Color.css() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
css(alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hex](./color.color.hex.md)
|
||||
|
||||
## Color.hex() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hex(alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hex](./color.color.hex.md)
|
||||
|
||||
## Color.hex() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hex(alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hsl](./color.color.hsl.md)
|
||||
|
||||
## Color.hsl() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hsl(): Hsl;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsl](./color.hsl.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hsl](./color.color.hsl.md)
|
||||
|
||||
## Color.hsl() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hsl(): Hsl;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsl](./color.hsl.md)
|
||||
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hsluv](./color.color.hsluv.md)
|
||||
|
||||
## Color.hsluv() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hsluv(): HslVector;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [hsluv](./color.color.hsluv.md)
|
||||
|
||||
## Color.hsluv() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hsluv(): HslVector;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
|
|
|
@ -1,41 +1,41 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md)
|
||||
|
||||
## Color class
|
||||
|
||||
This class represents an instance of a color. You create it by passing in a standard CSS-compatible string and an optional alpha value. Note that some CSS color formats can include alpha, we do this because SVG colors allow separate specification of color and alpha.
|
||||
|
||||
This class also contains various accessors that transform the color output as noted. Note that the naming of these intentionally matches the string values on the ColorSpace enum.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class Color
|
||||
```
|
||||
|
||||
## Constructors
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [(constructor)(css, alpha)](./color.color._constructor_.md) | | Constructs a new instance of the <code>Color</code> class |
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [raw](./color.color.raw.md) | <code>readonly</code> | string | Direct passthrough of string used to create the color, to avoid any transform. |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [css(alpha)](./color.color.css.md) | | |
|
||||
| [hex(alpha)](./color.color.hex.md) | | |
|
||||
| [hsl()](./color.color.hsl.md) | | |
|
||||
| [hsluv()](./color.color.hsluv.md) | | |
|
||||
| [rgba(alpha)](./color.color.rgba.md) | | |
|
||||
| [rgbaint(alpha)](./color.color.rgbaint.md) | | |
|
||||
| [rgbav(alpha)](./color.color.rgbav.md) | | |
|
||||
| [toString()](./color.color.tostring.md) | | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md)
|
||||
|
||||
## Color class
|
||||
|
||||
This class represents an instance of a color. You create it by passing in a standard CSS-compatible string and an optional alpha value. Note that some CSS color formats can include alpha, we do this because SVG colors allow separate specification of color and alpha.
|
||||
|
||||
This class also contains various accessors that transform the color output as noted. Note that the naming of these intentionally matches the string values on the ColorSpace enum.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class Color
|
||||
```
|
||||
|
||||
## Constructors
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [(constructor)(css, alpha)](./color.color._constructor_.md) | | Constructs a new instance of the <code>Color</code> class |
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [raw](./color.color.raw.md) | <code>readonly</code> | string | Direct passthrough of string used to create the color, to avoid any transform. |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [css(alpha)](./color.color.css.md) | | |
|
||||
| [hex(alpha)](./color.color.hex.md) | | |
|
||||
| [hsl()](./color.color.hsl.md) | | |
|
||||
| [hsluv()](./color.color.hsluv.md) | | |
|
||||
| [rgba(alpha)](./color.color.rgba.md) | | |
|
||||
| [rgbaint(alpha)](./color.color.rgbaint.md) | | |
|
||||
| [rgbav(alpha)](./color.color.rgbav.md) | | |
|
||||
| [toString()](./color.color.tostring.md) | | |
|
||||
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [raw](./color.color.raw.md)
|
||||
|
||||
## Color.raw property
|
||||
|
||||
Direct passthrough of string used to create the color, to avoid any transform.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get raw(): string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [raw](./color.color.raw.md)
|
||||
|
||||
## Color.raw property
|
||||
|
||||
Direct passthrough of string used to create the color, to avoid any transform.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get raw(): string;
|
||||
```
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgba](./color.color.rgba.md)
|
||||
|
||||
## Color.rgba() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgba(alpha?: number): Rgba;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgba](./color.rgba.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgba](./color.color.rgba.md)
|
||||
|
||||
## Color.rgba() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgba(alpha?: number): Rgba;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgba](./color.rgba.md)
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgbaint](./color.color.rgbaint.md)
|
||||
|
||||
## Color.rgbaint() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgbaint(alpha?: number): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgbaint](./color.color.rgbaint.md)
|
||||
|
||||
## Color.rgbaint() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgbaint(alpha?: number): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgbav](./color.color.rgbav.md)
|
||||
|
||||
## Color.rgbav() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgbav(alpha?: number): RGBAV;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[RGBAV](./color.rgbav.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [rgbav](./color.color.rgbav.md)
|
||||
|
||||
## Color.rgbav() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rgbav(alpha?: number): RGBAV;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[RGBAV](./color.rgbav.md)
|
||||
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [toString](./color.color.tostring.md)
|
||||
|
||||
## Color.toString() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
toString(): string;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Color](./color.color.md) > [toString](./color.color.tostring.md)
|
||||
|
||||
## Color.toString() method
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
toString(): string;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [colorBlindness](./color.colorblindness.md)
|
||||
|
||||
## colorBlindness() function
|
||||
|
||||
Returns a copy of a Thematic Scheme with color blindness simulation applied.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function colorBlindness(scheme: Scheme, mode?: ColorBlindnessMode): Scheme;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| scheme | [Scheme](./color.scheme.md) | the color scheme |
|
||||
| mode | [ColorBlindnessMode](./color.colorblindnessmode.md) | <i>(Optional)</i> the colorblindness mode |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Scheme](./color.scheme.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [colorBlindness](./color.colorblindness.md)
|
||||
|
||||
## colorBlindness() function
|
||||
|
||||
Returns a copy of a Thematic Scheme with color blindness simulation applied.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function colorBlindness(scheme: Scheme, mode?: ColorBlindnessMode): Scheme;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| scheme | [Scheme](./color.scheme.md) | the color scheme |
|
||||
| mode | [ColorBlindnessMode](./color.colorblindnessmode.md) | <i>(Optional)</i> the colorblindness mode |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Scheme](./color.scheme.md)
|
||||
|
||||
|
|
|
@ -1,24 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [colorBlindnessInfo](./color.colorblindnessinfo.md)
|
||||
|
||||
## colorBlindnessInfo() function
|
||||
|
||||
Returns the indicence rates and description of a given colorblindess mode.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function colorBlindnessInfo(mode: ColorBlindnessMode): ColorBlindnessMeta;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| mode | [ColorBlindnessMode](./color.colorblindnessmode.md) | the colorblindness mode |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[ColorBlindnessMeta](./color.colorblindnessmeta.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [colorBlindnessInfo](./color.colorblindnessinfo.md)
|
||||
|
||||
## colorBlindnessInfo() function
|
||||
|
||||
Returns the indicence rates and description of a given colorblindess mode.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function colorBlindnessInfo(mode: ColorBlindnessMode): ColorBlindnessMeta;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| mode | [ColorBlindnessMode](./color.colorblindnessmode.md) | the colorblindness mode |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[ColorBlindnessMeta](./color.colorblindnessmeta.md)
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md) > [description](./color.colorblindnessmeta.description.md)
|
||||
|
||||
## ColorBlindnessMeta.description property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
description: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md) > [description](./color.colorblindnessmeta.description.md)
|
||||
|
||||
## ColorBlindnessMeta.description property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
description: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md) > [incidence](./color.colorblindnessmeta.incidence.md)
|
||||
|
||||
## ColorBlindnessMeta.incidence property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
incidence: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md) > [incidence](./color.colorblindnessmeta.incidence.md)
|
||||
|
||||
## ColorBlindnessMeta.incidence property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
incidence: number;
|
||||
```
|
||||
|
|
|
@ -1,21 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md)
|
||||
|
||||
## ColorBlindnessMeta interface
|
||||
|
||||
Interface for meta container about color blindness. Note that incidence is the reported number for males, as female color blindness is very rare in comparison (overall 1 in 12 males, 1 in 200 females)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ColorBlindnessMeta
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [description](./color.colorblindnessmeta.description.md) | | string | |
|
||||
| [incidence](./color.colorblindnessmeta.incidence.md) | | number | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMeta](./color.colorblindnessmeta.md)
|
||||
|
||||
## ColorBlindnessMeta interface
|
||||
|
||||
Interface for meta container about color blindness. Note that incidence is the reported number for males, as female color blindness is very rare in comparison (overall 1 in 12 males, 1 in 200 females)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ColorBlindnessMeta
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [description](./color.colorblindnessmeta.description.md) | | string | |
|
||||
| [incidence](./color.colorblindnessmeta.incidence.md) | | number | |
|
||||
|
||||
|
|
|
@ -1,27 +1,27 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMode](./color.colorblindnessmode.md)
|
||||
|
||||
## ColorBlindnessMode enum
|
||||
|
||||
This is an enumeration of the major known forms of color blindness. They are ordered by how common they are in males of Northern European descent (by far the most affected) According to https://en.wikipedia.org/wiki/Color\_blindness
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ColorBlindnessMode
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Achromatopsia | <code>"achromatopsia"</code> | No color vision at all, very rare |
|
||||
| Deuteranomaly | <code>"deuteranomaly"</code> | Red/green, 6%, 0.4% females |
|
||||
| Deuteranopia | <code>"deuteranopia"</code> | Red/green, 1% males |
|
||||
| None | <code>"none"</code> | No colorblindness, \~92% |
|
||||
| Protanomaly | <code>"protanomaly"</code> | Red/green, 1% males, .01% females |
|
||||
| Protanopia | <code>"protanopia"</code> | Red/green, 1% females |
|
||||
| Tritanomaly | <code>"tritanomaly"</code> | Blue/yellow, .01% males and females |
|
||||
| Tritanopia | <code>"tritanopia"</code> | Blue/yellow, < 1% males and females |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorBlindnessMode](./color.colorblindnessmode.md)
|
||||
|
||||
## ColorBlindnessMode enum
|
||||
|
||||
This is an enumeration of the major known forms of color blindness. They are ordered by how common they are in males of Northern European descent (by far the most affected) According to https://en.wikipedia.org/wiki/Color\_blindness
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ColorBlindnessMode
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| Achromatopsia | <code>"achromatopsia"</code> | No color vision at all, very rare |
|
||||
| Deuteranomaly | <code>"deuteranomaly"</code> | Red/green, 6%, 0.4% females |
|
||||
| Deuteranopia | <code>"deuteranopia"</code> | Red/green, 1% males |
|
||||
| None | <code>"none"</code> | No colorblindness, \~92% |
|
||||
| Protanomaly | <code>"protanomaly"</code> | Red/green, 1% males, .01% females |
|
||||
| Protanopia | <code>"protanopia"</code> | Red/green, 1% females |
|
||||
| Tritanomaly | <code>"tritanomaly"</code> | Blue/yellow, .01% males and females |
|
||||
| Tritanopia | <code>"tritanopia"</code> | Blue/yellow, < 1% males and females |
|
||||
|
||||
|
|
|
@ -1,27 +1,27 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorSpace](./color.colorspace.md)
|
||||
|
||||
## ColorSpace enum
|
||||
|
||||
Various options for color transforms and representations
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ColorSpace
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| CSS | <code>"css"</code> | Encode the color using any CSS-compatible color string. The default due to its wide applicability, and the format colors use in theme JSON. https://www.w3.org/TR/css-color-3/\#colorunits |
|
||||
| HEX | <code>"hex"</code> | Encode as a standard hexadecimal color. |
|
||||
| HSL | <code>"hsl"</code> | HSL color space, { h, s, l }<!-- -->. |
|
||||
| HSLUV | <code>"hsluv"</code> | HSLuv, which is a perceptually balanced space. \[h, s, l\]. https://www.hsluv.org/ |
|
||||
| RGB | <code>"rgb"</code> | Encode as an object with r, g, b properies, scaled 0-255 each. |
|
||||
| RGBA | <code>"rgba"</code> | Encode as an object with r, g, b properies, scaled 0-255 each, along with an alpha prop scaled 0-1 |
|
||||
| RGBA\_NUMBER | <code>"rgbaint"</code> | This is raw JavaScript number representing the RGBA color. It is calculated by bitshifting R, G, B, and A values into a 32-bit space. (i.e., r, g <<!-- -->< 8, b <<!-- -->< 16, a <<!-- -->< 24) |
|
||||
| RGBA\_VECTOR | <code>"rgbav"</code> | Encode the color using a vector of floats R, G, B, and A. Range of each is 0 to 1. Color "none" will be represented as an empty array. https://developer.mozilla.org/en-US/docs/Web/API/WebGL\_API/Tutorial/Using\_shaders\_to\_apply\_color\_in\_WebGL |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [ColorSpace](./color.colorspace.md)
|
||||
|
||||
## ColorSpace enum
|
||||
|
||||
Various options for color transforms and representations
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare enum ColorSpace
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| CSS | <code>"css"</code> | Encode the color using any CSS-compatible color string. The default due to its wide applicability, and the format colors use in theme JSON. https://www.w3.org/TR/css-color-3/\#colorunits |
|
||||
| HEX | <code>"hex"</code> | Encode as a standard hexadecimal color. |
|
||||
| HSL | <code>"hsl"</code> | HSL color space, { h, s, l }<!-- -->. |
|
||||
| HSLUV | <code>"hsluv"</code> | HSLuv, which is a perceptually balanced space. \[h, s, l\]. https://www.hsluv.org/ |
|
||||
| RGB | <code>"rgb"</code> | Encode as an object with r, g, b properies, scaled 0-255 each. |
|
||||
| RGBA | <code>"rgba"</code> | Encode as an object with r, g, b properies, scaled 0-255 each, along with an alpha prop scaled 0-1 |
|
||||
| RGBA\_NUMBER | <code>"rgbaint"</code> | This is raw JavaScript number representing the RGBA color. It is calculated by bitshifting R, G, B, and A values into a 32-bit space. (i.e., r, g <<!-- -->< 8, b <<!-- -->< 16, a <<!-- -->< 24) |
|
||||
| RGBA\_VECTOR | <code>"rgbav"</code> | Encode the color using a vector of floats R, G, B, and A. Range of each is 0 to 1. Color "none" will be represented as an empty array. https://developer.mozilla.org/en-US/docs/Web/API/WebGL\_API/Tutorial/Using\_shaders\_to\_apply\_color\_in\_WebGL |
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [contrast](./color.contrast.md)
|
||||
|
||||
## contrast() function
|
||||
|
||||
Compute the contrast between a foreground and background color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function contrast(foreground: string, background: string): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| foreground | string | the foreground CSS string |
|
||||
| background | string | the background CSS string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [contrast](./color.contrast.md)
|
||||
|
||||
## contrast() function
|
||||
|
||||
Compute the contrast between a foreground and background color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function contrast(foreground: string, background: string): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| foreground | string | the foreground CSS string |
|
||||
| background | string | the background CSS string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2css](./color.css2css.md)
|
||||
|
||||
## css2css() function
|
||||
|
||||
Seems redundant...but we spec opacity separate, so this ensures SVG fill or stroke opacity can be folded in as the alpha channel.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2css(css: string, alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2css](./color.css2css.md)
|
||||
|
||||
## css2css() function
|
||||
|
||||
Seems redundant...but we spec opacity separate, so this ensures SVG fill or stroke opacity can be folded in as the alpha channel.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2css(css: string, alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hex](./color.css2hex.md)
|
||||
|
||||
## css2hex() function
|
||||
|
||||
Returns a standard hex color code. Note that we handle 'none' as 'none' here because it is used frequently to indicate empty fills and strokes in svg, even though it is not a valid hex code. Note: if you are using this for a css color, use css2css as it will return valid 'transparent' for our empty 'none'. Also note that if alpha is passed, chroma-js will create an 8-letter hex string.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hex(css: string, alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hex](./color.css2hex.md)
|
||||
|
||||
## css2hex() function
|
||||
|
||||
Returns a standard hex color code. Note that we handle 'none' as 'none' here because it is used frequently to indicate empty fills and strokes in svg, even though it is not a valid hex code. Note: if you are using this for a css color, use css2css as it will return valid 'transparent' for our empty 'none'. Also note that if alpha is passed, chroma-js will create an 8-letter hex string.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hex(css: string, alpha?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsl](./color.css2hsl.md)
|
||||
|
||||
## css2hsl() function
|
||||
|
||||
Convert a standard CSS color to an { h, s, l } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsl(css: string, _alpha?: number): Hsl;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsl](./color.hsl.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsl](./color.css2hsl.md)
|
||||
|
||||
## css2hsl() function
|
||||
|
||||
Convert a standard CSS color to an { h, s, l } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsl(css: string, _alpha?: number): Hsl;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsl](./color.hsl.md)
|
||||
|
||||
|
|
|
@ -1,24 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsluv](./color.css2hsluv.md)
|
||||
|
||||
## css2hsluv() function
|
||||
|
||||
Convert a standard CSS-compatible string to \[h, s, l\] array
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsluv(css: string): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsluv](./color.css2hsluv.md)
|
||||
|
||||
## css2hsluv() function
|
||||
|
||||
Convert a standard CSS-compatible string to \[h, s, l\] array
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsluv(css: string): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsv](./color.css2hsv.md)
|
||||
|
||||
## css2hsv() function
|
||||
|
||||
Convert a standard CSS color to an { h, s, v } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsv(css: string, _alpha?: number): Hsv;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsv](./color.hsv.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2hsv](./color.css2hsv.md)
|
||||
|
||||
## css2hsv() function
|
||||
|
||||
Convert a standard CSS color to an { h, s, v } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2hsv(css: string, _alpha?: number): Hsv;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Hsv](./color.hsv.md)
|
||||
|
||||
|
|
|
@ -1,24 +1,24 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2lch](./color.css2lch.md)
|
||||
|
||||
## css2lch() function
|
||||
|
||||
Convert a standard CSS-compatible string to \[l, c, h\] array
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2lch(css: string): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2lch](./color.css2lch.md)
|
||||
|
||||
## css2lch() function
|
||||
|
||||
Convert a standard CSS-compatible string to \[l, c, h\] array
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2lch(css: string): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgb](./color.css2rgb.md)
|
||||
|
||||
## css2rgb() function
|
||||
|
||||
Converts a standard CSS color to an {<!-- -->r, g, b<!-- -->} object
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgb(css: string, _alpha?: number): Rgb;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgb](./color.rgb.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgb](./color.css2rgb.md)
|
||||
|
||||
## css2rgb() function
|
||||
|
||||
Converts a standard CSS color to an {<!-- -->r, g, b<!-- -->} object
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgb(css: string, _alpha?: number): Rgb;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| \_alpha | number | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgb](./color.rgb.md)
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgba](./color.css2rgba.md)
|
||||
|
||||
## css2rgba() function
|
||||
|
||||
Converts a standard CSS color to an { r, g, b, a } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgba(css: string, alpha?: number): Rgba;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpa value to use |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgba](./color.rgba.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgba](./color.css2rgba.md)
|
||||
|
||||
## css2rgba() function
|
||||
|
||||
Converts a standard CSS color to an { r, g, b, a } object.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgba(css: string, alpha?: number): Rgba;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpa value to use |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Rgba](./color.rgba.md)
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgbaint](./color.css2rgbaint.md)
|
||||
|
||||
## css2rgbaint() function
|
||||
|
||||
Convert a standard CSS string to an integer number. This is commonly used in GL code.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgbaint(css: string, alpha?: number): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgbaint](./color.css2rgbaint.md)
|
||||
|
||||
## css2rgbaint() function
|
||||
|
||||
Convert a standard CSS string to an integer number. This is commonly used in GL code.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgbaint(css: string, alpha?: number): number;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> the alpha value to use \[0-1\] |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
number
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgbav](./color.css2rgbav.md)
|
||||
|
||||
## css2rgbav() function
|
||||
|
||||
Convert a standard CSS string to vector of \[r, g, b, a\] values scaled from 0-1. This is typically used in WebGl.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgbav(css: string, alpha?: number): [number, number, number, number];
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> optional alpha override from 0-1. Not all CSS strings include alpha, so you can provide it if needed. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
\[number, number, number, number\]
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [css2rgbav](./color.css2rgbav.md)
|
||||
|
||||
## css2rgbav() function
|
||||
|
||||
Convert a standard CSS string to vector of \[r, g, b, a\] values scaled from 0-1. This is typically used in WebGl.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function css2rgbav(css: string, alpha?: number): [number, number, number, number];
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| alpha | number | <i>(Optional)</i> optional alpha override from 0-1. Not all CSS strings include alpha, so you can provide it if needed. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
\[number, number, number, number\]
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [darken](./color.darken.md)
|
||||
|
||||
## darken() function
|
||||
|
||||
Darken a standard CSS color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function darken(css: string, value?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| value | number | <i>(Optional)</i> the value to darken by |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [darken](./color.darken.md)
|
||||
|
||||
## darken() function
|
||||
|
||||
Darken a standard CSS color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function darken(css: string, value?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| value | number | <i>(Optional)</i> the value to darken by |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,21 +1,21 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [defaultParams](./color.defaultparams.md)
|
||||
|
||||
## defaultParams variable
|
||||
|
||||
Default set of params useful for initializing new themes with our "standard look".
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
defaultParams: {
|
||||
accentHue: number;
|
||||
accentSaturation: number;
|
||||
accentLightness: number;
|
||||
scaleSaturation: number;
|
||||
scaleLightness: number;
|
||||
greyHue: number;
|
||||
greySaturation: number;
|
||||
}
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [defaultParams](./color.defaultparams.md)
|
||||
|
||||
## defaultParams variable
|
||||
|
||||
Default set of params useful for initializing new themes with our "standard look".
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
defaultParams: {
|
||||
accentHue: number;
|
||||
accentSaturation: number;
|
||||
accentLightness: number;
|
||||
scaleSaturation: number;
|
||||
scaleLightness: number;
|
||||
greyHue: number;
|
||||
greySaturation: number;
|
||||
}
|
||||
```
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [getNamedSchemeColor](./color.getnamedschemecolor.md)
|
||||
|
||||
## getNamedSchemeColor() function
|
||||
|
||||
Extracts a thematic Color using its scheme "path".
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getNamedSchemeColor(scheme: Scheme, path?: string): Color;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| scheme | [Scheme](./color.scheme.md) | the color scheme |
|
||||
| path | string | <i>(Optional)</i> the scheme path |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Color](./color.color.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [getNamedSchemeColor](./color.getnamedschemecolor.md)
|
||||
|
||||
## getNamedSchemeColor() function
|
||||
|
||||
Extracts a thematic Color using its scheme "path".
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getNamedSchemeColor(scheme: Scheme, path?: string): Color;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| scheme | [Scheme](./color.scheme.md) | the color scheme |
|
||||
| path | string | <i>(Optional)</i> the scheme path |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Color](./color.color.md)
|
||||
|
||||
|
|
|
@ -1,29 +1,29 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [getScheme](./color.getscheme.md)
|
||||
|
||||
## getScheme() function
|
||||
|
||||
Takes a set of core params and generates all of the scale computes required for a Schema, using HSLuv color space for even perceptual qualities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getScheme(params: SchemeParams, nominalItemCount: number, sequentialItemCount: number, light: boolean, tuning?: Partial<TuningParameters>): Scheme;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| params | [SchemeParams](./color.schemeparams.md) | |
|
||||
| nominalItemCount | number | |
|
||||
| sequentialItemCount | number | |
|
||||
| light | boolean | |
|
||||
| tuning | Partial<[TuningParameters](./color.tuningparameters.md)<!-- -->> | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Scheme](./color.scheme.md)
|
||||
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [getScheme](./color.getscheme.md)
|
||||
|
||||
## getScheme() function
|
||||
|
||||
Takes a set of core params and generates all of the scale computes required for a Schema, using HSLuv color space for even perceptual qualities.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getScheme(params: SchemeParams, nominalItemCount: number, sequentialItemCount: number, light: boolean, tuning?: Partial<TuningParameters>): Scheme;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| params | [SchemeParams](./color.schemeparams.md) | |
|
||||
| nominalItemCount | number | |
|
||||
| sequentialItemCount | number | |
|
||||
| light | boolean | |
|
||||
| tuning | Partial<[TuningParameters](./color.tuningparameters.md)<!-- -->> | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Scheme](./color.scheme.md)
|
||||
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [h](./color.hsl.h.md)
|
||||
|
||||
## Hsl.h property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
h: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [h](./color.hsl.h.md)
|
||||
|
||||
## Hsl.h property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
h: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [l](./color.hsl.l.md)
|
||||
|
||||
## Hsl.l property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
l: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [l](./color.hsl.l.md)
|
||||
|
||||
## Hsl.l property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
l: number;
|
||||
```
|
||||
|
|
|
@ -1,20 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md)
|
||||
|
||||
## Hsl interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Hsl
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [h](./color.hsl.h.md) | | number | |
|
||||
| [l](./color.hsl.l.md) | | number | |
|
||||
| [s](./color.hsl.s.md) | | number | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md)
|
||||
|
||||
## Hsl interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Hsl
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [h](./color.hsl.h.md) | | number | |
|
||||
| [l](./color.hsl.l.md) | | number | |
|
||||
| [s](./color.hsl.s.md) | | number | |
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [s](./color.hsl.s.md)
|
||||
|
||||
## Hsl.s property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
s: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsl](./color.hsl.md) > [s](./color.hsl.s.md)
|
||||
|
||||
## Hsl.s property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
s: number;
|
||||
```
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [hsluv2hex](./color.hsluv2hex.md)
|
||||
|
||||
## hsluv2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function hsluv2hex(hsluv: HslVector): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| hsluv | [HslVector](./color.hslvector.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [hsluv2hex](./color.hsluv2hex.md)
|
||||
|
||||
## hsluv2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function hsluv2hex(hsluv: HslVector): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| hsluv | [HslVector](./color.hslvector.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [hsluv2hsl](./color.hsluv2hsl.md)
|
||||
|
||||
## hsluv2hsl() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function hsluv2hsl(hsluv: HslVector): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| hsluv | [HslVector](./color.hslvector.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [hsluv2hsl](./color.hsluv2hsl.md)
|
||||
|
||||
## hsluv2hsl() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function hsluv2hsl(hsluv: HslVector): HslVector;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| hsluv | [HslVector](./color.hslvector.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[HslVector](./color.hslvector.md)
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [HslVector](./color.hslvector.md)
|
||||
|
||||
## HslVector type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type HslVector = [number, number, number];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [HslVector](./color.hslvector.md)
|
||||
|
||||
## HslVector type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type HslVector = [number, number, number];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [h](./color.hsv.h.md)
|
||||
|
||||
## Hsv.h property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
h: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [h](./color.hsv.h.md)
|
||||
|
||||
## Hsv.h property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
h: number;
|
||||
```
|
||||
|
|
|
@ -1,20 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md)
|
||||
|
||||
## Hsv interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Hsv
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [h](./color.hsv.h.md) | | number | |
|
||||
| [s](./color.hsv.s.md) | | number | |
|
||||
| [v](./color.hsv.v.md) | | number | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md)
|
||||
|
||||
## Hsv interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Hsv
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [h](./color.hsv.h.md) | | number | |
|
||||
| [s](./color.hsv.s.md) | | number | |
|
||||
| [v](./color.hsv.v.md) | | number | |
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [s](./color.hsv.s.md)
|
||||
|
||||
## Hsv.s property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
s: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [s](./color.hsv.s.md)
|
||||
|
||||
## Hsv.s property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
s: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [v](./color.hsv.v.md)
|
||||
|
||||
## Hsv.v property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
v: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Hsv](./color.hsv.md) > [v](./color.hsv.v.md)
|
||||
|
||||
## Hsv.v property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
v: number;
|
||||
```
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [isNominal](./color.isnominal.md)
|
||||
|
||||
## isNominal() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function isNominal(name?: string): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | string | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [isNominal](./color.isnominal.md)
|
||||
|
||||
## isNominal() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function isNominal(name?: string): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| name | string | <i>(Optional)</i> |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
||||
|
|
|
@ -1,26 +1,26 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [lch2hex](./color.lch2hex.md)
|
||||
|
||||
## lch2hex() function
|
||||
|
||||
Convert a set of l, c, and h values to a standard CSS-comptible hex string
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function lch2hex(l: number, c: number, h: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| l | number | the lightness value |
|
||||
| c | number | the chroma value |
|
||||
| h | number | the hue value |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [lch2hex](./color.lch2hex.md)
|
||||
|
||||
## lch2hex() function
|
||||
|
||||
Convert a set of l, c, and h values to a standard CSS-comptible hex string
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function lch2hex(l: number, c: number, h: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| l | number | the lightness value |
|
||||
| c | number | the chroma value |
|
||||
| h | number | the hue value |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,25 +1,25 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [lighten](./color.lighten.md)
|
||||
|
||||
## lighten() function
|
||||
|
||||
Lighten a standard CSS color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function lighten(css: string, value?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| value | number | <i>(Optional)</i> the value to brighten by |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [lighten](./color.lighten.md)
|
||||
|
||||
## lighten() function
|
||||
|
||||
Lighten a standard CSS color
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function lighten(css: string, value?: number): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| css | string | the css color hex string |
|
||||
| value | number | <i>(Optional)</i> the value to brighten by |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,74 +1,74 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md)
|
||||
|
||||
## color package
|
||||
|
||||
## Classes
|
||||
|
||||
| Class | Description |
|
||||
| --- | --- |
|
||||
| [Color](./color.color.md) | <p>This class represents an instance of a color. You create it by passing in a standard CSS-compatible string and an optional alpha value. Note that some CSS color formats can include alpha, we do this because SVG colors allow separate specification of color and alpha.</p><p>This class also contains various accessors that transform the color output as noted. Note that the naming of these intentionally matches the string values on the ColorSpace enum.</p> |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [ColorBlindnessMode](./color.colorblindnessmode.md) | This is an enumeration of the major known forms of color blindness. They are ordered by how common they are in males of Northern European descent (by far the most affected) According to https://en.wikipedia.org/wiki/Color\_blindness |
|
||||
| [ColorSpace](./color.colorspace.md) | Various options for color transforms and representations |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [colorBlindness(scheme, mode)](./color.colorblindness.md) | Returns a copy of a Thematic Scheme with color blindness simulation applied. |
|
||||
| [colorBlindnessInfo(mode)](./color.colorblindnessinfo.md) | Returns the indicence rates and description of a given colorblindess mode. |
|
||||
| [contrast(foreground, background)](./color.contrast.md) | Compute the contrast between a foreground and background color |
|
||||
| [css2css(css, alpha)](./color.css2css.md) | Seems redundant...but we spec opacity separate, so this ensures SVG fill or stroke opacity can be folded in as the alpha channel. |
|
||||
| [css2hex(css, alpha)](./color.css2hex.md) | Returns a standard hex color code. Note that we handle 'none' as 'none' here because it is used frequently to indicate empty fills and strokes in svg, even though it is not a valid hex code. Note: if you are using this for a css color, use css2css as it will return valid 'transparent' for our empty 'none'. Also note that if alpha is passed, chroma-js will create an 8-letter hex string. |
|
||||
| [css2hsl(css, \_alpha)](./color.css2hsl.md) | Convert a standard CSS color to an { h, s, l } object. |
|
||||
| [css2hsluv(css)](./color.css2hsluv.md) | Convert a standard CSS-compatible string to \[h, s, l\] array |
|
||||
| [css2hsv(css, \_alpha)](./color.css2hsv.md) | Convert a standard CSS color to an { h, s, v } object. |
|
||||
| [css2lch(css)](./color.css2lch.md) | Convert a standard CSS-compatible string to \[l, c, h\] array |
|
||||
| [css2rgb(css, \_alpha)](./color.css2rgb.md) | Converts a standard CSS color to an {<!-- -->r, g, b<!-- -->} object |
|
||||
| [css2rgba(css, alpha)](./color.css2rgba.md) | Converts a standard CSS color to an { r, g, b, a } object. |
|
||||
| [css2rgbaint(css, alpha)](./color.css2rgbaint.md) | Convert a standard CSS string to an integer number. This is commonly used in GL code. |
|
||||
| [css2rgbav(css, alpha)](./color.css2rgbav.md) | Convert a standard CSS string to vector of \[r, g, b, a\] values scaled from 0-1. This is typically used in WebGl. |
|
||||
| [darken(css, value)](./color.darken.md) | Darken a standard CSS color |
|
||||
| [getNamedSchemeColor(scheme, path)](./color.getnamedschemecolor.md) | Extracts a thematic Color using its scheme "path". |
|
||||
| [getScheme(params, nominalItemCount, sequentialItemCount, light, tuning)](./color.getscheme.md) | Takes a set of core params and generates all of the scale computes required for a Schema, using HSLuv color space for even perceptual qualities. |
|
||||
| [hsluv2hex(hsluv)](./color.hsluv2hex.md) | |
|
||||
| [hsluv2hsl(hsluv)](./color.hsluv2hsl.md) | |
|
||||
| [isNominal(name)](./color.isnominal.md) | |
|
||||
| [lch2hex(l, c, h)](./color.lch2hex.md) | Convert a set of l, c, and h values to a standard CSS-comptible hex string |
|
||||
| [lighten(css, value)](./color.lighten.md) | Lighten a standard CSS color |
|
||||
| [nearest(input, list)](./color.nearest.md) | <p>Finds the closest match from one color within a list.</p><p>This just uses the Hue component from the HSLuv variant. The idea is that we just want the visually closest color.</p><p>If you need something like Euclidean distance use chrome-js.distance directly.</p> |
|
||||
| [rgba2hex(rgba)](./color.rgba2hex.md) | |
|
||||
| [rgbav2hex(rgbav)](./color.rgbav2hex.md) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [ColorBlindnessMeta](./color.colorblindnessmeta.md) | Interface for meta container about color blindness. Note that incidence is the reported number for males, as female color blindness is very rare in comparison (overall 1 in 12 males, 1 in 200 females) |
|
||||
| [Hsl](./color.hsl.md) | |
|
||||
| [Hsv](./color.hsv.md) | |
|
||||
| [Rgb](./color.rgb.md) | |
|
||||
| [Rgba](./color.rgba.md) | |
|
||||
| [Scheme](./color.scheme.md) | Core color properties for a computed color scheme. Note the values are all strings - our color default representation uses hex codes. |
|
||||
| [SchemeParams](./color.schemeparams.md) | This is the core set of parameters for generating schemes using the ColorPicker |
|
||||
| [TuningParameters](./color.tuningparameters.md) | Detailed tuning for the scale generation algorithms. |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [defaultParams](./color.defaultparams.md) | Default set of params useful for initializing new themes with our "standard look". |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [HslVector](./color.hslvector.md) | |
|
||||
| [RGBAV](./color.rgbav.md) | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md)
|
||||
|
||||
## color package
|
||||
|
||||
## Classes
|
||||
|
||||
| Class | Description |
|
||||
| --- | --- |
|
||||
| [Color](./color.color.md) | <p>This class represents an instance of a color. You create it by passing in a standard CSS-compatible string and an optional alpha value. Note that some CSS color formats can include alpha, we do this because SVG colors allow separate specification of color and alpha.</p><p>This class also contains various accessors that transform the color output as noted. Note that the naming of these intentionally matches the string values on the ColorSpace enum.</p> |
|
||||
|
||||
## Enumerations
|
||||
|
||||
| Enumeration | Description |
|
||||
| --- | --- |
|
||||
| [ColorBlindnessMode](./color.colorblindnessmode.md) | This is an enumeration of the major known forms of color blindness. They are ordered by how common they are in males of Northern European descent (by far the most affected) According to https://en.wikipedia.org/wiki/Color\_blindness |
|
||||
| [ColorSpace](./color.colorspace.md) | Various options for color transforms and representations |
|
||||
|
||||
## Functions
|
||||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [colorBlindness(scheme, mode)](./color.colorblindness.md) | Returns a copy of a Thematic Scheme with color blindness simulation applied. |
|
||||
| [colorBlindnessInfo(mode)](./color.colorblindnessinfo.md) | Returns the indicence rates and description of a given colorblindess mode. |
|
||||
| [contrast(foreground, background)](./color.contrast.md) | Compute the contrast between a foreground and background color |
|
||||
| [css2css(css, alpha)](./color.css2css.md) | Seems redundant...but we spec opacity separate, so this ensures SVG fill or stroke opacity can be folded in as the alpha channel. |
|
||||
| [css2hex(css, alpha)](./color.css2hex.md) | Returns a standard hex color code. Note that we handle 'none' as 'none' here because it is used frequently to indicate empty fills and strokes in svg, even though it is not a valid hex code. Note: if you are using this for a css color, use css2css as it will return valid 'transparent' for our empty 'none'. Also note that if alpha is passed, chroma-js will create an 8-letter hex string. |
|
||||
| [css2hsl(css, \_alpha)](./color.css2hsl.md) | Convert a standard CSS color to an { h, s, l } object. |
|
||||
| [css2hsluv(css)](./color.css2hsluv.md) | Convert a standard CSS-compatible string to \[h, s, l\] array |
|
||||
| [css2hsv(css, \_alpha)](./color.css2hsv.md) | Convert a standard CSS color to an { h, s, v } object. |
|
||||
| [css2lch(css)](./color.css2lch.md) | Convert a standard CSS-compatible string to \[l, c, h\] array |
|
||||
| [css2rgb(css, \_alpha)](./color.css2rgb.md) | Converts a standard CSS color to an {<!-- -->r, g, b<!-- -->} object |
|
||||
| [css2rgba(css, alpha)](./color.css2rgba.md) | Converts a standard CSS color to an { r, g, b, a } object. |
|
||||
| [css2rgbaint(css, alpha)](./color.css2rgbaint.md) | Convert a standard CSS string to an integer number. This is commonly used in GL code. |
|
||||
| [css2rgbav(css, alpha)](./color.css2rgbav.md) | Convert a standard CSS string to vector of \[r, g, b, a\] values scaled from 0-1. This is typically used in WebGl. |
|
||||
| [darken(css, value)](./color.darken.md) | Darken a standard CSS color |
|
||||
| [getNamedSchemeColor(scheme, path)](./color.getnamedschemecolor.md) | Extracts a thematic Color using its scheme "path". |
|
||||
| [getScheme(params, nominalItemCount, sequentialItemCount, light, tuning)](./color.getscheme.md) | Takes a set of core params and generates all of the scale computes required for a Schema, using HSLuv color space for even perceptual qualities. |
|
||||
| [hsluv2hex(hsluv)](./color.hsluv2hex.md) | |
|
||||
| [hsluv2hsl(hsluv)](./color.hsluv2hsl.md) | |
|
||||
| [isNominal(name)](./color.isnominal.md) | |
|
||||
| [lch2hex(l, c, h)](./color.lch2hex.md) | Convert a set of l, c, and h values to a standard CSS-comptible hex string |
|
||||
| [lighten(css, value)](./color.lighten.md) | Lighten a standard CSS color |
|
||||
| [nearest(input, list)](./color.nearest.md) | <p>Finds the closest match from one color within a list.</p><p>This just uses the Hue component from the HSLuv variant. The idea is that we just want the visually closest color.</p><p>If you need something like Euclidean distance use chrome-js.distance directly.</p> |
|
||||
| [rgba2hex(rgba)](./color.rgba2hex.md) | |
|
||||
| [rgbav2hex(rgbav)](./color.rgbav2hex.md) | |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [ColorBlindnessMeta](./color.colorblindnessmeta.md) | Interface for meta container about color blindness. Note that incidence is the reported number for males, as female color blindness is very rare in comparison (overall 1 in 12 males, 1 in 200 females) |
|
||||
| [Hsl](./color.hsl.md) | |
|
||||
| [Hsv](./color.hsv.md) | |
|
||||
| [Rgb](./color.rgb.md) | |
|
||||
| [Rgba](./color.rgba.md) | |
|
||||
| [Scheme](./color.scheme.md) | Core color properties for a computed color scheme. Note the values are all strings - our color default representation uses hex codes. |
|
||||
| [SchemeParams](./color.schemeparams.md) | This is the core set of parameters for generating schemes using the ColorPicker |
|
||||
| [TuningParameters](./color.tuningparameters.md) | Detailed tuning for the scale generation algorithms. |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| [defaultParams](./color.defaultparams.md) | Default set of params useful for initializing new themes with our "standard look". |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [HslVector](./color.hslvector.md) | |
|
||||
| [RGBAV](./color.rgbav.md) | |
|
||||
|
||||
|
|
|
@ -1,29 +1,29 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [nearest](./color.nearest.md)
|
||||
|
||||
## nearest() function
|
||||
|
||||
Finds the closest match from one color within a list.
|
||||
|
||||
This just uses the Hue component from the HSLuv variant. The idea is that we just want the visually closest color.
|
||||
|
||||
If you need something like Euclidean distance use chrome-js.distance directly.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function nearest(input: Color, list: Color[]): Color;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| input | [Color](./color.color.md) | |
|
||||
| list | [Color](./color.color.md)<!-- -->\[\] | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Color](./color.color.md)
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [nearest](./color.nearest.md)
|
||||
|
||||
## nearest() function
|
||||
|
||||
Finds the closest match from one color within a list.
|
||||
|
||||
This just uses the Hue component from the HSLuv variant. The idea is that we just want the visually closest color.
|
||||
|
||||
If you need something like Euclidean distance use chrome-js.distance directly.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function nearest(input: Color, list: Color[]): Color;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| input | [Color](./color.color.md) | |
|
||||
| list | [Color](./color.color.md)<!-- -->\[\] | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[Color](./color.color.md)
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [b](./color.rgb.b.md)
|
||||
|
||||
## Rgb.b property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
b: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [b](./color.rgb.b.md)
|
||||
|
||||
## Rgb.b property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
b: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [g](./color.rgb.g.md)
|
||||
|
||||
## Rgb.g property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
g: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [g](./color.rgb.g.md)
|
||||
|
||||
## Rgb.g property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
g: number;
|
||||
```
|
||||
|
|
|
@ -1,20 +1,20 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md)
|
||||
|
||||
## Rgb interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Rgb
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [b](./color.rgb.b.md) | | number | |
|
||||
| [g](./color.rgb.g.md) | | number | |
|
||||
| [r](./color.rgb.r.md) | | number | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md)
|
||||
|
||||
## Rgb interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Rgb
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [b](./color.rgb.b.md) | | number | |
|
||||
| [g](./color.rgb.g.md) | | number | |
|
||||
| [r](./color.rgb.r.md) | | number | |
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [r](./color.rgb.r.md)
|
||||
|
||||
## Rgb.r property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
r: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgb](./color.rgb.md) > [r](./color.rgb.r.md)
|
||||
|
||||
## Rgb.r property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
r: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgba](./color.rgba.md) > [a](./color.rgba.a.md)
|
||||
|
||||
## Rgba.a property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
a?: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgba](./color.rgba.md) > [a](./color.rgba.a.md)
|
||||
|
||||
## Rgba.a property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
a?: number;
|
||||
```
|
||||
|
|
|
@ -1,19 +1,19 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgba](./color.rgba.md)
|
||||
|
||||
## Rgba interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Rgba extends Rgb
|
||||
```
|
||||
<b>Extends:</b> [Rgb](./color.rgb.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [a?](./color.rgba.a.md) | | number | <i>(Optional)</i> |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Rgba](./color.rgba.md)
|
||||
|
||||
## Rgba interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Rgba extends Rgb
|
||||
```
|
||||
<b>Extends:</b> [Rgb](./color.rgb.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [a?](./color.rgba.a.md) | | number | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [rgba2hex](./color.rgba2hex.md)
|
||||
|
||||
## rgba2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function rgba2hex(rgba: Rgba): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rgba | [Rgba](./color.rgba.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [rgba2hex](./color.rgba2hex.md)
|
||||
|
||||
## rgba2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function rgba2hex(rgba: Rgba): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rgba | [Rgba](./color.rgba.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [RGBAV](./color.rgbav.md)
|
||||
|
||||
## RGBAV type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type RGBAV = [number, number, number, number];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [RGBAV](./color.rgbav.md)
|
||||
|
||||
## RGBAV type
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type RGBAV = [number, number, number, number];
|
||||
```
|
||||
|
|
|
@ -1,22 +1,22 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [rgbav2hex](./color.rgbav2hex.md)
|
||||
|
||||
## rgbav2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function rgbav2hex(rgbav: RGBAV): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rgbav | [RGBAV](./color.rgbav.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [rgbav2hex](./color.rgbav2hex.md)
|
||||
|
||||
## rgbav2hex() function
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function rgbav2hex(rgbav: RGBAV): string;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| rgbav | [RGBAV](./color.rgbav.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
string
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [accent](./color.scheme.accent.md)
|
||||
|
||||
## Scheme.accent property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accent: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [accent](./color.scheme.accent.md)
|
||||
|
||||
## Scheme.accent property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accent: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [background](./color.scheme.background.md)
|
||||
|
||||
## Scheme.background property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
background: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [background](./color.scheme.background.md)
|
||||
|
||||
## Scheme.background property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
background: string;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimary](./color.scheme.dataprimary.md)
|
||||
|
||||
## Scheme.dataPrimary property
|
||||
|
||||
Primary data color, derived from the accent.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimary: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimary](./color.scheme.dataprimary.md)
|
||||
|
||||
## Scheme.dataPrimary property
|
||||
|
||||
Primary data color, derived from the accent.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimary: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimaryBold](./color.scheme.dataprimarybold.md)
|
||||
|
||||
## Scheme.dataPrimaryBold property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimaryBold: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimaryBold](./color.scheme.dataprimarybold.md)
|
||||
|
||||
## Scheme.dataPrimaryBold property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimaryBold: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimaryMuted](./color.scheme.dataprimarymuted.md)
|
||||
|
||||
## Scheme.dataPrimaryMuted property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimaryMuted: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [dataPrimaryMuted](./color.scheme.dataprimarymuted.md)
|
||||
|
||||
## Scheme.dataPrimaryMuted property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
dataPrimaryMuted: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [diverging](./color.scheme.diverging.md)
|
||||
|
||||
## Scheme.diverging property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
diverging: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [diverging](./color.scheme.diverging.md)
|
||||
|
||||
## Scheme.diverging property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
diverging: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [diverging2](./color.scheme.diverging2.md)
|
||||
|
||||
## Scheme.diverging2 property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
diverging2: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [diverging2](./color.scheme.diverging2.md)
|
||||
|
||||
## Scheme.diverging2 property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
diverging2: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [error](./color.scheme.error.md)
|
||||
|
||||
## Scheme.error property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
error: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [error](./color.scheme.error.md)
|
||||
|
||||
## Scheme.error property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
error: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [faintAnnotation](./color.scheme.faintannotation.md)
|
||||
|
||||
## Scheme.faintAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
faintAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [faintAnnotation](./color.scheme.faintannotation.md)
|
||||
|
||||
## Scheme.faintAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
faintAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [foreground](./color.scheme.foreground.md)
|
||||
|
||||
## Scheme.foreground property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
foreground: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [foreground](./color.scheme.foreground.md)
|
||||
|
||||
## Scheme.foreground property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
foreground: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [greys](./color.scheme.greys.md)
|
||||
|
||||
## Scheme.greys property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greys: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [greys](./color.scheme.greys.md)
|
||||
|
||||
## Scheme.greys property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greys: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [highContrastAnnotation](./color.scheme.highcontrastannotation.md)
|
||||
|
||||
## Scheme.highContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
highContrastAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [highContrastAnnotation](./color.scheme.highcontrastannotation.md)
|
||||
|
||||
## Scheme.highContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
highContrastAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [lowContrastAnnotation](./color.scheme.lowcontrastannotation.md)
|
||||
|
||||
## Scheme.lowContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lowContrastAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [lowContrastAnnotation](./color.scheme.lowcontrastannotation.md)
|
||||
|
||||
## Scheme.lowContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lowContrastAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [lowMidContrastAnnotation](./color.scheme.lowmidcontrastannotation.md)
|
||||
|
||||
## Scheme.lowMidContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lowMidContrastAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [lowMidContrastAnnotation](./color.scheme.lowmidcontrastannotation.md)
|
||||
|
||||
## Scheme.lowMidContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lowMidContrastAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,43 +1,43 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md)
|
||||
|
||||
## Scheme interface
|
||||
|
||||
Core color properties for a computed color scheme. Note the values are all strings - our color default representation uses hex codes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Scheme
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [accent](./color.scheme.accent.md) | | string | |
|
||||
| [background](./color.scheme.background.md) | | string | |
|
||||
| [dataPrimary](./color.scheme.dataprimary.md) | | string | Primary data color, derived from the accent. |
|
||||
| [dataPrimaryBold](./color.scheme.dataprimarybold.md) | | string | |
|
||||
| [dataPrimaryMuted](./color.scheme.dataprimarymuted.md) | | string | |
|
||||
| [diverging](./color.scheme.diverging.md) | | string\[\] | |
|
||||
| [diverging2](./color.scheme.diverging2.md) | | string\[\] | |
|
||||
| [error](./color.scheme.error.md) | | string | |
|
||||
| [faintAnnotation](./color.scheme.faintannotation.md) | | string | |
|
||||
| [foreground](./color.scheme.foreground.md) | | string | |
|
||||
| [greys](./color.scheme.greys.md) | | string\[\] | |
|
||||
| [highContrastAnnotation](./color.scheme.highcontrastannotation.md) | | string | |
|
||||
| [lowContrastAnnotation](./color.scheme.lowcontrastannotation.md) | | string | |
|
||||
| [lowMidContrastAnnotation](./color.scheme.lowmidcontrastannotation.md) | | string | |
|
||||
| [midContrastAnnotation](./color.scheme.midcontrastannotation.md) | | string | |
|
||||
| [midHighContrastAnnotation](./color.scheme.midhighcontrastannotation.md) | | string | |
|
||||
| [nominal](./color.scheme.nominal.md) | | string\[\] | |
|
||||
| [nominalBold](./color.scheme.nominalbold.md) | | string\[\] | |
|
||||
| [nominalMuted](./color.scheme.nominalmuted.md) | | string\[\] | |
|
||||
| [offsetBackground](./color.scheme.offsetbackground.md) | | string | |
|
||||
| [rainbow](./color.scheme.rainbow.md) | | string\[\] | |
|
||||
| [sequential](./color.scheme.sequential.md) | | string\[\] | |
|
||||
| [sequential2](./color.scheme.sequential2.md) | | string\[\] | |
|
||||
| [warning](./color.scheme.warning.md) | | string | |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md)
|
||||
|
||||
## Scheme interface
|
||||
|
||||
Core color properties for a computed color scheme. Note the values are all strings - our color default representation uses hex codes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Scheme
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [accent](./color.scheme.accent.md) | | string | |
|
||||
| [background](./color.scheme.background.md) | | string | |
|
||||
| [dataPrimary](./color.scheme.dataprimary.md) | | string | Primary data color, derived from the accent. |
|
||||
| [dataPrimaryBold](./color.scheme.dataprimarybold.md) | | string | |
|
||||
| [dataPrimaryMuted](./color.scheme.dataprimarymuted.md) | | string | |
|
||||
| [diverging](./color.scheme.diverging.md) | | string\[\] | |
|
||||
| [diverging2](./color.scheme.diverging2.md) | | string\[\] | |
|
||||
| [error](./color.scheme.error.md) | | string | |
|
||||
| [faintAnnotation](./color.scheme.faintannotation.md) | | string | |
|
||||
| [foreground](./color.scheme.foreground.md) | | string | |
|
||||
| [greys](./color.scheme.greys.md) | | string\[\] | |
|
||||
| [highContrastAnnotation](./color.scheme.highcontrastannotation.md) | | string | |
|
||||
| [lowContrastAnnotation](./color.scheme.lowcontrastannotation.md) | | string | |
|
||||
| [lowMidContrastAnnotation](./color.scheme.lowmidcontrastannotation.md) | | string | |
|
||||
| [midContrastAnnotation](./color.scheme.midcontrastannotation.md) | | string | |
|
||||
| [midHighContrastAnnotation](./color.scheme.midhighcontrastannotation.md) | | string | |
|
||||
| [nominal](./color.scheme.nominal.md) | | string\[\] | |
|
||||
| [nominalBold](./color.scheme.nominalbold.md) | | string\[\] | |
|
||||
| [nominalMuted](./color.scheme.nominalmuted.md) | | string\[\] | |
|
||||
| [offsetBackground](./color.scheme.offsetbackground.md) | | string | |
|
||||
| [rainbow](./color.scheme.rainbow.md) | | string\[\] | |
|
||||
| [sequential](./color.scheme.sequential.md) | | string\[\] | |
|
||||
| [sequential2](./color.scheme.sequential2.md) | | string\[\] | |
|
||||
| [warning](./color.scheme.warning.md) | | string | |
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [midContrastAnnotation](./color.scheme.midcontrastannotation.md)
|
||||
|
||||
## Scheme.midContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
midContrastAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [midContrastAnnotation](./color.scheme.midcontrastannotation.md)
|
||||
|
||||
## Scheme.midContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
midContrastAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [midHighContrastAnnotation](./color.scheme.midhighcontrastannotation.md)
|
||||
|
||||
## Scheme.midHighContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
midHighContrastAnnotation: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [midHighContrastAnnotation](./color.scheme.midhighcontrastannotation.md)
|
||||
|
||||
## Scheme.midHighContrastAnnotation property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
midHighContrastAnnotation: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominal](./color.scheme.nominal.md)
|
||||
|
||||
## Scheme.nominal property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominal: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominal](./color.scheme.nominal.md)
|
||||
|
||||
## Scheme.nominal property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominal: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominalBold](./color.scheme.nominalbold.md)
|
||||
|
||||
## Scheme.nominalBold property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominalBold: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominalBold](./color.scheme.nominalbold.md)
|
||||
|
||||
## Scheme.nominalBold property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominalBold: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominalMuted](./color.scheme.nominalmuted.md)
|
||||
|
||||
## Scheme.nominalMuted property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominalMuted: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [nominalMuted](./color.scheme.nominalmuted.md)
|
||||
|
||||
## Scheme.nominalMuted property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nominalMuted: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [offsetBackground](./color.scheme.offsetbackground.md)
|
||||
|
||||
## Scheme.offsetBackground property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
offsetBackground: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [offsetBackground](./color.scheme.offsetbackground.md)
|
||||
|
||||
## Scheme.offsetBackground property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
offsetBackground: string;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [rainbow](./color.scheme.rainbow.md)
|
||||
|
||||
## Scheme.rainbow property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rainbow: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [rainbow](./color.scheme.rainbow.md)
|
||||
|
||||
## Scheme.rainbow property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
rainbow: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [sequential](./color.scheme.sequential.md)
|
||||
|
||||
## Scheme.sequential property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sequential: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [sequential](./color.scheme.sequential.md)
|
||||
|
||||
## Scheme.sequential property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sequential: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [sequential2](./color.scheme.sequential2.md)
|
||||
|
||||
## Scheme.sequential2 property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sequential2: string[];
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [sequential2](./color.scheme.sequential2.md)
|
||||
|
||||
## Scheme.sequential2 property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sequential2: string[];
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [warning](./color.scheme.warning.md)
|
||||
|
||||
## Scheme.warning property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
warning: string;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [Scheme](./color.scheme.md) > [warning](./color.scheme.warning.md)
|
||||
|
||||
## Scheme.warning property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
warning: string;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentHue](./color.schemeparams.accenthue.md)
|
||||
|
||||
## SchemeParams.accentHue property
|
||||
|
||||
HSL hue component for the accent. Valid range is 0-360 (degrees).
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentHue: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentHue](./color.schemeparams.accenthue.md)
|
||||
|
||||
## SchemeParams.accentHue property
|
||||
|
||||
HSL hue component for the accent. Valid range is 0-360 (degrees).
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentHue: number;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentLightness](./color.schemeparams.accentlightness.md)
|
||||
|
||||
## SchemeParams.accentLightness property
|
||||
|
||||
HSL lightness component for the accent. Valid range is 0-100.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentLightness: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentLightness](./color.schemeparams.accentlightness.md)
|
||||
|
||||
## SchemeParams.accentLightness property
|
||||
|
||||
HSL lightness component for the accent. Valid range is 0-100.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentLightness: number;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentSaturation](./color.schemeparams.accentsaturation.md)
|
||||
|
||||
## SchemeParams.accentSaturation property
|
||||
|
||||
HSL saturation component for the accent. Valid range is 0-100.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentSaturation: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [accentSaturation](./color.schemeparams.accentsaturation.md)
|
||||
|
||||
## SchemeParams.accentSaturation property
|
||||
|
||||
HSL saturation component for the accent. Valid range is 0-100.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
accentSaturation: number;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [greyHue](./color.schemeparams.greyhue.md)
|
||||
|
||||
## SchemeParams.greyHue property
|
||||
|
||||
Optional hue to mix some of warm or cool into grey scales.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greyHue?: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [greyHue](./color.schemeparams.greyhue.md)
|
||||
|
||||
## SchemeParams.greyHue property
|
||||
|
||||
Optional hue to mix some of warm or cool into grey scales.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greyHue?: number;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [greySaturation](./color.schemeparams.greysaturation.md)
|
||||
|
||||
## SchemeParams.greySaturation property
|
||||
|
||||
Optional saturation to mix some of warm or cool into grey scales.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greySaturation?: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [greySaturation](./color.schemeparams.greysaturation.md)
|
||||
|
||||
## SchemeParams.greySaturation property
|
||||
|
||||
Optional saturation to mix some of warm or cool into grey scales.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
greySaturation?: number;
|
||||
```
|
||||
|
|
|
@ -1,26 +1,26 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md)
|
||||
|
||||
## SchemeParams interface
|
||||
|
||||
This is the core set of parameters for generating schemes using the ColorPicker
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface SchemeParams
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [accentHue](./color.schemeparams.accenthue.md) | | number | HSL hue component for the accent. Valid range is 0-360 (degrees). |
|
||||
| [accentLightness](./color.schemeparams.accentlightness.md) | | number | HSL lightness component for the accent. Valid range is 0-100. |
|
||||
| [accentSaturation](./color.schemeparams.accentsaturation.md) | | number | HSL saturation component for the accent. Valid range is 0-100. |
|
||||
| [greyHue?](./color.schemeparams.greyhue.md) | | number | <i>(Optional)</i> Optional hue to mix some of warm or cool into grey scales. |
|
||||
| [greySaturation?](./color.schemeparams.greysaturation.md) | | number | <i>(Optional)</i> Optional saturation to mix some of warm or cool into grey scales. |
|
||||
| [scaleLightness?](./color.schemeparams.scalelightness.md) | | number | <i>(Optional)</i> Sets the default lightness for nominal scales. Muted and bold scales are a fixed lightness +- |
|
||||
| [scaleSaturation?](./color.schemeparams.scalesaturation.md) | | number | <i>(Optional)</i> Sets the default saturation for nominal scales. Muted and bold scales are a fixed saturation +- |
|
||||
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md)
|
||||
|
||||
## SchemeParams interface
|
||||
|
||||
This is the core set of parameters for generating schemes using the ColorPicker
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface SchemeParams
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [accentHue](./color.schemeparams.accenthue.md) | | number | HSL hue component for the accent. Valid range is 0-360 (degrees). |
|
||||
| [accentLightness](./color.schemeparams.accentlightness.md) | | number | HSL lightness component for the accent. Valid range is 0-100. |
|
||||
| [accentSaturation](./color.schemeparams.accentsaturation.md) | | number | HSL saturation component for the accent. Valid range is 0-100. |
|
||||
| [greyHue?](./color.schemeparams.greyhue.md) | | number | <i>(Optional)</i> Optional hue to mix some of warm or cool into grey scales. |
|
||||
| [greySaturation?](./color.schemeparams.greysaturation.md) | | number | <i>(Optional)</i> Optional saturation to mix some of warm or cool into grey scales. |
|
||||
| [scaleLightness?](./color.schemeparams.scalelightness.md) | | number | <i>(Optional)</i> Sets the default lightness for nominal scales. Muted and bold scales are a fixed lightness +- |
|
||||
| [scaleSaturation?](./color.schemeparams.scalesaturation.md) | | number | <i>(Optional)</i> Sets the default saturation for nominal scales. Muted and bold scales are a fixed saturation +- |
|
||||
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [scaleLightness](./color.schemeparams.scalelightness.md)
|
||||
|
||||
## SchemeParams.scaleLightness property
|
||||
|
||||
Sets the default lightness for nominal scales. Muted and bold scales are a fixed lightness +-
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scaleLightness?: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [scaleLightness](./color.schemeparams.scalelightness.md)
|
||||
|
||||
## SchemeParams.scaleLightness property
|
||||
|
||||
Sets the default lightness for nominal scales. Muted and bold scales are a fixed lightness +-
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scaleLightness?: number;
|
||||
```
|
||||
|
|
|
@ -1,13 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [scaleSaturation](./color.schemeparams.scalesaturation.md)
|
||||
|
||||
## SchemeParams.scaleSaturation property
|
||||
|
||||
Sets the default saturation for nominal scales. Muted and bold scales are a fixed saturation +-
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scaleSaturation?: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [SchemeParams](./color.schemeparams.md) > [scaleSaturation](./color.schemeparams.scalesaturation.md)
|
||||
|
||||
## SchemeParams.scaleSaturation property
|
||||
|
||||
Sets the default saturation for nominal scales. Muted and bold scales are a fixed saturation +-
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
scaleSaturation?: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [analogousRange](./color.tuningparameters.analogousrange.md)
|
||||
|
||||
## TuningParameters.analogousRange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
analogousRange: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [analogousRange](./color.tuningparameters.analogousrange.md)
|
||||
|
||||
## TuningParameters.analogousRange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
analogousRange: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [backgroundHueShift](./color.tuningparameters.backgroundhueshift.md)
|
||||
|
||||
## TuningParameters.backgroundHueShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backgroundHueShift: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [backgroundHueShift](./color.tuningparameters.backgroundhueshift.md)
|
||||
|
||||
## TuningParameters.backgroundHueShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backgroundHueShift: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [backgroundLevel](./color.tuningparameters.backgroundlevel.md)
|
||||
|
||||
## TuningParameters.backgroundLevel property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backgroundLevel: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [backgroundLevel](./color.tuningparameters.backgroundlevel.md)
|
||||
|
||||
## TuningParameters.backgroundLevel property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backgroundLevel: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [complementaryRange](./color.tuningparameters.complementaryrange.md)
|
||||
|
||||
## TuningParameters.complementaryRange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
complementaryRange: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [complementaryRange](./color.tuningparameters.complementaryrange.md)
|
||||
|
||||
## TuningParameters.complementaryRange property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
complementaryRange: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkBackgroundLightnessShift](./color.tuningparameters.darkbackgroundlightnessshift.md)
|
||||
|
||||
## TuningParameters.darkBackgroundLightnessShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkBackgroundLightnessShift: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkBackgroundLightnessShift](./color.tuningparameters.darkbackgroundlightnessshift.md)
|
||||
|
||||
## TuningParameters.darkBackgroundLightnessShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkBackgroundLightnessShift: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkestGrey](./color.tuningparameters.darkestgrey.md)
|
||||
|
||||
## TuningParameters.darkestGrey property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkestGrey: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkestGrey](./color.tuningparameters.darkestgrey.md)
|
||||
|
||||
## TuningParameters.darkestGrey property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkestGrey: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkMaxLightnessOffet](./color.tuningparameters.darkmaxlightnessoffet.md)
|
||||
|
||||
## TuningParameters.darkMaxLightnessOffet property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkMaxLightnessOffet: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkMaxLightnessOffet](./color.tuningparameters.darkmaxlightnessoffet.md)
|
||||
|
||||
## TuningParameters.darkMaxLightnessOffet property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkMaxLightnessOffet: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkTextLightness](./color.tuningparameters.darktextlightness.md)
|
||||
|
||||
## TuningParameters.darkTextLightness property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkTextLightness: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [darkTextLightness](./color.tuningparameters.darktextlightness.md)
|
||||
|
||||
## TuningParameters.darkTextLightness property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
darkTextLightness: number;
|
||||
```
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [lightBackgroundLightnessShift](./color.tuningparameters.lightbackgroundlightnessshift.md)
|
||||
|
||||
## TuningParameters.lightBackgroundLightnessShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lightBackgroundLightnessShift: number;
|
||||
```
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@thematic/color](./color.md) > [TuningParameters](./color.tuningparameters.md) > [lightBackgroundLightnessShift](./color.tuningparameters.lightbackgroundlightnessshift.md)
|
||||
|
||||
## TuningParameters.lightBackgroundLightnessShift property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
lightBackgroundLightnessShift: number;
|
||||
```
|
||||
|
|
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче