Skip to content

Sparkline

Defined in: charts/extra.ts:598

Minimal axis-less inline chart, designed for tight spaces (table cells, KPIs).

Example

import { Sparkline } from '@arshad-shah/swift-chart';
const chart = new Sparkline('#chart', { theme: 'midnight' });
chart.setData([12, 14, 13, 18, 22, 20, 26]);

Extends

Constructors

Constructor

new Sparkline(container, config?): Sparkline

Defined in: charts/extra.ts:607

Parameters

container

string | HTMLElement

config?

any = {}

Returns

Sparkline

Overrides

BaseChart.constructor

Properties

animator

animator: Animator

Defined in: core/base.ts:34

Inherited from

BaseChart.animator


animProgress

animProgress: number = 1

Defined in: core/base.ts:37

Inherited from

BaseChart.animProgress


canvas

canvas: HTMLCanvasElement

Defined in: core/base.ts:31

Inherited from

BaseChart.canvas


config

config: object & Required<Pick<BaseChartConfig, "title" | "animate" | "animDuration" | "animEasing" | "responsive" | "showGrid" | "showTooltip" | "showLegend" | "legendPosition" | "subtitle">> & BaseChartConfig

Defined in: charts/extra.ts:599

Type Declaration

color?

optional color?: string

filled?

optional filled?: boolean

Overrides

BaseChart.config


container

container: HTMLElement

Defined in: core/base.ts:22

Inherited from

BaseChart.container


ctx

ctx: CanvasRenderingContext2D

Defined in: core/base.ts:32

Inherited from

BaseChart.ctx


height

height: number = 0

Defined in: core/base.ts:40

Inherited from

BaseChart.height


hoverIndex

hoverIndex: number = -1

Defined in: core/base.ts:36

Inherited from

BaseChart.hoverIndex


padding

padding: Padding

Defined in: core/base.ts:41

Inherited from

BaseChart.padding


resolved

resolved: ResolvedData

Defined in: core/base.ts:38

Inherited from

BaseChart.resolved


theme

theme: Theme

Defined in: core/base.ts:33

Inherited from

BaseChart.theme


tooltip

tooltip: Tooltip | null

Defined in: core/base.ts:35

Inherited from

BaseChart.tooltip


width

width: number = 0

Defined in: core/base.ts:39

Inherited from

BaseChart.width

Accessors

plotArea

Get Signature

get plotArea(): PlotArea

Defined in: core/base.ts:154

Returns

PlotArea

Inherited from

BaseChart.plotArea

Methods

_draw()

_draw(): void

Defined in: charts/extra.ts:624

Returns

void

Overrides

BaseChart._draw


_onMouse()

_onMouse(_e): void

Defined in: charts/extra.ts:622

Parameters

_e

MouseEvent

Returns

void

Overrides

BaseChart._onMouse


destroy()

destroy(): void

Defined in: core/base.ts:222

Returns

void

Inherited from

BaseChart.destroy


resize()

resize(): void

Defined in: core/base.ts:212

Returns

void

Inherited from

BaseChart.resize


setData()

setData(values): void

Defined in: charts/extra.ts:615

Parameters

values

number[] | Record<string, any>[] | null | undefined

Returns

void

Overrides

BaseChart.setData


setTheme()

setTheme(name): void

Defined in: core/base.ts:181

Parameters

name

string

Returns

void

Inherited from

BaseChart.setTheme


toDataURL()

toDataURL(type?, quality?): string

Defined in: core/base.ts:218

Export the current chart as a PNG data URL.

Parameters

type?

string = 'image/png'

quality?

number = 0.92

Returns

string

Inherited from

BaseChart.toDataURL


update()

update(arg, mapping?): void

Defined in: core/base.ts:191

Polymorphic update:

  • update(dataArray, mapping?) — replaces data (alias of setData).
  • update(configPatch) — patches non-data config (theme, title, padding, etc.).

Parameters

arg

Record<string, any>[] | Partial<BaseChartConfig>

mapping?

DataMapping

Returns

void

Inherited from

BaseChart.update