Class Color

Hierarchy

Fruit
- Color

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Color(): Color
new Color(value: string): Color
new Color(r: number, g: number, b: number): Color
new Color(r: number, g: number, b: number, a: number): Color

Overrides Fruit.constructor
- Defined in dataTypes/Color.ts:194
Returns Color
Overrides Fruit.constructor
- Defined in dataTypes/Color.ts:196
Parameters
- value: string
Returns Color
Overrides Fruit.constructor
- Defined in dataTypes/Color.ts:197
Parameters
- r: number
- g: number
- b: number
Returns Color
Overrides Fruit.constructor
- Defined in dataTypes/Color.ts:198
Parameters
- r: number
- g: number
- b: number
- a: number
Returns Color

Properties

options

options: ConfigOptions

raw

raw: string

valid

valid: boolean = false

Accessors

__@toStringTag

get __@toStringTag(): string

Inherited from Fruit.__@toStringTag
- Defined in Fruit.ts:190
Returns string

a

get a(): number
set a(a: number): void

- Defined in dataTypes/Color.ts:189
Returns number
- Defined in dataTypes/Color.ts:190
Parameters
- a: number
Returns void

b

get b(): number
set b(b: number): void

- Defined in dataTypes/Color.ts:182
Returns number
- Defined in dataTypes/Color.ts:183
Parameters
- b: number
Returns void

g

get g(): number
set g(g: number): void

- Defined in dataTypes/Color.ts:175
Returns number
- Defined in dataTypes/Color.ts:176
Parameters
- g: number
Returns void

r

get r(): number
set r(r: number): void

- Defined in dataTypes/Color.ts:168
Returns number
- Defined in dataTypes/Color.ts:169
Parameters
- r: number
Returns void

Methods

absorb

absorb(prop: string, value: string): this
absorb(decl: decl): this
absorb(decls: Array<decl>): this

Inherited from Fruit.absorb
- Defined in Fruit.ts:198
Parameters
- prop: string
- value: string
Returns this
Inherited from Fruit.absorb
- Defined in Fruit.ts:199
Parameters
- decl: decl
Returns this
Inherited from Fruit.absorb
- Defined in Fruit.ts:200
Parameters
- decls: Array<decl>
Returns this

analyze

analyze(stem: Stem): void

Inherited from Fruit.analyze
- Defined in Fruit.ts:160
Parameters
- stem: Stem
Returns void

getHSL

getHSL(): object

- Defined in dataTypes/Color.ts:432
Get HSL values of the color

Returns object
- h: number
- l: number
- s: number

getHSV

getHSV(): object

- Defined in dataTypes/Color.ts:412
Get HSV values of the color

Returns object
- h: number
- s: number
- v: number

getRGB

getRGB(): object

- Defined in dataTypes/Color.ts:373
Get RGB values of the color

Returns object
- b: number
- g: number
- r: number

init

init(): void

- Defined in dataTypes/Color.ts:234
Returns void

parse

parse(value: string): Fruit | string

Inherited from Fruit.parse
- Defined in Fruit.ts:135
Parameters
- value: string
Returns Fruit | string

setHSL

setHSL(h: number, s: number, l: number): void

- Defined in dataTypes/Color.ts:442
Create a new color from HSL representation

Parameters
- h: number
  
  Hue, in the set [0, 360]
- s: number
  
  Saturation, in the set [0, 100]
- l: number
  
  Lightness, in the set [0, 100]
Returns void

setHSV

setHSV(h: number, s: number, v: number): void

- Defined in dataTypes/Color.ts:422
Set color values by HSV representation

Parameters
- h: number
  
  Hue, in the set [0, 360]
- s: number
  
  Saturation, in the set [0, 100]
- v: number
  
  Value, in the set [0, 100]
Returns void

setHex

setHex(hex: string): void

- Defined in dataTypes/Color.ts:341
Set color values by Hexadecimal

Parameters
- hex: string
  
  Hexadecimal number
Returns void

setRGB

setRGB(r: number, g: number, b: number): void

- Defined in dataTypes/Color.ts:383
Set color values by RGB representation

Parameters
- r: number
  
  Red, in the set [0, 255]
- g: number
  
  Green, in the set [0, 255]
- b: number
  
  Blue, in the set [0, 255]
Returns void

toHSL

toHSL(): string

- Defined in dataTypes/Color.ts:449
To a HSL function string

Returns string

toHSLA

toHSLA(): string

- Defined in dataTypes/Color.ts:457
To a HSLA function string

Returns string

toHex

toHex(alpha?: boolean): string

- Defined in dataTypes/Color.ts:361
To a Hexadecimal string

Parameters
- Optional alpha: boolean
  
  Show alpha
Returns string

toRGB

toRGB(percentage?: boolean): string

- Defined in dataTypes/Color.ts:391
To a RGB function string

Parameters
- Optional percentage: boolean
  
  Represent in percentage or not
Returns string

toRGBA

toRGBA(percentage?: boolean): string

- Defined in dataTypes/Color.ts:402
To a RGBA function string

Parameters
- Optional percentage: boolean
  
  Represent in percentage or not
Returns string

toResult

toResult(): Fruit | string

Inherited from Fruit.toResult
- Defined in Fruit.ts:151
Returns Fruit | string

toString

toString(): string

Overrides Fruit.toString
- Defined in dataTypes/Color.ts:314
Returns string

toTuple

toTuple(alpha?: boolean): [number, number, number] | [number, number, number, number]

- Defined in dataTypes/Color.ts:330
To a Tuple (Array)

Parameters
- Optional alpha: boolean
  
  Show alpha
Returns [number, number, number] | [number, number, number, number]

Static absorb

absorb(prop: string, value: string): Fruit
absorb(decl: decl): Fruit
absorb(decls: Array<decl>): Fruit

Inherited from Fruit.absorb
- Defined in Fruit.ts:241
Parameters
- prop: string
- value: string
Returns Fruit
Inherited from Fruit.absorb
- Defined in Fruit.ts:242
Parameters
- decl: decl
Returns Fruit
Inherited from Fruit.absorb
- Defined in Fruit.ts:243
Parameters
- decls: Array<decl>
Returns Fruit

Static config

config(options: ConfigOptions): void

Inherited from Fruit.config
- Defined in Fruit.ts:219
Parameters
- options: ConfigOptions
Returns void

Static fromHSL

fromHSL(h: number, s: number, l: number): Color

- Defined in dataTypes/Color.ts:490
Create a new color from HSL representation

Parameters
- h: number
  
  Hue, in the set [0, 360]
- s: number
  
  Saturation, in the set [0, 100]
- l: number
  
  Lightness, in the set [0, 100]
Returns Color

Static fromHSV

fromHSV(h: number, s: number, v: number): Color

- Defined in dataTypes/Color.ts:478
Create a new color from HSV representation

Parameters
- h: number
  
  Hue, in the set [0, 360]
- s: number
  
  Saturation, in the set [0, 100]
- v: number
  
  Value, in the set [0, 100]
Returns Color

Static fromHex

fromHex(hex: string): Color

- Defined in dataTypes/Color.ts:466
Create a new color from Hexadecimal

Parameters
- hex: string
  
  Hexadecimal number
Returns Color

Static parse

parse(value: string): Fruit | string

Inherited from Fruit.parse
- Defined in Fruit.ts:224
Parameters
- value: string
Returns Fruit | string

Static validate

validate(value: string): boolean

Inherited from Fruit.validate
- Defined in Fruit.ts:231
Parameters
- value: string
Returns boolean

Generated using TypeDoc