Skip to content

dotnet-websharper/highcharts

Repository files navigation

WebSharper.Highcharts

Highcharts is a JavaScript charting library, which can produce interactive HTML5 charts from a config object. Highstock is an extension of Highcharts adding more chart types geared for stock price visualization. Highmaps creates interactive map charts with drilldown feature.

The WebSharper bindings for Highcharts provide a strongly typed interface to to the configuration object and helper functions. These are automatically generated from the official API documentation, see the full list of settings there. Similar API documentation for Highstock and Highmaps is also available.

The simplest way to define a chart with HighCharts in a WebSharper Web.Control class:

Div [] |>! OnAfterRender (fun el ->
    Highcharts.Create(JQuery.Of el.Body,
        HighchartsCfg(
            // config properties
        )
    )

Sometimes a config property can accept multiple types, for example an array instead of a config object. In these cases, use WebSharper's As helper function to cast it to the required type. As this cast is erased from the resulting JavaScript code, the library works as intended.

Npm setup

Include the highcharts npm package in your web project.

Licensing

For using Highcharts for any public product, aquire a license from https://shop.highcharts.com/ or for non-profits apply for a Educational/Personal license https://www.highcharts.com/blog/education/

About

HighCharts for WebSharper

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 6

Languages