Skip to content

Add VisualElement extension to Flow element type definition #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kurkle merged 1 commit into from
Sep 1, 2022
Merged

Add VisualElement extension to Flow element type definition #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions types/index.esm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ import {
ChartComponent,
DatasetController,
Element,
VisualElement,
FontSpec
} from 'chart.js';
import { AnyObject } from 'chart.js/types/basic';

declare module 'chart.js' {

Expand Down Expand Up @@ -78,36 +80,40 @@ declare module 'chart.js' {
datasetOptions: SankeyControllerDatasetOptions;
defaultDataPoint: SankeyDataPoint;
parsedDataType: SankeyParsedData;
metaExtensions:{}
metaExtensions: AnyObject
/* TODO: define sankey chart options */
chartOptions: any;
chartOptions: AnyObject;
scales: keyof CartesianScaleTypeRegistry;
};
}
}

type FlowOptions = {
export interface FlowOptions {
colorMode: 'gradient' | 'from' | 'to';
colorFrom: string
colorTo: string
}

type FlowConfig = {
export interface FlowConfig {
x: number;
y: number;
x2: number;
y2: number;
height: number;
options: FlowOptions
};
}

export type SankeyController = DatasetController
export const SankeyController: ChartComponent & {
prototype: SankeyController;
new(chart: Chart, datasetIndex: number): SankeyController;
};

export type Flow = Element<FlowConfig, FlowOptions>
export interface Flow<
T extends FlowConfig = FlowConfig,
O extends FlowOptions = FlowOptions
> extends Element<T, O>, VisualElement {}

export const Flow: ChartComponent & {
prototype: Flow;
new(cfg: FlowConfig): Flow;
Expand Down