module common.ts #

type Value #

export type Value = number | string | Date;

type NearestPoint #

export type NearestPoint = {
  node: KDTreeNode | BTreeNode;
  screenDistanceSq: number;
};

The result of either a BTree or KDTree search

• node BTreeNode | KDTreeNode
• screenDistanceSq number

type Threshold #

export type Threshold = {
    label?: string;
    color?: string;
    value: number | Domain;
};

Thresholds are used to represent static values or ranges on a particular series. They could be used for safety limits, known good/bad values etc...

• label string If defined, draws near threshold
• color string color override, accepts html color names and hex values like '#FF9900'
• value number | Domain value can be a single number which will produce a line, or a Domain value representing a range

type Margins #

export type Margins = {
  top: number;
  bottom: number;
  left: number;
  right: number;
};

DDV components provide a Margins object to all of their children. This object is computed continuously based on the domState and which children have reserved room in the chart's spaceReservations. all members represent screen-space pixels

• top number
• bottom number
• left number
• right number

type DataSet #

export type DataSet = {
  title?: string;
  color?: string;
  points: Point[];
  xAxisFormatter?: AxisTickFormatter;
  yAxisFormatter?: AxisTickFormatter;
  xValueFormatter?: ValueFormatter;
  yValueFormatter?: ValueFormatter;
  xAxisLabel?: string;
  yAxisLabel?: string;
  xDomain?: NumericDomain; 
  yDomain?: NumericDomain; 
  curveType?: CurveType;
  reverseXAxis?: boolean;
  reverseYAxis?: boolean;
  thresholds?: {
    x?: Threshold[];
    y?: Threshold[];
  };
};

Each DataSet represents a single series of 2D data as well as associated meta data. The only required attribute is points

• title string
• color string
• points Point[]
• xAxisFormatter AxisTickFormatter
• yAxisFormatter AxisTickFormatter
• xValueFormatter ValueFormatter
• yValueFormatter ValueFormatter
• xAxisLabel string
• yAxisLabel string
• xDomain NumericDomain
• yDomain NumericDomain
• curveType CurveType
• reverseXAxis boolean
• reverseYAxis boolean
• thresholds { x?: Threshold[]; y?: Threshold[]; }

type DOMState #

export type DOMState = {
    plotWidth: number;
    plotHeight: number;
    elementWidth: number;
    elementHeight: number;
    computedHeight: number;
};

The DDV component provides a DOMState object to all of its children. This object represents the outside world to the internals of ddv.

• plotWidth number width of plottable area in pixels
• plotHeight number with of plottable area in pixels
• elementWidth number container element width in pixels
• elementHeight number container-element height in pixels
• computedHeight number computed height based on elementWidth and aspectRatio

type MouseState #

export type MouseState = {
    mouse: NumericPoint;
  normalizedMouse: NumericPoint;
  globalMouse: NumericPoint; 
  isHovered: boolean; 
  isPlotHovered: boolean; 
};

DDV components provide a MouseState object to all of their children. This object represents the outside world's mouse to the internals of ddv.

• mouse NumericPoint mouse coordinates relative to 0,0 as top left of plot area
• normalizedMouse NumericPoint
• globalMouse NumericPoint
• isHovered boolean
• isPlotHovered boolean

type SpaceReservations #

export type SpaceReservations = {
  [index: string]: Margins;
};

type LinearScaler #

export type LinearScaler = {
  scale: ScaleFuncDiff<Value, number>;
  normalize?: ScaleFuncDiff<Value, number>;
  interpolate?: ScaleFunc<number>;
  invert?: ScaleFunc<number>;
  dereference?: ScaleFuncDiff<number, string>;
};

• scale ScaleFuncDiff<Value, number>
• normalize ScaleFuncDiff<Value, number>
• interpolate ScaleFunc<number>
• invert ScaleFunc<number>
• dereference ScaleFuncDiff<number, string>

type DiscreteScaler #

export type DiscreteScaler = {
  scale: ScaleFunc<number>;
  normalize?: ScaleFunc<number>;
  interpolate?: ScaleFunc<number>;
  
};

• scale ScaleFunc<number>
• normalize ScaleFunc<number>
• interpolate ScaleFunc<number>

type CartesianScaler #

export type CartesianScaler = {
  scale: ScaleFuncDiff<Point, NumericPoint>;
};

• scale ScaleFuncDiff<Point, NumericPoint>

type ToolTipSeries #

export type ToolTipSeries = {
  title?: string;
  xLabel?: string;
  yLabel?: string;
  isActive: boolean;
  nearestPoint: NearestPoint | null;
  xFormatter: ValueFormatter;
  yFormatter: ValueFormatter;
};

• title string
• xLabel string
• yLabel string
• isActive boolean
• nearestPoint NearestPoint
• xFormatter ValueFormatter
• yFormatter ValueFormatter

type ToolTipInfo #

export type ToolTipInfo = {
  [key: number]: ToolTipSeries;
};

interface Point #

export interface Point {
  x: Value;
  y: Value;
}

Thanks, Euclid! Pretty much what you'd expect. Call it a 2D vector or a point, it's 2 numbers in an object.

interface NumericPoint #

export interface NumericPoint extends Point {
  x: number;
  y: number;
}

interface DatePoint #

export interface DatePoint extends Point {
  x: Date;
  y: number;
}

interface DiscretePoint #

export interface DiscretePoint extends Point {
  x: string;
  y: number;
}

interface ScaleFunc #

export interface ScaleFunc<T> {
  (val: T): T; 
}

ScaleFunc<T> is a generic interface representing scaling a value in 1 range onto it's scaled value in another range. For instance graphing x point 10 from the range 0..100 onto the range 0..200 would yield 20. ScaleFuncs are generally used for individual dimensions of a plot mapping data points into screen points, one dimension at a time.

• undefined undefined

interface ScaleFuncDiff #

export interface ScaleFuncDiff<T_IN, T_OUT> {
  (val: T_IN): T_OUT; 
}

• undefined undefined

function isNumeric #

(p: Point) => p is NumericPoint

Parameters #

• p Point

Returns boolean #

function isDatePoint #

(p: Point) => p is DatePoint

Parameters #

• p Point

Returns boolean #

function isDiscretePoint #

(p: Point) => p is DiscretePoint

Parameters #

• p Point

Returns boolean #

function isNumericSeries #

(points: Point[]) => points is NumericPoint[]

Parameters #

• points Point

Returns boolean #

function isDateSeries #

(points: Point[]) => points is DatePoint[]

Parameters #

• points Point

Returns boolean #

function isDiscreteSeries #

(points: Point[]) => points is DiscretePoint[]

Parameters #

• points Point

Returns boolean #

function valueToNumber #

(v: Value, domain: Domain) => number

Parameters #

• v Value
• domain Domain

Returns number #

function getUniqueXValues #

(points: DiscretePoint[]) => string[]

Parameters #

• points DiscretePoint

Returns string[] #

function uniqueFilter #

(value: unknown, index: number, self: unknown[]) => boolean

Parameters #

• value unknown
• index number
• self unknown[]

Returns boolean #