dicom-microscopy-viewer-changed
Version:
Interactive web-based viewer for DICOM Microscopy Images
117 lines (75 loc) • 1.89 kB
Markdown
# Formatter
## Declarations
### Hex mode
``` ts
/**
* Type for `ColorSettable.toHex()` method.
* `full` - e.g. '#ff0000'
* `short`- e.g. '#f00'
* `name` - e.g. 'red'
*/
type HexMode = 'full'|'short'|'name';
```
### Rgb mode
``` ts
/**
* Type for `ColorSettable.toRgb()` method.
* `default` - e.g. 'rgb(255, 0, 0)'
* `percent` - e.g. 'rgb(100%, 0%, 0%)'
*/
type RgbMode = 'default'|'percent';
```
## Methods
### toString
Represents color as notation of specific color model.
Syntax
``` ts
mooColor.toString(model?: string, ...args?: any[]): string;
```
- @param `string` model - Specify color model. If not specifying this value, then returns current color model. `rgb`|`hwb`|`hsl`|`hsv`|`cmyk`|`hex`
- @param `...any[]` args - Arguments for the represent methods.
- @returns `string`
### toHex
Represents color as HEX notation.
Syntax
``` ts
mooColor.toHex(mode?: HexMode): string;
```
- @param [`HexMode`](#hex-mode) [mode = 'full'] - `full`|`short`|`name`
- @returns `string` - e.g. `#ff0000` or `#f00` or `red`
### toRgb
Represents color as RGB notation.
Syntax
``` ts
mooColor.toRgb(mode?: RgbMode): string;
```
- @param [`RgbMode`](#rgb-mode) [mode = 'default'] - `default`|`percent`
- @returns `string` - e.g. `rgb(255, 0, 0)` or `rgb(100%, 0%, 0%)`
### toHwb
Represents color as HWB notation.
Syntax
``` ts
mooColor.toHwb(): string;
```
- @returns `string` - e.g. `hwb(0, 0%, 0%)`
### toHsl
Represents color as HSL notation.
Syntax
``` ts
mooColor.toHsl(): string;
```
- @returns `string` - e.g. `hsl(0, 100%, 50%)`
### toHsv
Represents color as HSV notation. This format is similar to HSL.
Syntax
``` ts
mooColor.toHsv(): string;
```
- @returns `string` - e.g. `hsv(0, 100%, 100%)`
### toCmyk
Represents color as CMYK notation.
Syntax
``` ts
mooColor.toCmyk(): string;
```
- @returns `string` - e.g. `cmyk(0%, 100%, 100%, 0%)`