highcharts / highcharts-declarations-beta

Beta for Highcharts TypeScript declarations

Highcharts JS is a JavaScript charting library based on SVG and some canvas/WebGL.

• Official website: www.highcharts.com
• Download page: www.highcharts.com/download
• Licensing: shop.highcharts.com
• Support: www.highcharts.com/support
• Issues: Repo guidelines

Highcharts is a source available product. Please refer to shop.highcharts.com for details on licensing.

Installing and using Highcharts

This is the working repo for Highcharts code. If you simply want to include Highcharts into a project, use the distribution package instead, or read the download page.

Please note that there are several ways to use Highcharts. For general installation instructions, see the docs.

Use our CDN

Instead of downloading, you can use our CDN to access files directly. See code.highcharts.com for details.

<script src="https://code.highcharts.com/highcharts.js"></script>

Install from npm

See npm documentation on how to get started with npm.

npm install --save highcharts

ES6 modules, AMD, CommonJS and others

For other ways to use Highcharts in your projects, please refer to our installation docs.

Create your own custom build of Highcharts

To reduce file size, or combine modules into one file to reduce latency, you may want to create your own build of the Highcharts modules. See Creating custom Highcharts files for more information.

Build and debug

If you want to do modifications to Highcharts or fix issues, you may build your own files. Highcharts uses Gulp as the build system. After npm install in the root folder, run gulp, which will set up a watch task for the JavaScript and CSS files. Now any changes in the files of the /js or /css folders will result in new files being built and saved in the code folder. Other tasks are also available, like gulp lint.

npm install
gulp

Node setup for Apple Mx CPU

When running Node natively on ARM64 MacOS, some Node packages like node-canvas with integrated compiling might fail. Install additional tools to resolve the problem:

• Homebrew and run brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman

Generate API docs

Run in this highcharts repository the doc generator with npx gulp jsdoc-watch, which also starts a new server with the generated API documentation.

highcharts-declarations-beta's Issues

Index property for PlotMfiParamsOptions is not excluded

Exclude tag is not recognized properly by the generator.

ExportingButtonsOptions needs to allow custom buttons

It's possible to define custom context buttons in ExportingButtonsOptions the definition probably ought to change to something like:

export interface ExportingButtonsOptions {
    contextButton?: ExportingButtonsContextButtonOptions;
    [contextButtonName: string]: ExportingButtonsContextButtonOptions
}

Cannot find module 'highcharts' after installing, Type is not assignable to type issues

I am using VSCode. So I uninstalled @types/highcharts and replaced it with this. No errors for the most part, except the fact that for whatever reason, I am having import issues. import * as Highcharts from 'highcharts'; is giving me:

Cannot find module 'highcharts'

I am having no luck trying to fix this. I have cleared cache, updated to Highcharts 6.2 then installed the highcharts-declarations-beta again, tried to use import { Highcharts } from 'highcharts' and still no luck.

What am I doing wrong?

Literal types need enum for easier usage

Take options' literal types automatically in enums for easier usage.

Highcharts param fn has wrong type in map function

I guess there is a mistake in the map function as the return type of the param fn is now set to type void.

Because without types i was able to return a value and now it's complaining

this.chartOptions = {
      colors: Highcharts.map(this.colors, function(color) {
        return {
          radialGradient: {
            cx: 0.5,
            cy: 0.8,
            r: 0.9
          },
          stops: [
            [0, color],
            [1, color.brighten(-0.35).get('rgb')] // darken
          ]
        };
      }),
};

Cannot install typings when using bower

Hi,

Having previously been using the sophiebremer/highcharts-declarations-alpha declarations, since the move to the highcharts/highcharts-declarations-beta and deletion of the old repository we can no longer install the declarations file while using bower to install highcharts v6.

This was possible with the previous set of declarations, and highcharts is available via bower. Please can you make the beta declarations available when using bower?

Many thanks,

Fill color options support GradientColorObject and PatternObject

Add GradientColorObject and PatternObject in addition to ColorString.

showLoading optional parameter

showLoading() parameter is optional, yet it is required in the typings.

Clarify callback event options

• Create callback interfaces with parameters.
• Create interfaces for the context object this.

Incorrect type signatures

• Axis.update, Tooltip.update, SubtitleObject.update, and TitleObject.update are missing the redraw parameter
• options parameter in addEvent should be optional and order parameter should be removed
• e: Event parameter should be optional in Chart.reflow

ExportingButtonsContextButtonOptions needs expansion to include menuItems defined as objects

Currently the menuItems type is "Array", but it can also be "Array" according to documentation (and my current use case). Docs

The workaround right now is to use menuItemDefinitions and refer to the label instead of doing it inline, but it'd be nice to extend this out.

series.data types are incomplete

• Sometimes named categories (first string in simple point array) is missing

ChartEventsOptions Selection is missing the parameter

ChartEventsOptions - selection is missing the SelectEventObject parameter and return type of boolean

selection?: (e: SelectEventObject) => boolean;

Basic series properties missing description during autocomplete

SeriesOptions.name, SeriesOptions.index, SeriesOptions.type and others should have description during autocomplete.

Axis needs to support both a single object and array of objects

The API supports both object as well as array of objects.

xAxis?: XAxisOptions | XAxisOptions[];
yAxis?: YAxisOptions | YAxisOptions[];

Review issues in the DefinitelyTyped project

https://github.com/DefinitelyTyped/DefinitelyTyped/issues?q=is%3Aissue+highcharts

Date objects are no valid type for series.data

There are some series allowing Date objects, even though it is not supported. Valid are timestamps (numbers) instead.

Typing for xAxis.labels.formatter

As per https://api.highcharts.com/highcharts/xAxis.labels.formatter the formatter function makes use of a differently scoped this variable.

Not sure if there is a fix for this other than to change highcharts itself to introduce a function parameter?

SeriesPointDropEventObject used by namespace but not moved into namespace

SeriesPointDropEventObject should be part of highcharts.d.ts

Unexpected functions in global scope

Unexpected functions in global scope:

/**
 * Animate the arrow up from startAngle
 */
export function animate(): void;
/**
 * Animate the arrow up from startAngle
 */
export function animate(): void;
/**
 * Extend the basic drawDataLabels method by running it for both lower and
 * higher values.
 */
export function drawDataLabels(): void;
/**
 * The graph is initially drawn with an empty definition, then updated with
 * crisp rendering.
 */
export function drawGraph(): void;
/**
 * Draw the points where each point is one needle
 */
export function drawPoints(): void;
/**
 * After generating points, set y-values for all sums.
 */
export function generatePoints(): void;
/**
 * Get the width and X offset, either on top of the linked series column or
 * standalone
 */
export function getColumnMetrics(): void;
/**
 * Draw columns' connector lines
 */
export function getCrispPath(): void;
/**
 * Extremes for a non-stacked series are recorded in processData. In case of
 * stacking, use Series.stackedYData to calculate extremes.
 */
export function getExtremes(): void;
/**
 * Extend the line series' getSegmentPath method by applying the segment path to
 * both lower and higher values of the range.
 */
export function getGraphPath(): void;
/**
 * Get the radius for each point based on the minSize, maxSize and each point's
 * Z value. This must be done prior to Series.translate because the axis needs
 * to add padding in accordance with the point sizes.
 */
export function getRadii(): void;
/**
 * Get the radius for each point based on the minSize, maxSize and each point's
 * Z value. This must be done prior to Series.translate because the axis needs
 * to add padding in accordance with the point sizes.
 */
export function getRadii(): void;
/**
 * Translate a point's plotHigh from the internal angle and radius measures to
 * true plotHigh coordinates. This is an addition of the toXY method found in
 * Polar.js, because it runs too early for arearanges to be considered (#3419).
 */
export function highToXY(): void;
/**
 * Pass the null test in ColumnSeries.translate.
 */
export function isValid(): void;
/**
 * Postprocess mapping between options and SVG attributes
 */
export function pointAttribs(): void;
/**
 * Call default processData then override yData to reflect waterfall's extremes
 * on yAxis
 */
export function processData(): void;
/**
 * Extend the basic setData method by running processData and generatePoints
 * immediately, in order to access the points from the legend.
 */
export function setData(): void;
/**
 * Waterfall has stacking along the x-values too.
 */
export function setStackedPoints(): void;
/**
 * Don't do any hover colors or anything
 */
export function setState(): void;
/**
 * Return y value or string if point is sum
 */
export function toYData(): void;
/**
 * Translate data points from raw values x and y to plotX and plotY.
 */
export function translate(): void;
/**
 * Translate data points from raw values x and y to plotX and plotY.
 */
export function translate(): void;