chartist
Classes
- AutoScaleAxis
- Axis
- FixedScaleAxis
- StepAxis
- BarChart
- BaseChart
- LineChart
- PieChart
- EventEmitter
- Svg
- SvgList
- SvgPath
Interfaces
- BarChartOptions
- BarDrawEvent
- LineChartOptions
- PointDrawEvent
- LineDrawEvent
- AreaDrawEvent
- Dot
- PieChartOptions
- SliceDrawEvent
- SliceLabelDrawEvent
- BaseChartEventsTypes
- OptionsProvider
- ChartPadding
- ChartRect
- Options
- AxisOptions
- Bounds
- Segment
- SegmentData
- Data
- SeriesObject
- SeriesObjectValue
- FlatSeriesObjectValue
- NormalizedData
- CreatedEvent
- DrawEvent
- DataEvent
- OptionsChangedEvent
- GridDrawEvent
- GridBackgroundDrawEvent
- LabelDrawEvent
- BasePathParams
- CurveParams
- ArcParams
- SvgPathOptions
- AnimationDefinition
- AnimationEvent
Namespaces
Variables
axisUnits
• Const
axisUnits: Object
Type declaration
Name | Type |
---|---|
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
namespaces
• Const
namespaces: Record
<string
, string
>
Defined in
precision
• Const
precision: 8
Defined in
escapingMap
• Const
escapingMap: Record
<string
, string
>
Defined in
EPSILON
• Const
EPSILON: 2.221e-16
Defined in
easings
• Const
easings: Object
Type declaration
Name | Type |
---|---|
easeInSine | number [] |
easeOutSine | number [] |
easeInOutSine | number [] |
easeInQuad | number [] |
easeOutQuad | number [] |
easeInOutQuad | number [] |
easeInCubic | number [] |
easeOutCubic | number [] |
easeInOutCubic | number [] |
easeInQuart | number [] |
easeOutQuart | number [] |
easeInOutQuart | number [] |
easeInQuint | number [] |
easeOutQuint | number [] |
easeInOutQuint | number [] |
easeInExpo | number [] |
easeOutExpo | number [] |
easeInOutExpo | number [] |
easeInCirc | number [] |
easeOutCirc | number [] |
easeInOutCirc | number [] |
easeInBack | number [] |
easeOutBack | number [] |
easeInOutBack | number [] |
Defined in
Type Aliases
XAxisUnits
Ƭ XAxisUnits: typeof x
Defined in
YAxisUnits
Ƭ YAxisUnits: typeof y
Defined in
AxisUnits
Ƭ AxisUnits: XAxisUnits
| YAxisUnits
Defined in
AxisType
Ƭ AxisType: typeof AutoScaleAxis
| typeof FixedScaleAxis
| typeof StepAxis
Defined in
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
Name | Type |
---|---|
pathCoordinates | number [] |
valueData | SegmentData [] |
Returns
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
Name | Type |
---|---|
chart | any |
options? | any |
Returns
void
Defined in
Meta
Ƭ Meta: any
Defined in
OptionsWithDefaults
Ƭ OptionsWithDefaults: RequiredKeys
<Options
<RequiredKeys
<AxisOptions
, "offset"
| "labelOffset"
| "labelInterpolationFnc"
>, RequiredKeys
<AxisOptions
, "offset"
| "labelOffset"
| "labelInterpolationFnc"
>>, "axisX"
| "axisY"
| "classNames"
>
Defined in
ResponsiveOptions
Ƭ ResponsiveOptions<T
>: [string
, T
][]
Type parameters
Name | Type |
---|---|
T | Options |
Defined in
AxisName
Ƭ AxisName: "x"
| "y"
Defined in
Multi
Ƭ Multi: { x
: number
| string
| Date
| null
; y
: number
| string
| Date
| null
} | { x
: number
| string
| Date
| null
} | { y
: number
| string
| Date
| null
}
Defined in
NormalizedMulti
Ƭ NormalizedMulti: { x
: number
; y
: number
} | { x
: number
} | { y
: number
}
Defined in
Label
Ƭ Label: string
| number
| Date
Defined in
AllSeriesTypes
Ƭ AllSeriesTypes: FlatSeries
| (Series
| SeriesObject
)[]
Defined in
Series
Ƭ Series<T
>: SeriesValue
<T
>[]
Type parameters
Name | Type |
---|---|
T | SeriesPrimitiveValue |
Defined in
SeriesValue
Ƭ SeriesValue<T
>: SeriesObjectValue
<T
> | T
Type parameters
Name | Type |
---|---|
T | SeriesPrimitiveValue |
Defined in
SeriesPrimitiveValue
Ƭ SeriesPrimitiveValue: number
| string
| boolean
| Date
| Multi
| null
| undefined
Defined in
FlatSeries
Ƭ FlatSeries<T
>: FlatSeriesValue
<T
>[]
Type parameters
Name | Type |
---|---|
T | FlatSeriesPrimitiveValue |
Defined in
FlatSeriesValue
Ƭ FlatSeriesValue<T
>: SeriesValue
<T
> | FlatSeriesObjectValue
<T
>
Type parameters
Name | Type |
---|---|
T | FlatSeriesPrimitiveValue |
Defined in
FlatSeriesPrimitiveValue
Ƭ FlatSeriesPrimitiveValue: number
| string
| null
| undefined
Defined in
AllNormalizedSeriesTypes
Ƭ AllNormalizedSeriesTypes: NormalizedFlatSeries
| NormalizedSeries
[]
Defined in
NormalizedSeries
Ƭ NormalizedSeries: NormalizedSeriesValue
[]
Defined in
NormalizedSeriesValue
Ƭ NormalizedSeriesValue: NormalizedSeriesPrimitiveValue
Defined in
NormalizedSeriesPrimitiveValue
Ƭ NormalizedSeriesPrimitiveValue: number
| NormalizedMulti
| undefined
Defined in
NormalizedFlatSeries
Ƭ NormalizedFlatSeries: number
[]
Defined in
AxesDrawEvent
Ƭ AxesDrawEvent: GridDrawEvent
| GridBackgroundDrawEvent
| LabelDrawEvent
Defined in
EventListener
Ƭ EventListener<T
>: (data
: T
) => void
Type parameters
Name | Type |
---|---|
T | any |
Type declaration
▸ (data
): void
Parameters
Name | Type |
---|---|
data | T |
Returns
void
Defined in
AllEventsListener
Ƭ AllEventsListener<T
>: (event
: string
, data
: T
) => void
Type parameters
Name | Type |
---|---|
T | any |
Type declaration
▸ (event
, data
): void
Parameters
Name | Type |
---|---|
event | string |
data | T |
Returns
void
Defined in
MoveParams
Ƭ MoveParams: BasePathParams
Defined in
LineParams
Ƭ LineParams: BasePathParams
Defined in
PathParams
Ƭ PathParams: MoveParams
| LineParams
| CurveParams
| ArcParams
Defined in
PathCommand
Ƭ PathCommand<T
>: { command
: string
; data?
: SegmentData
} & T
Type parameters
Name | Type |
---|---|
T | extends PathParams = PathParams |
Defined in
Attributes
Ƭ Attributes: Record
<string
, number
| string
| undefined
| null
>
Defined in
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
Name | Type |
---|---|
T | T |
K | extends string |
Defined in
RequiredKeys
Ƭ RequiredKeys<T
, K
, V
>: T
& Required
<Pick
<T
, K
| V
>> & { [key in V]: Required<T[V]> }
Type parameters
Name | Type |
---|---|
T | T |
K | extends keyof T |
V | extends keyof T = never |
Defined in
Functions
getSeriesOption
▸ getSeriesOption<T
>(series
, options
, key
): LineChartOptionsWithDefaults
[T
]
Type parameters
Name | Type |
---|---|
T | extends "width" | "height" | "axisX" | "axisY" | "showLine" | "showPoint" | "areaBase" | "lineSmooth" | "chartPadding" | "classNames" | "showArea" | "showGridBackground" | "fullWidth" | "reverseData" | "low" | "high" | "referenceValue" | "plugins" |
Parameters
Name | Type |
---|---|
series | Series <SeriesPrimitiveValue > | SeriesObject <SeriesPrimitiveValue > |
options | LineChartOptionsWithDefaults |
key | T |
Returns
LineChartOptionsWithDefaults
[T
]
Defined in
charts/LineChart/LineChart.ts:32
determineAnchorPosition
▸ determineAnchorPosition(center
, label
, direction
): AnchorPosition
Parameters
Name | Type |
---|---|
center | Dot |
label | Dot |
direction | LabelDirection |
Returns
Defined in
charts/PieChart/PieChart.ts:79
createSvg
▸ createSvg(container
, width?
, height?
, className?
): Svg
Parameters
Name | Type | Default value | Description |
---|---|---|---|
container | Element | undefined | |
width | string | number | '100%' | |
height | string | number | '100%' | |
className? | string | undefined |
Returns
Defined in
normalizePadding
▸ normalizePadding(padding
): Object
Parameters
Name | Type |
---|---|
padding | undefined | number | Partial <ChartPadding > |
Returns
Object
Name | Type |
---|---|
top | number |
right | number |
bottom | number |
left | number |
Defined in
createChartRect
▸ createChartRect(svg
, options
): Object
Parameters
Name | Type | Description |
---|---|---|
svg | Svg | |
options | Options <AxisOptions , AxisOptions > |
Returns
Object
Name | Type |
---|---|
x1 | number |
x2 | number |
y1 | number |
y2 | number |
padding | { top : number = padding; right : number = padding; bottom : number = padding; left : number = padding } |
padding.top | number |
padding.right | number |
padding.bottom | number |
padding.left | number |
width | () => number |
height | () => number |
Defined in
createGrid
▸ createGrid(position
, index
, axis
, offset
, length
, group
, classes
, eventEmitter
): void
Parameters
Name | Type |
---|---|
position | number |
index | number |
axis | Axis |
offset | number |
length | number |
group | Svg |
classes | string [] |
eventEmitter | EventEmitter |
Returns
void
Defined in
createGridBackground
▸ createGridBackground(gridGroup
, chartRect
, className
, eventEmitter
): void
Parameters
Name | Type |
---|---|
gridGroup | Svg |
chartRect | ChartRect |
className | string |
eventEmitter | EventEmitter |
Returns
void
Defined in
createLabel
▸ createLabel(position
, length
, index
, label
, axis
, axisOffset
, labelOffset
, group
, classes
, eventEmitter
): void
Parameters
Name | Type |
---|---|
position | number |
length | number |
index | number |
label | Label |
axis | Axis |
axisOffset | number |
labelOffset | Object |
labelOffset.x | number |
labelOffset.y | number |
group | Svg |
classes | string [] |
eventEmitter | EventEmitter |
Returns
void
Defined in
getBounds
▸ getBounds(axisLength
, highLow
, scaleMinSpace
, onlyInteger?
): Bounds
Parameters
Name | Type | Default value | Description |
---|---|---|---|
axisLength | number | undefined | |
highLow | Object | undefined | |
highLow.high | number | undefined | - |
highLow.low | number | undefined | - |
scaleMinSpace | number | undefined | |
onlyInteger | boolean | false |
Returns
Defined in
getMetaData
▸ getMetaData(seriesData
, index
): any
Parameters
Name | Type |
---|---|
seriesData | FlatSeriesValue <FlatSeriesPrimitiveValue > | Series <SeriesPrimitiveValue > | SeriesObject <SeriesPrimitiveValue > |
index | number |
Returns
any
Defined in
isDataHoleValue
▸ isDataHoleValue(value
): value is undefined | null
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is undefined | null
Defined in
isArrayOfSeries
▸ isArrayOfSeries(value
): value is (Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[]
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is (Series<SeriesPrimitiveValue> | SeriesObject<SeriesPrimitiveValue>)[]
Defined in
isMultiValue
▸ isMultiValue(value
): value is Multi
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is Multi
Defined in
getMultiValue
▸ getMultiValue(value
, dimension?
): undefined
| number
Parameters
Name | Type | Default value |
---|---|---|
value | unknown | undefined |
dimension | AxisName | 'y' |
Returns
undefined
| number
Defined in
getHighLow
▸ getHighLow(data
, options
, dimension?
): Object
Parameters
Name | Type | Description |
---|---|---|
data | NormalizedSeries [] | |
options | Options <AxisOptions , AxisOptions > | |
dimension? | AxisName |
Returns
Object
Name | Type |
---|---|
high | number |
low | number |
Defined in
normalizeData
▸ normalizeData(data
, reverse?
, multi?
): NormalizedData
<NormalizedFlatSeries
>
Parameters
Name | Type | Description |
---|---|---|
data | Data <FlatSeries <FlatSeriesPrimitiveValue >> | |
reverse? | boolean | - |
multi? | false | - |
Returns
NormalizedData
<NormalizedFlatSeries
>
Defined in
▸ normalizeData(data
, reverse
, multi
): NormalizedData
<NormalizedSeries
[]>
Parameters
Name | Type |
---|---|
data | Data <(Series <SeriesPrimitiveValue > | SeriesObject <SeriesPrimitiveValue >)[]> |
reverse | undefined | boolean |
multi | true | AxisName |
Returns
NormalizedData
<NormalizedSeries
[]>
Defined in
▸ normalizeData(data
, reverse
, multi
, distributed
): NormalizedData
<NormalizedSeries
[]>
Parameters
Name | Type |
---|---|
data | Data <(Series <SeriesPrimitiveValue > | SeriesObject <SeriesPrimitiveValue >)[] | FlatSeries <FlatSeriesPrimitiveValue >> |
reverse | undefined | boolean |
multi | boolean | AxisName |
distributed | true |
Returns
NormalizedData
<NormalizedSeries
[]>
Defined in
▸ normalizeData(data
, reverse?
, multi?
): NormalizedData
<NormalizedFlatSeries
| NormalizedSeries
[]>
Parameters
Name | Type |
---|---|
data | Data <(Series <SeriesPrimitiveValue > | SeriesObject <SeriesPrimitiveValue >)[] | FlatSeries <FlatSeriesPrimitiveValue >> |
reverse? | boolean |
multi? | boolean | AxisName |
Returns
NormalizedData
<NormalizedFlatSeries
| NormalizedSeries
[]>
Defined in
splitIntoSegments
▸ splitIntoSegments(pathCoordinates
, valueData
, options?
): Segment
[]
Parameters
Name | Type | Description |
---|---|---|
pathCoordinates | number [] | |
valueData | SegmentData [] | |
options? | Object | |
options.increasingX? | boolean | - |
options.fillHoles? | boolean | - |
Returns
Segment
[]
Defined in
serialize
▸ serialize(data
): string
Parameters
Name | Type |
---|---|
data | string | number | object |
Returns
string
Defined in
▸ serialize(data
): string
| null
| undefined
Parameters
Name | Type |
---|---|
data | unknown |
Returns
string
| null
| undefined
Defined in
deserialize
▸ deserialize<T
>(data
): T
Type parameters
Name | Type |
---|---|
T | extends string | number | object = object |
Parameters
Name | Type |
---|---|
data | string |
Returns
T
Defined in
▸ deserialize<T
>(data
): T
| null
| undefined
Type parameters
Name | Type |
---|---|
T | extends string | number | object = object |
Parameters
Name | Type |
---|---|
data | undefined | null | string |
Returns
T
| null
| undefined
Defined in
ensureUnit
▸ ensureUnit<T
>(value
, unit
): string
| T
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
value | T |
unit | string |
Returns
string
| T
Defined in
quantity
▸ quantity<T
>(input
): { value
: number
; unit
: undefined
| string
} | { unit
: undefined
; value
: number
}
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
input | T |
Returns
{ value
: number
; unit
: undefined
| string
} | { unit
: undefined
; value
: number
}
Defined in
alphaNumerate
▸ alphaNumerate(n
): string
Parameters
Name | Type | Description |
---|---|---|
n | number |
Returns
string
Defined in
orderOfMagnitude
▸ orderOfMagnitude(value
): number
Parameters
Name | Type | Description |
---|---|---|
value | number |
Returns
number
Defined in
projectLength
▸ projectLength(axisLength
, length
, bounds
): number
Parameters
Name | Type | Description |
---|---|---|
axisLength | number | |
length | number | |
bounds | Bounds |
Returns
number
Defined in
roundWithPrecision
▸ roundWithPrecision(value
, digits?
): number
Parameters
Name | Type | Description |
---|---|---|
value | number | |
digits? | number | - |
Returns
number
Defined in
rho
▸ rho(num
): number
Parameters
Name | Type | Description |
---|---|---|
num | number |
Returns
number
Defined in
polarToCartesian
▸ polarToCartesian(centerX
, centerY
, radius
, angleInDegrees
): Object
Parameters
Name | Type | Description |
---|---|---|
centerX | number | |
centerY | number | |
radius | number | |
angleInDegrees | number |
Returns
Object
Name | Type |
---|---|
x | number |
y | number |
Defined in
optionsProvider
▸ optionsProvider<T
>(options
, responsiveOptions
, eventEmitter
): OptionsProvider
<T
>
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type | Description |
---|---|---|
options | T | |
responsiveOptions | undefined | ResponsiveOptions <T > | |
eventEmitter | EventEmitter |
Returns
Defined in
extend
▸ extend<T
>(target
): T
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
target | T |
Returns
T
Defined in
▸ extend<T
, A
>(target
, a
): T
& A
Type parameters
Name |
---|
T |
A |
Parameters
Name | Type |
---|---|
target | T |
a | A |
Returns
T
& A
Defined in
▸ extend<T
, A
, B
>(target
, a
, b
): T
& A
& B
Type parameters
Name |
---|
T |
A |
B |
Parameters
Name | Type |
---|---|
target | T |
a | A |
b | B |
Returns
T
& A
& B
Defined in
noop
▸ noop<T
>(n
): T
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
n | T |
Returns
T
Defined in
times
▸ times(length
): undefined
[]
Parameters
Name | Type |
---|---|
length | number |
Returns
undefined
[]
Defined in
▸ times<T
>(length
, filler
): T
[]
Type parameters
Name | Type |
---|---|
T | unknown |
Parameters
Name | Type |
---|---|
length | number |
filler | (index : number ) => T |
Returns
T
[]
Defined in
sum
▸ sum(previous
, current
): number
Parameters
Name | Type |
---|---|
previous | number |
current | number |
Returns
number
Defined in
serialMap
▸ serialMap<T
, K
>(array
, callback
): K
[]
Type parameters
Name |
---|
T |
K |
Parameters
Name | Type |
---|---|
array | T [][] |
callback | (...args : T []) => K |
Returns
K
[]
Defined in
safeHasProperty
▸ safeHasProperty<T
, K
>(target
, property
): target is FilterByKey<T, K>
Type parameters
Name | Type |
---|---|
T | T |
K | extends string |
Parameters
Name | Type | Description |
---|---|---|
target | T | |
property | K |
Returns
target is FilterByKey<T, K>
Defined in
isNumeric
▸ isNumeric(value
): true
Parameters
Name | Type |
---|---|
value | number |
Returns
true
Defined in
▸ isNumeric(value
): boolean
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
isFalseyButZero
▸ isFalseyButZero(value
): value is undefined | null | false | ""
Parameters
Name | Type |
---|---|
value | unknown |
Returns
value is undefined | null | false | ""
Defined in
getNumberOrUndefined
▸ getNumberOrUndefined(value
): number
Parameters
Name | Type |
---|---|
value | number |
Returns
number
Defined in
▸ getNumberOrUndefined(value
): number
| undefined
Parameters
Name | Type |
---|---|
value | unknown |
Returns
number
| undefined
Defined in
isArrayOfArrays
▸ isArrayOfArrays(data
): data is unknown[][]
Parameters
Name | Type |
---|---|
data | unknown |
Returns
data is unknown[][]
Defined in
each
▸ each<T
>(list
, callback
, reverse?
): void
Type parameters
Name |
---|
T |
Parameters
Name | Type | Default value |
---|---|---|
list | T [] | undefined |
callback | (item : T , index : number , itemIndex : number ) => void | undefined |
reverse | boolean | false |
Returns
void