https://github.com/dotnet-websharper/highcharts

HighCharts for WebSharper
https://github.com/dotnet-websharper/highcharts

Last synced: 7 days ago
JSON representation

HighCharts for WebSharper

• Host: GitHub
• URL: https://github.com/dotnet-websharper/highcharts
• Owner: dotnet-websharper
• License: apache-2.0
• Created: 2018-08-06T15:40:12.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T10:58:44.000Z (3 months ago)
• Last Synced: 2024-08-16T12:13:18.317Z (3 months ago)
• Language: F#
• Homepage: https://websharper.com
• Size: 652 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-websharper - Highcharts - Interactive charts. Includes Highstock for financial data and timeline charts, and Highmaps for interactive map charts. (Libraries / JavaScript library bindings)

README

        
# WebSharper.Highcharts

[Highcharts][hc] 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][hcapi], see the full list

of settings there. Similar API documentation for [Highstock][hsapi] and 

[Highmaps][hmapi] 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.

## Resources

If you want to use Highcharts only, use this line on your `JavaScript` annotated code or `Web.Config` class. 

```

open IntelliFactory.WebSharper.Highcharts

[)>]

```

Highstock contains Highcharts, so just add `Resources.Highstock` instead and this will

enable using the Highcharts functions too.

Highmaps is available as an extension to either Highcharts or Highstock.

Use one of these lines to get the correct extension module:

```

[)>]

[)>]

```

[hc]: http://www.highcharts.com/

[hcapi]: http://api.highcharts.com/highcharts

[hsapi]: http://api.highcharts.com/highstock

[hmapi]: http://api.highcharts.com/highmaps