Skip to main content

chartist

Classes

Interfaces

Namespaces

Variables

axisUnits

Const axisUnits: Object

Type declaration

NameType
x{ pos: "x" = 'x'; len: "width" = 'width'; dir: "horizontal" = 'horizontal'; rectStart: "x1" = 'x1'; rectEnd: "x2" = 'x2'; rectOffset: "y2" = 'y2' }
x.pos"x"
x.len"width"
x.dir"horizontal"
x.rectStart"x1"
x.rectEnd"x2"
x.rectOffset"y2"
y{ pos: "y" = 'y'; len: "height" = 'height'; dir: "vertical" = 'vertical'; rectStart: "y2" = 'y2'; rectEnd: "y1" = 'y1'; rectOffset: "x1" = 'x1' }
y.pos"y"
y.len"height"
y.dir"vertical"
y.rectStart"y2"
y.rectEnd"y1"
y.rectOffset"x1"

Defined in

axes/Axis.ts:13


namespaces

Const namespaces: Record<string, string>

Defined in

core/constants.ts:4


precision

Const precision: 8

Defined in

core/constants.ts:15


escapingMap

Const escapingMap: Record<string, string>

Defined in

core/constants.ts:20


EPSILON

Const EPSILON: 2.221e-16

Defined in

core/math.ts:4


easings

Const easings: Object

Type declaration

NameType
easeInSinenumber[]
easeOutSinenumber[]
easeInOutSinenumber[]
easeInQuadnumber[]
easeOutQuadnumber[]
easeInOutQuadnumber[]
easeInCubicnumber[]
easeOutCubicnumber[]
easeInOutCubicnumber[]
easeInQuartnumber[]
easeOutQuartnumber[]
easeInOutQuartnumber[]
easeInQuintnumber[]
easeOutQuintnumber[]
easeInOutQuintnumber[]
easeInExponumber[]
easeOutExponumber[]
easeInOutExponumber[]
easeInCircnumber[]
easeOutCircnumber[]
easeInOutCircnumber[]
easeInBacknumber[]
easeOutBacknumber[]
easeInOutBacknumber[]

Defined in

svg/animation.ts:12

Type Aliases

XAxisUnits

Ƭ XAxisUnits: typeof x

Defined in

axes/Axis.ts:32


YAxisUnits

Ƭ YAxisUnits: typeof y

Defined in

axes/Axis.ts:33


AxisUnits

Ƭ AxisUnits: XAxisUnits | YAxisUnits

Defined in

axes/Axis.ts:34


AxisType

Ƭ AxisType: typeof AutoScaleAxis | typeof FixedScaleAxis | typeof StepAxis

Defined in

axes/types.ts:5


BarChartData

Ƭ BarChartData: Data

Defined in

charts/BarChart/BarChart.types.ts:13


BarChartOptionsWithDefaults

Ƭ BarChartOptionsWithDefaults: RequiredKeys<BarChartOptions<RequiredKeys<AxisOptions, "offset" | "position" | "labelOffset" | "showLabel" | "showGrid" | "labelInterpolationFnc" | "scaleMinSpace">, RequiredKeys<AxisOptions, "offset" | "position" | "labelOffset" | "showLabel" | "showGrid" | "labelInterpolationFnc" | "scaleMinSpace">>, "referenceValue" | "chartPadding" | "seriesBarDistance" | "stackMode" | "axisX" | "axisY", "classNames">

Defined in

charts/BarChart/BarChart.types.ts:68


BarChartCreatedEvent

Ƭ BarChartCreatedEvent: CreatedEvent<BarChartOptions>

Defined in

charts/BarChart/BarChart.types.ts:100


BarChartEventsTypes

Ƭ BarChartEventsTypes: BaseChartEventsTypes<BarChartCreatedEvent, AxesDrawEvent | BarDrawEvent>

Defined in

charts/BarChart/BarChart.types.ts:111


LineInterpolation

Ƭ LineInterpolation: (pathCoordinates: number[], valueData: SegmentData[]) => SvgPath

Type declaration

▸ (pathCoordinates, valueData): SvgPath

Parameters
NameType
pathCoordinatesnumber[]
valueDataSegmentData[]
Returns

SvgPath

Defined in

charts/LineChart/LineChart.types.ts:18


LineChartData

Ƭ LineChartData: Data<(Series | SeriesObject)[]>

Defined in

charts/LineChart/LineChart.types.ts:23


LineChartOptionsWithDefaults

Ƭ LineChartOptionsWithDefaults: RequiredKeys<LineChartOptions<RequiredKeys<AxisOptions, "offset" | "position" | "labelOffset" | "showLabel" | "showGrid" | "labelInterpolationFnc">, RequiredKeys<AxisOptions, "offset" | "position" | "labelOffset" | "showLabel" | "showGrid" | "labelInterpolationFnc" | "scaleMinSpace">>, "showLine" | "showPoint" | "areaBase" | "lineSmooth" | "chartPadding" | "axisX" | "axisY", "classNames">

Defined in

charts/LineChart/LineChart.types.ts:89


LineChartCreatedEvent

Ƭ LineChartCreatedEvent: CreatedEvent<LineChartOptions>

Defined in

charts/LineChart/LineChart.types.ts:121


LineChartEventsTypes

Ƭ LineChartEventsTypes: BaseChartEventsTypes<LineChartCreatedEvent, AxesDrawEvent | PointDrawEvent | LineDrawEvent | AreaDrawEvent>

Defined in

charts/LineChart/LineChart.types.ts:142


PieChartData

Ƭ PieChartData: Data<FlatSeries>

Defined in

charts/PieChart/PieChart.types.ts:14


LabelDirection

Ƭ LabelDirection: "implode" | "neutral" | "explode"

Defined in

charts/PieChart/PieChart.types.ts:16


AnchorPosition

Ƭ AnchorPosition: "start" | "middle" | "end"

Defined in

charts/PieChart/PieChart.types.ts:18


RadialLabelPosition

Ƭ RadialLabelPosition: "inside" | "center" | "outside"

Defined in

charts/PieChart/PieChart.types.ts:20


PieChartOptionsWithDefaults

Ƭ PieChartOptionsWithDefaults: RequiredKeys<PieChartOptions, "chartPadding" | "startAngle" | "donutWidth" | "showLabel" | "labelOffset" | "labelPosition" | "labelInterpolationFnc" | "labelDirection", "classNames">

Defined in

charts/PieChart/PieChart.types.ts:87


PieChartCreatedEvent

Ƭ PieChartCreatedEvent: Omit<CreatedEvent<PieChartOptions>, "axisX" | "axisY">

Defined in

charts/PieChart/PieChart.types.ts:100


PieChartEventsTypes

Ƭ PieChartEventsTypes: BaseChartEventsTypes<PieChartCreatedEvent, SliceDrawEvent | SliceLabelDrawEvent>

Defined in

charts/PieChart/PieChart.types.ts:125


Plugin

Ƭ Plugin: (chart: any, options?: any) => void

Type declaration

▸ (chart, options?): void

Parameters
NameType
chartany
options?any
Returns

void

Defined in

core/types.ts:23


Meta

Ƭ Meta: any

Defined in

core/types.ts:26


OptionsWithDefaults

Ƭ OptionsWithDefaults: RequiredKeys<Options<RequiredKeys<AxisOptions, "offset" | "labelOffset" | "labelInterpolationFnc">, RequiredKeys<AxisOptions, "offset" | "labelOffset" | "labelInterpolationFnc">>, "axisX" | "axisY" | "classNames">

Defined in

core/types.ts:131


ResponsiveOptions

Ƭ ResponsiveOptions<T>: [string, T][]

Type parameters

NameType
TOptions

Defined in

core/types.ts:145


AxisName

Ƭ AxisName: "x" | "y"

Defined in

core/types.ts:171


Multi

Ƭ Multi: { x: number | string | Date | null ; y: number | string | Date | null } | { x: number | string | Date | null } | { y: number | string | Date | null }

Defined in

core/types.ts:173


NormalizedMulti

Ƭ NormalizedMulti: { x: number ; y: number } | { x: number } | { y: number }

Defined in

core/types.ts:185


Label

Ƭ Label: string | number | Date

Defined in

core/types.ts:201


AllSeriesTypes

Ƭ AllSeriesTypes: FlatSeries | (Series | SeriesObject)[]

Defined in

core/types.ts:203


Series

Ƭ Series<T>: SeriesValue<T>[]

Type parameters

NameType
TSeriesPrimitiveValue

Defined in

core/types.ts:214


SeriesValue

Ƭ SeriesValue<T>: SeriesObjectValue<T> | T

Type parameters

NameType
TSeriesPrimitiveValue

Defined in

core/types.ts:223


SeriesPrimitiveValue

Ƭ SeriesPrimitiveValue: number | string | boolean | Date | Multi | null | undefined

Defined in

core/types.ts:225


FlatSeries

Ƭ FlatSeries<T>: FlatSeriesValue<T>[]

Type parameters

NameType
TFlatSeriesPrimitiveValue

Defined in

core/types.ts:243


FlatSeriesValue

Ƭ FlatSeriesValue<T>: SeriesValue<T> | FlatSeriesObjectValue<T>

Type parameters

NameType
TFlatSeriesPrimitiveValue

Defined in

core/types.ts:245


FlatSeriesPrimitiveValue

Ƭ FlatSeriesPrimitiveValue: number | string | null | undefined

Defined in

core/types.ts:249


AllNormalizedSeriesTypes

Ƭ AllNormalizedSeriesTypes: NormalizedFlatSeries | NormalizedSeries[]

Defined in

core/types.ts:262


NormalizedSeries

Ƭ NormalizedSeries: NormalizedSeriesValue[]

Defined in

core/types.ts:277


NormalizedSeriesValue

Ƭ NormalizedSeriesValue: NormalizedSeriesPrimitiveValue

Defined in

core/types.ts:279


NormalizedSeriesPrimitiveValue

Ƭ NormalizedSeriesPrimitiveValue: number | NormalizedMulti | undefined

Defined in

core/types.ts:281


NormalizedFlatSeries

Ƭ NormalizedFlatSeries: number[]

Defined in

core/types.ts:290


AxesDrawEvent

Ƭ AxesDrawEvent: GridDrawEvent | GridBackgroundDrawEvent | LabelDrawEvent

Defined in

core/types.ts:360


EventListener

Ƭ EventListener<T>: (data: T) => void

Type parameters

NameType
Tany

Type declaration

▸ (data): void

Parameters
NameType
dataT
Returns

void

Defined in

event/EventEmitter.ts:2


AllEventsListener

Ƭ AllEventsListener<T>: (event: string, data: T) => void

Type parameters

NameType
Tany

Type declaration

▸ (event, data): void

Parameters
NameType
eventstring
dataT
Returns

void

Defined in

event/EventEmitter.ts:4


MoveParams

Ƭ MoveParams: BasePathParams

Defined in

svg/types.ts:10


LineParams

Ƭ LineParams: BasePathParams

Defined in

svg/types.ts:12


PathParams

Ƭ PathParams: MoveParams | LineParams | CurveParams | ArcParams

Defined in

svg/types.ts:29


PathCommand

Ƭ PathCommand<T>: { command: string ; data?: SegmentData } & T

Type parameters

NameType
Textends PathParams = PathParams

Defined in

svg/types.ts:31


Attributes

Ƭ Attributes: Record<string, number | string | undefined | null>

Defined in

svg/types.ts:40


FilterByKey

Ƭ FilterByKey<T, K>: T extends Record<K, unknown> ? T : T extends Partial<Record<K, unknown>> ? T & { [key in K]: T[K] } : never

Type parameters

NameType
TT
Kextends string

Defined in

utils/types.ts:1


RequiredKeys

Ƭ RequiredKeys<T, K, V>: T & Required<Pick<T, K | V>> & { [key in V]: Required<T[V]> }

Type parameters

NameType
TT
Kextends keyof T
Vextends keyof T = never

Defined in

utils/types.ts:7

Functions

getSeriesOption

getSeriesOption<T>(series, options, key): LineChartOptionsWithDefaults[T]

Type parameters

NameType
Textends "width" | "height" | "axisX" | "axisY" | "showLine" | "showPoint" | "areaBase" | "lineSmooth" | "chartPadding" | "classNames" | "showArea" | "showGridBackground" | "fullWidth" | "reverseData" | "low" | "high" | "referenceValue" | "plugins"

Parameters

NameType
seriesSeries<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>
optionsLineChartOptionsWithDefaults
keyT

Returns

LineChartOptionsWithDefaults[T]

Defined in

charts/LineChart/LineChart.ts:32


determineAnchorPosition

determineAnchorPosition(center, label, direction): AnchorPosition

Parameters

NameType
centerDot
labelDot
directionLabelDirection

Returns

AnchorPosition

Defined in

charts/PieChart/PieChart.ts:79


createSvg

createSvg(container, width?, height?, className?): Svg

Parameters

NameTypeDefault valueDescription
containerElementundefined
widthstring | number'100%'
heightstring | number'100%'
className?stringundefined

Returns

Svg

Defined in

core/creation.ts:24


normalizePadding

normalizePadding(padding): Object

Parameters

NameType
paddingundefined | number | Partial<ChartPadding>

Returns

Object

NameType
topnumber
rightnumber
bottomnumber
leftnumber

Defined in

core/creation.ts:63


createChartRect

createChartRect(svg, options): Object

Parameters

NameTypeDescription
svgSvg
optionsOptions<AxisOptions, AxisOptions>

Returns

Object

NameType
x1number
x2number
y1number
y2number
padding{ top: number = padding; right: number = padding; bottom: number = padding; left: number = padding }
padding.topnumber
padding.rightnumber
padding.bottomnumber
padding.leftnumber
width() => number
height() => number

Defined in

core/creation.ts:89


createGrid

createGrid(position, index, axis, offset, length, group, classes, eventEmitter): void

Parameters

NameType
positionnumber
indexnumber
axisAxis
offsetnumber
lengthnumber
groupSvg
classesstring[]
eventEmitterEventEmitter

Returns

void

Defined in

core/creation.ts:168


createGridBackground

createGridBackground(gridGroup, chartRect, className, eventEmitter): void

Parameters

NameType
gridGroupSvg
chartRectChartRect
classNamestring
eventEmitterEventEmitter

Returns

void

Defined in

core/creation.ts:201


createLabel

createLabel(position, length, index, label, axis, axisOffset, labelOffset, group, classes, eventEmitter): void

Parameters

NameType
positionnumber
lengthnumber
indexnumber
labelLabel
axisAxis
axisOffsetnumber
labelOffsetObject
labelOffset.xnumber
labelOffset.ynumber
groupSvg
classesstring[]
eventEmitterEventEmitter

Returns

void

Defined in

core/creation.ts:230


getBounds

getBounds(axisLength, highLow, scaleMinSpace, onlyInteger?): Bounds

Parameters

NameTypeDefault valueDescription
axisLengthnumberundefined
highLowObjectundefined
highLow.highnumberundefined-
highLow.lownumberundefined-
scaleMinSpacenumberundefined
onlyIntegerbooleanfalse

Returns

Bounds

Defined in

core/data/bounds.ts:18


getMetaData

getMetaData(seriesData, index): any

Parameters

NameType
seriesDataFlatSeriesValue<FlatSeriesPrimitiveValue> | Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>
indexnumber

Returns

any

Defined in

core/data/data.ts:13


isDataHoleValue

isDataHoleValue(value): value is undefined | null

Parameters

NameType
valueunknown

Returns

value is undefined | null

Defined in

core/data/data.ts:29


isArrayOfSeries

isArrayOfSeries(value): value is (Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[]

Parameters

NameType
valueunknown

Returns

value is (Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[]

Defined in

core/data/data.ts:41


isMultiValue

isMultiValue(value): value is Multi

Parameters

NameType
valueunknown

Returns

value is Multi

Defined in

core/data/data.ts:53


getMultiValue

getMultiValue(value, dimension?): undefined | number

Parameters

NameTypeDefault value
valueunknownundefined
dimensionAxisName'y'

Returns

undefined | number

Defined in

core/data/data.ts:64


getHighLow

getHighLow(data, options, dimension?): Object

Parameters

NameTypeDescription
dataNormalizedSeries[]
optionsOptions<AxisOptions, AxisOptions>
dimension?AxisName

Returns

Object

NameType
highnumber
lownumber

Defined in

core/data/highLow.ts:17


normalizeData

normalizeData(data, reverse?, multi?): NormalizedData<NormalizedFlatSeries>

Parameters

NameTypeDescription
dataData<FlatSeries<FlatSeriesPrimitiveValue>>
reverse?boolean-
multi?false-

Returns

NormalizedData<NormalizedFlatSeries>

Defined in

core/data/normalize.ts:27

normalizeData(data, reverse, multi): NormalizedData<NormalizedSeries[]>

Parameters

NameType
dataData<(Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[]>
reverseundefined | boolean
multitrue | AxisName

Returns

NormalizedData<NormalizedSeries[]>

Defined in

core/data/normalize.ts:32

normalizeData(data, reverse, multi, distributed): NormalizedData<NormalizedSeries[]>

Parameters

NameType
dataData<(Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[] | FlatSeries<FlatSeriesPrimitiveValue>>
reverseundefined | boolean
multiboolean | AxisName
distributedtrue

Returns

NormalizedData<NormalizedSeries[]>

Defined in

core/data/normalize.ts:37

normalizeData(data, reverse?, multi?): NormalizedData<NormalizedFlatSeries | NormalizedSeries[]>

Parameters

NameType
dataData<(Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[] | FlatSeries<FlatSeriesPrimitiveValue>>
reverse?boolean
multi?boolean | AxisName

Returns

NormalizedData<NormalizedFlatSeries | NormalizedSeries[]>

Defined in

core/data/normalize.ts:43


splitIntoSegments

splitIntoSegments(pathCoordinates, valueData, options?): Segment[]

Parameters

NameTypeDescription
pathCoordinatesnumber[]
valueDataSegmentData[]
options?Object
options.increasingX?boolean-
options.fillHoles?boolean-

Returns

Segment[]

Defined in

core/data/segments.ts:27


serialize

serialize(data): string

Parameters

NameType
datastring | number | object

Returns

string

Defined in

core/data/serialize.ts:7

serialize(data): string | null | undefined

Parameters

NameType
dataunknown

Returns

string | null | undefined

Defined in

core/data/serialize.ts:8


deserialize

deserialize<T>(data): T

Type parameters

NameType
Textends string | number | object = object

Parameters

NameType
datastring

Returns

T

Defined in

core/data/serialize.ts:35

deserialize<T>(data): T | null | undefined

Type parameters

NameType
Textends string | number | object = object

Parameters

NameType
dataundefined | null | string

Returns

T | null | undefined

Defined in

core/data/serialize.ts:38


ensureUnit

ensureUnit<T>(value, unit): string | T

Type parameters

Name
T

Parameters

NameType
valueT
unitstring

Returns

string | T

Defined in

core/lang.ts:5


quantity

quantity<T>(input): { value: number ; unit: undefined | string } | { unit: undefined ; value: number }

Type parameters

Name
T

Parameters

NameType
inputT

Returns

{ value: number ; unit: undefined | string } | { unit: undefined ; value: number }

Defined in

core/lang.ts:17


alphaNumerate

alphaNumerate(n): string

Parameters

NameTypeDescription
nnumber

Returns

string

Defined in

core/lang.ts:36


orderOfMagnitude

orderOfMagnitude(value): number

Parameters

NameTypeDescription
valuenumber

Returns

number

Defined in

core/math.ts:11


projectLength

projectLength(axisLength, length, bounds): number

Parameters

NameTypeDescription
axisLengthnumber
lengthnumber
boundsBounds

Returns

number

Defined in

core/math.ts:22


roundWithPrecision

roundWithPrecision(value, digits?): number

Parameters

NameTypeDescription
valuenumber
digits?number-

Returns

number

Defined in

core/math.ts:36


rho

rho(num): number

Parameters

NameTypeDescription
numnumber

Returns

number

Defined in

core/math.ts:46


polarToCartesian

polarToCartesian(centerX, centerY, radius, angleInDegrees): Object

Parameters

NameTypeDescription
centerXnumber
centerYnumber
radiusnumber
angleInDegreesnumber

Returns

Object

NameType
xnumber
ynumber

Defined in

core/math.ts:88


optionsProvider

optionsProvider<T>(options, responsiveOptions, eventEmitter): OptionsProvider<T>

Type parameters

NameType
Tunknown

Parameters

NameTypeDescription
optionsT
responsiveOptionsundefined | ResponsiveOptions<T>
eventEmitterEventEmitter

Returns

OptionsProvider<T>

Defined in

core/optionsProvider.ts:17


extend

extend<T>(target): T

Type parameters

Name
T

Parameters

NameTypeDescription
targetT

Returns

T

Defined in

utils/extend.ts:7

extend<T, A>(target, a): T & A

Type parameters

Name
T
A

Parameters

NameType
targetT
aA

Returns

T & A

Defined in

utils/extend.ts:8

extend<T, A, B>(target, a, b): T & A & B

Type parameters

Name
T
A
B

Parameters

NameType
targetT
aA
bB

Returns

T & A & B

Defined in

utils/extend.ts:9


noop

noop<T>(n): T

Type parameters

Name
T

Parameters

NameTypeDescription
nT

Returns

T

Defined in

utils/functional.ts:6


times

times(length): undefined[]

Parameters

NameType
lengthnumber

Returns

undefined[]

Defined in

utils/functional.ts:11

times<T>(length, filler): T[]

Type parameters

NameType
Tunknown

Parameters

NameType
lengthnumber
filler(index: number) => T

Returns

T[]

Defined in

utils/functional.ts:12


sum

sum(previous, current): number

Parameters

NameType
previousnumber
currentnumber

Returns

number

Defined in

utils/functional.ts:26


serialMap

serialMap<T, K>(array, callback): K[]

Type parameters

Name
T
K

Parameters

NameType
arrayT[][]
callback(...args: T[]) => K

Returns

K[]

Defined in

utils/functional.ts:43


safeHasProperty

safeHasProperty<T, K>(target, property): target is FilterByKey<T, K>

Type parameters

NameType
TT
Kextends string

Parameters

NameTypeDescription
targetT
propertyK

Returns

target is FilterByKey<T, K>

Defined in

utils/utils.ts:9


isNumeric

isNumeric(value): true

Parameters

NameType
valuenumber

Returns

true

Defined in

utils/utils.ts:24

isNumeric(value): boolean

Parameters

NameType
valueunknown

Returns

boolean

Defined in

utils/utils.ts:25


isFalseyButZero

isFalseyButZero(value): value is undefined | null | false | ""

Parameters

NameType
valueunknown

Returns

value is undefined | null | false | ""

Defined in

utils/utils.ts:33


getNumberOrUndefined

getNumberOrUndefined(value): number

Parameters

NameType
valuenumber

Returns

number

Defined in

utils/utils.ts:42

getNumberOrUndefined(value): number | undefined

Parameters

NameType
valueunknown

Returns

number | undefined

Defined in

utils/utils.ts:43


isArrayOfArrays

isArrayOfArrays(data): data is unknown[][]

Parameters

NameType
dataunknown

Returns

data is unknown[][]

Defined in

utils/utils.ts:51


each

each<T>(list, callback, reverse?): void

Type parameters

Name
T

Parameters

NameTypeDefault value
listT[]undefined
callback(item: T, index: number, itemIndex: number) => voidundefined
reversebooleanfalse

Returns

void

Defined in

utils/utils.ts:62