Comments (20)
For everyone else looking into this issue, by now ApexCharts has bundled their typescript files in the official repo.
The folder is types/apexcharts.d.ts
from apexcharts.js.
Hey guys, I've extended a bit the interface kindly posted by @jimfilippou , however I am still unsure about which are the required fields. Hope it helps!
export enum ChartHorizontalAlign {
left = 'left',
center = 'center',
right = 'right'
}
export enum ChartVerticalAlign {
top = 'top',
middle = 'middle',
bottom = 'bottom'
}
export enum ChartTypes {
line = 'line',
area = 'area',
bar = 'bar',
histogram = 'histogram',
pie = 'pie',
donut = 'donut',
radialBar = 'radialBar',
scatter = 'scatter',
bubble = 'bubble',
heatmap = 'heatmap'
}
export enum ChartShape {
circle = 'circle',
square = 'square'
}
export enum ChartPosition {
top = 'top',
right = 'right',
bottom = 'bottom',
left = 'left'
}
export enum ChartCurve {
smooth = 'smooth',
straight = 'straight'
}
export interface ChartLegend {
show?: true;
position?: ChartPosition;
horizontalAlign?: ChartHorizontalAlign;
verticalAlign?: ChartVerticalAlign;
floating?: boolean;
fontSize?: string;
offsetX?: number;
offsetY?: number;
formatter?: any;
textAnchor?: string;
labels?: {
foreColor?: string;
useSeriesColors?: boolean;
};
markers?: {
size?: number;
strokeColor?: string;
strokeWidth?: number;
offsetX?: number;
offsetY?: number;
radius?: number;
shape?: ChartShape;
};
itemMargin?: {
horizontal?: number;
vertical?: number
};
containerMargin?: {
left?: number;
top?: number;
};
onItemClick?: {
toggleDataSeries?: boolean;
};
onItemHover?: {
highlightDataSeries?: boolean;
};
}
export interface ChartConfig {
height?: number;
type?: ChartTypes;
shadow?: {
enabled?: boolean;
color?: string;
top?: number;
left?: number;
blur?: number;
opacity?: number
};
zoom?: {
enabled?: boolean
};
}
export interface ChartSerie {
name?: string;
data?: number[];
}
export interface ChartRow {
colors?: string[];
opacity?: number;
}
export interface Chart {
chart?: ChartConfig;
colors?: string[];
stroke?: {
curve?: ChartCurve;
};
series?: ChartSerie[];
title?: {
text?: string;
align?: ChartHorizontalAlign;
};
grid?: {
borderColor?: string;
row?: ChartRow;
};
markers?: {
size?: number;
colors?: string[];
strokeColor?: string;
strokeWidth?: number;
strokeOpacity?: number;
fillOpacity?: number;
shape?: ChartShape;
radius?: number;
offsetX?: number;
offsetY?: number;
hover?: {
size?: number
}
};
xaxis?: {
categories?: string[];
title?: {
text?: string;
}
};
yaxis?: {
title?: {
text?: string;
};
min?: number;
max?: number;
};
legend?: ChartLegend;
}
from apexcharts.js.
I'm waiting for @types/apexcharts to come out, but here is a temporary solution
export interface ApexOptions {
chart: {
width?: string | number;
height?: string | number;
type: string;
foreColor?: string;
};
plotOptions?: {
radialBar?: {
offsetY?: number;
startAngle?: number;
endAngle?: number;
hollow?: {
margin: number;
size: string;
background: string;
image: string | undefined,
},
track?: {
show: boolean
},
dataLabels?: {
showOn?: string;
name?: {
show: boolean,
},
value?: {
show: boolean,
}
}
};
circle?: {
track?: {
show: boolean
},
dataLabels: {
showOn?: string;
name?: {
show: boolean,
},
value?: {
show: boolean,
}
}
};
pie?: {
size?: undefined,
donut?: {
size?: string;
background?: string;
},
customScale?: number;
offsetX?: number;
offsetY?: number;
dataLabels?: {
offset?: number;
}
}
};
colors?: string[];
series: number[];
labels?: string[];
legend?: {
show?: boolean;
floating?: boolean;
fontSize?: string;
position?: string;
verticalAlign?: string;
textAnchor?: string;
labels?: {
useSeriesColors: boolean
};
markers?: {
size: number
};
formatter?: Function;
itemMargin?: {
vertical: number;
};
containerMargin?: {
left: number;
top: number;
}
};
}
from apexcharts.js.
react-apexcharts, as well as vue-apexcharts, also has their own types.
Thanks to all the people who contributed to the typescript support for ApexCharts.
from apexcharts.js.
@junedchhipa I could help with this. We definitely need typescript support to be able to create angular bindings.
from apexcharts.js.
thanks everyone, I'm gathering all of these and hopefully could send a draft PR to @types
repo today or tomorrow.
from apexcharts.js.
I think it is simpler to embed types directly in the repository instead of publishing them to the @types organisation. See: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html . As an example, Vue.js does it like this, with an entry in the package.json
file and a types
directory. Doing it this way allow types to always track the source code.
from apexcharts.js.
Following on @mark-langer's comment, here's a direct link:
from apexcharts.js.
Hi everyone finally I have a few hours working on this. Options are copied from the options refs on docs page, then converted to json when pasting the js object to a json file and run prettier. then I used json to ts vscode extension to convert json to ts typings.
quick note: I used type
instead of interface
so when you hover the type in vscode, it will show the literal typings instead of the type name.
Still a WIP, hope I could find sometimes work on it tomorrow or next week.
DefinitelyTyped/DefinitelyTyped#28733
from apexcharts.js.
@sandangel has started working. Visit this issue on Issuehunt
from apexcharts.js.
@Micene09 I agree that Typescript comes with a lot of advantages, but porting the whole project from JS to TS will be extremely tedious if not challenging looking at the size of the current codebase.
I have got some more contributions in the typings and I will publish soon directly in the repository.
Thanks for the suggestion.
from apexcharts.js.
@BoostIO funded this issue with $30. Visit this issue on Issuehunt
from apexcharts.js.
@cstlaurent brilliant, thanks!
from apexcharts.js.
@cstlaurent Good to know. I was worried about how the types will be synced with the core options.
If anyone finishes the first version of the types, I'm happy to accept a PR
from apexcharts.js.
@junedchhipa the only way i see is to (slowly and carefully) port the whole project to Typescript.
The first and simplest thing you can do is to rename *.js to *.ts, then configure the build settings in webpack.config.js .
After that every compilation error was fixed (...i'm sure you will have to), you can try to implement that interface from @e4r and only when everything is working, again, we will get the typings implicitly (using just compilation options).
In my opinion, you should not accept any PR with just the typings...because the risk to unsync the options is too high.
You should consider the Typescript porting a big improvement, not only for typings, but for every future implementation.
from apexcharts.js.
amazing thanks @junedchhipa! anything else we can do to help this?
from apexcharts.js.
@katiesandford Sure, maybe you can validate the typescript declarations to make sure they work correctly?
from apexcharts.js.
I have added the initial typescript declarations which cover most of the options.
If anyone finds anything missing or not in sync with the options listed here - https://apexcharts.com/docs/options/ feel free to add them
from apexcharts.js.
Hi All,
Thanks for great work here. react-apexcharts is an amazing library and hope it will support typescript soon.
from apexcharts.js.
@rororofff has funded $2.00 to this issue.
- Submit pull request via IssueHunt to receive this reward.
- Want to contribute? Chip in to this issue via IssueHunt.
- Checkout the IssueHunt Issue Explorer to see more funded issues.
- Need help from developers? Add your repository on IssueHunt to raise funds.
from apexcharts.js.
Related Issues (20)
- When there are more than 2 charts on the page, xaxis type datetime uses the appendData method to append data, the charts display consistent data.
- Weird animation on stacked bar with rounded corners HOT 1
- RangeArea chart yaxis min value always returns 5e-234 regardless of series values
- Empty tooltip is shown for null values HOT 1
- Tooltip not show zero values on Line Chart HOT 3
- Horizontal box plot with outliers? HOT 1
- Horizontal box plot with outliers HOT 1
- Ability to StackOnlyArea and be able to overly other line values HOT 2
- Weird behaviour of the area chart with datetime xaxis HOT 2
- Issue with CSV data when using Boxplot chart with Scatter Point
- Change position of label in chart treemap HOT 2
- tooltip dates misaligned with x-axis
- Missing documentation for tickAmount property on a datetime axis when formatter function is specified
- When programmatically changing the chart type, some default styles from original chart blend into subsequent charts
- Goal indicators should not be cut / overflow when they are at the maximum value of the axis
- 2 series doesn't work in Logarithmic scale. HOT 1
- dropShadow in a multi-series chart applies dropShadow to other series after hovering
- Website/React: Link line-chart-with-annotations leads to a 404
- Add border radius option for Treemap
- Total data labels in stacked grouped bars should be per group
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from apexcharts.js.