Upgrading vue-chartjs 3 to 4
Unknown3.5.1 → 4.1.2New2Fixed8Other1
Fetching 11 releases from GitHub…10 / 11
UnknownUpgrade verdict
DepDelta is still reading the notes for 1 of 11 releases, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
No longer states a Node.js requirement from 4.0.0 (was >=6.9.0).
Drops @types/chart.js.
Installs 0 packages in all (was 2).
API changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
class Bar extends BaseChart - removed:
class Bubble extends BaseChart - removed:
class Doughnut extends BaseChart - removed:
class HorizontalBar extends BaseChart - removed:
class Line extends BaseChart - removed:
class Pie extends BaseChart - removed:
class PolarArea extends BaseChart - removed:
class Radar extends BaseChart - removed:
class Scatter extends BaseChart - removed:
const mixins: { reactiveData: typeof ReactiveDataMixin; reactiveProp: typeof ReactivePropMixin } - removed:
function generateChart(chartId: string, chartType: string): any
- added:
const Bar: TypedChartComponent<'bar', number[], unknown> - added:
const Bubble: TypedChartComponent<'bubble', import('chart.js').BubbleDataPoint[], unknown> - added:
const Doughnut: TypedChartComponent<'doughnut', number[], unknown> - added:
const Line: TypedChartComponent<'line', (number | import('chart.js').ScatterDataPoint | null)[], unknown> - added:
const Pie: TypedChartComponent<'pie', number[], unknown> - added:
const PolarArea: TypedChartComponent<'polarArea', number[], unknown> - added:
const Radar: TypedChartComponent<'radar', (number | null)[], unknown> - added:
const Scatter: TypedChartComponent<'scatter', (number | import('chart.js').ScatterDataPoint | null)[], unknown> - added:
const _default: { Bar: TypedChartComponent<'bar', number[], unknown>; Doughnut: TypedChartComponent<'doughnut', number[], unknown>; Line: TypedChartComponent<'line', (number |… - added:
const generateChart: <TType extends keyof import('chart.js').ChartTypeRegistry = keyof import('chart.js').ChartTypeRegistry, TData = import('chart.js/types/utils').DistributiveArra… - added:
default _default
- added:
export * from './BaseCharts'
- added:
interface IChartComponentData<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown> - added:
interface IChartProps<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown> - added:
property IChartComponentData._chart: ShallowRef<TypedChartJS<TType, TData, TLabel> | null> - added:
property IChartComponentData.canvasEl: Ref<HTMLCanvasElement | null> - added:
property IChartComponentData.chartDataHandler: (newValue: TChartData<TType, TData, TLabel>, oldValue: TChartData<TType, TData, TLabel>) => void - added:
property IChartComponentData.renderChart: (data: TChartData<TType, TData, TLabel>, options: TChartOptions<TType>) => void - added:
property IChartProps.chartData: TChartData<TType, TData, TLabel> - added:
property IChartProps.chartId?: string - added:
property IChartProps.chartOptions?: TChartOptions<TType> - added:
property IChartProps.cssClasses?: string - added:
property IChartProps.datasetIdKey?: string - added:
property IChartProps.height?: number - added:
property IChartProps.plugins?: Plugin<TType>[] - added:
property IChartProps.styles?: Partial<CSSStyleDeclaration> - added:
property IChartProps.width?: number - added:
type TChartData<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown> = ChartData<TType, TData, TLabel> - added:
type TChartOptions<TType extends ChartType> = ChartOptions<TType> - added:
type TypedChartComponent<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown> = DefineComponent<IChartProps<TType, TData, TLabel>, IChartComponentData<TType, TData, TLabel>, unknown, ComputedOptions, MethodOptions, ComponentOptionsMixin, C… - added:
type TypedChartEmits = { [ChartEmits.ChartRendered]: () => true; [ChartEmits.ChartUpdated]: () => true; [ChartEmits.ChartDestroyed]: () => true; [ChartEmits.LabelsUpdated]: () => tru… - added:
type TypedChartJS<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown> = ChartJS<TType, TData, TLabel>
- added:
const chartUpdateError = 'Update ERROR: chart instance not found' - added:
const templateError = 'Please remove the <template></template> tags from your chart component. See https://vue-chartjs.org/guide/#vue-single-file-components' - added:
enum ChartEmits - added:
function chartCreate<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(createChartFunction: (data: TChartData<TType, TData, TLabel>, options: TChartOptions<TType>) => void, chartData: TChartData<TType, TData, TLabel>, chartOptions: TChartOptions<TType>, context?: SetupContext): void - added:
function chartDestroy<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(chart: TypedChartJS<TType, TData, TLabel>, context?: SetupContext): void - added:
function chartUpdate<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(chart: TypedChartJS<TType, TData, TLabel>, context?: SetupContext): void - added:
function compareData<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(newData: TChartData<TType, TData, TLabel>, oldData: TChartData<TType, TData, TLabel>): boolean - added:
function getChartData<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(data: TChartData<TType, TData, TLabel>, datasetIdKey: string): TChartData<TType, TData, TLabel> - added:
function setChartDatasets<TType extends ChartType = ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(oldData: TChartData<TType, TData, TLabel>, newData: TChartData<TType, TData, TLabel>, datasetIdKey: string): void - added:
function setChartLabels<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(chart: TypedChartJS<TType, TData, TLabel>, labels: TLabel[] | undefined, context?: SetupContext): void - added:
function setChartOptions<TType extends ChartType, TData = DefaultDataPoint<TType>, TLabel = unknown>(chart: TypedChartJS<TType, TData, TLabel>, options: TChartOptions<TType>): void - added:
member ChartEmits.ChartDestroyed = 'chart:destroyed' - added:
member ChartEmits.ChartRendered = 'chart:rendered' - added:
member ChartEmits.ChartUpdated = 'chart:updated' - added:
member ChartEmits.LabelsUpdated = 'labels:updated'
- added:
const Bar: any - added:
const Bubble: any - added:
const Doughnut: any - added:
const Line: any - added:
const Pie: any - added:
const PolarArea: any - added:
const Radar: any - added:
const Scatter: any - added:
function generateChart(chartId: any, chartType: any, chartController: any): { props: { chartData: { type: ObjectConstructor; required: boolean }; chartOptions: { type: ObjectConstructor; default: () => void }; datasetIdKey: { type: StringConstructor; default: string }; chartId: { type: StringConstructor; default: any }; width: { type: NumberConstructor; default: number }; height: { type: NumberCo…
- removed:
class BaseChart extends Vue - removed:
method BaseChart.addPlugin (plugin?: object): void - removed:
method BaseChart.renderChart (chartData: Chart.ChartData, options?: Chart.ChartOptions): void
- removed:
declare module 'vue-chartjs'
- removed:
class ReactiveDataMixin extends Vue - removed:
class ReactivePropMixin extends Vue - removed:
property ReactiveDataMixin.chartData: Chart.ChartData - removed:
readonly property ReactivePropMixin.chartData: Chart.ChartData