color

Index

Type aliases

Variables

color_scheme

Functions

Type aliases

Color: Tagged<"Color", `#${string}`>

Colors are strings in the form #rrggbb.

HSV

HSV: { h: Degrees; s: Unit; v: Unit } & Tag<"HSV">

HSVSpec

HSVSpec: { h: number; s: number; v: number }

Type declaration

h: number
s: number
v: number

RGB

RGB: { b: Byte; g: Byte; r: Byte } & Tag<"RGB">

RGBSpec

RGBSpec: { b: number; g: number; r: number }

Type declaration

b: number
g: number
r: number

Variables

Const color_scheme

color_scheme: Color[] = ...

The supplied color scheme.

Functions

Const HSVtoRGB

HSVtoRGB(c: HSVSpec): RGB

- Defined in src/color.ts:106
Parameters
- c: HSVSpec
Returns RGB

Const RGBtoHSV

RGBtoHSV(c: RGBSpec): HSV

- Defined in src/color.ts:85
Parameters
- c: RGBSpec
Returns HSV

Const asColor

asColor(c: string): Color

- Defined in src/color.ts:22
Typecheck that a string is a valid Color value.

Parameters
- c: string
Returns Color

Const asHSV

asHSV(c: HSVSpec | HSV): HSV

- Defined in src/color.ts:82
Parameters
- c: HSVSpec | HSV
Returns HSV

Const asRGB

asRGB(rgb: RGBSpec): RGB

- Defined in src/color.ts:30
Parameters
- rgb: RGBSpec
Returns RGB

Const colorsFor

colorsFor(color_scheme: Color[], unknown?: Color): <T>(keys: Iterable<T>) => { domain: any; range: any; unknown: any }

- Defined in src/color.ts:196
Compute a set of color mappings for items in a given set of keys. A higher-order function. Supply color_scheme (and optionally unknown), and it will return a a function that accepts a list of keys

Parameters
- color_scheme: Color[]
  
  a list of colors in '#rrggbb' format.
- unknown: Color = ...
  
  the color to use for unknown keys
Returns <T>(keys: Iterable<T>) => { domain: any; range: any; unknown: any }

an object equivalent to a d3 ordinal interpolator.
- - <T>(keys: Iterable<T>): { domain: any; range: any; unknown: any }
  - Type parameters
    - T
    Parameters
    - keys: Iterable<T>
    Returns { domain: any; range: any; unknown: any }
    - - (k: T): any
      - Parameters
        
        k: T
        
        Returns any
    - domain: function
      - domain(): T[]
      - Defined in src/color.ts:208
        
        Returns T[]
    - range: function
      - range(): any[]
      - Defined in src/color.ts:207
        
        Returns any[]
    - unknown: function
      - unknown(nv?: Color): Color
      - Defined in src/color.ts:209
        
        Parameters
        
        Optional nv: Color
        
        Returns Color

Const compute_colors

compute_colors(color_scheme: Color[], unknown?: Color): (scenario_list: Scenario[]) => { domain: any; range: any; unknown: any }

- Defined in src/color.ts:151
Compute a set of color mappings for items in a given set of scenarios. A higher-order function. Supply color_scheme (and optionally unknown), and it will return a a function that accepts a list of scenarios

Parameters
- color_scheme: Color[]
  
  a list of colors in '#rrggbb' format.
- unknown: Color = ...
  
  the color to use for unknown keys
Returns (scenario_list: Scenario[]) => { domain: any; range: any; unknown: any }

a d3 ordinal interpolator.
- - (scenario_list: Scenario[]): { domain: any; range: any; unknown: any }
  - Parameters
    - scenario_list: Scenario[]
    Returns { domain: any; range: any; unknown: any }
    - - (k: string): any
      - Parameters
        
        k: string
        
        Returns any
    - domain: function
      - domain(): string[]
      - Defined in src/color.ts:208
        
        Returns string[]
    - range: function
      - range(): any[]
      - Defined in src/color.ts:207
        
        Returns any[]
    - unknown: function
      - unknown(nv?: Color): Color
      - Defined in src/color.ts:209
        
        Parameters
        
        Optional nv: Color
        
        Returns Color

Const default_colors

default_colors(scenario_list: Scenario[]): { domain: any; range: any; unknown: any }

- Defined in src/color.ts:168
Accept a list of scenarios, and return the default color scheme to use.

Parameters
- scenario_list: Scenario[]
Returns { domain: any; range: any; unknown: any }
- - (k: string): any
  - Parameters
    - k: string
    Returns any
- domain: function
  - domain(): string[]
  - - Defined in src/color.ts:208
    Returns string[]
- range: function
  - range(): any[]
  - - Defined in src/color.ts:207
    Returns any[]
- unknown: function
  - unknown(nv?: Color): Color
  - - Defined in src/color.ts:209
    Parameters
    - Optional nv: Color
    Returns Color

Const hsv

hsv(c: string | Color | RGBSpec | HSVSpec): HSV

- Defined in src/color.ts:63
Parameters
- c: string | Color | RGBSpec | HSVSpec
Returns HSV

Const isHSV

isHSV(c: Color | RGBSpec | HSVSpec): c is HSV

- Defined in src/color.ts:76
Parameters
- c: Color | RGBSpec | HSVSpec
Returns c is HSV

Const isRGB

isRGB(c: Color | RGBSpec | HSVSpec): c is RGB

- Defined in src/color.ts:33
Parameters
- c: Color | RGBSpec | HSVSpec
Returns c is RGB

Const rgb

rgb(c: string | Color | RGBSpec | HSVSpec): RGB

- Defined in src/color.ts:39
Parameters
- c: string | Color | RGBSpec | HSVSpec
Returns RGB

Const subcolors

subcolors(colors: ScaleOrdinal<string, Color, string>, subdomain: Color[]): { domain: any; range: any }

- Defined in src/color.ts:178
Subset a color interpolator to a subdomain. This is used to allow genenrating a swatch for just the relevant items.

Parameters
- colors: ScaleOrdinal<string, Color, string>
- subdomain: Color[]
Returns { domain: any; range: any }

a d3 ordinal interpolator.
- - (color: Color): string | Color
  - Parameters
    - color: Color
    Returns string | Color
- domain: function
  - domain(): Color[]
  - - Defined in src/color.ts:183
    Returns Color[]
- range: function
  - range(): (string | Color)[]
  - - Defined in src/color.ts:184
    Returns (string | Color)[]

Index

Type aliases

Variables

Functions

Type aliases

Color

HSV

HSVSpec

Type declaration

h: number

s: number

v: number

RGB

RGBSpec

Type declaration

b: number

g: number

r: number

Variables

Const color_scheme

Functions

Const HSVtoRGB

Parameters

c: HSVSpec

Returns RGB

Const RGBtoHSV

Parameters

c: RGBSpec

Returns HSV

Const asColor

Parameters

c: string

Returns Color

Const asHSV

Parameters

c: HSVSpec | HSV

Returns HSV

Const asRGB

Parameters

rgb: RGBSpec

Returns RGB

Const colorsFor

Parameters

color_scheme: Color[]

unknown: Color = ...

Returns <T>(keys: Iterable<T>) => { domain: any; range: any; unknown: any }

Type parameters

T

Parameters

keys: Iterable<T>

Returns { domain: any; range: any; unknown: any }

Parameters

k: T

Returns any

domain: function

Returns T[]

range: function

Returns any[]

unknown: function

Parameters

Optional nv: Color

Returns Color

Const compute_colors

Parameters

color_scheme: Color[]

unknown: Color = ...

Returns (scenario_list: Scenario[]) => { domain: any; range: any; unknown: any }

Parameters

scenario_list: Scenario[]

Returns { domain: any; range: any; unknown: any }

Parameters

k: string

Returns any

domain: function

Returns string[]

range: function

Returns any[]

unknown: function

Parameters

Optional nv: Color