module domain.ts #

type NumericDomain #

export type NumericDomain = {
  min: number;
  max: number;
};

Domains are used to represent a range of values, usually in data-space, but can be used to represent screen-space ranges as well

Note even with negative ranges the higher negative value shoudld still be set on min. like so... {min: -822, max: -400}

• min number
• max number

type DateDomain #

export type DateDomain = {
  min: Date;
  max: Date;
};

• min Date
• max Date

type Domain #

export type Domain = NumericDomain | DateDomain | DiscreteDomain;

interface DiscreteDomain #

export interface DiscreteDomain extends NumericDomain {
  values: string[];
}

function isNumberDomain #

(d: Domain) => d is NumericDomain

Parameters #

• d Domain

Returns boolean #

function isDateDomain #

(d: Domain) => d is DateDomain

Parameters #

• d Domain

Returns boolean #

function isDiscreteDomain #

(d: Domain) => d is DiscreteDomain

Parameters #

• d Domain

Returns boolean #

function fromValues #

(values: string[]) => DiscreteDomain

Parameters #

• values string[]

Returns DiscreteDomain #

function toNumericDomain #

(d: DateDomain) => NumericDomain

Parameters #

• d DateDomain

Returns NumericDomain #

function fromTimeFrame #

(vals: [Date, Date]) => DateDomain

Parameters #

• vals [Date, Date]

Returns DateDomain #

function fromRange #

(range: number, offset?: number) => NumericDomain

returns a new Domain given a range and optional offset. fromRange(100, 20) == {min: 20, max: 120}

Parameters #

• range number

  distance between the minimum and maximum values

• offset number

  where the range begins (defaults to 0)

Returns NumericDomain #

function getExtents #

(values: number[]) => NumericDomain

creates a new domain by finding the numeric min and max in a given array of numbers

getExtents([1,2,3,-10]) == {min:-10, max: 3}

Parameters #

• values number[]

Returns NumericDomain #

function getAbsoluteExtents #

(values: number[]) => NumericDomain

like getExtents but ensures 0 is part of the resulting range

Parameters #

• values number[]

Returns NumericDomain #

function getRange #

(domain: Domain) => number

gets the distance between a domain's min and max while considering negative values

Parameters #

• domain Domain

Returns number #

function scale #

(domain: Domain, offset: number, factor?: number) => Domain

scales a domain by a given factor

Parameters #

• domain Domain
• offset number
• factor number

Returns Domain #

function valueInside #

(value: Value, domain: Domain) => boolean

returns true if value is between a domain's min and max (inclusively of min and max)

Parameters #

• value Value
• domain Domain

Returns boolean #

function normalize #

(value: number | Date, domain: Domain) => number

Parameters #

• value number | Date
• domain Domain

Returns number #