Highcharts iOS is a delightful wrapper of HighchartsJS for iOS.

The most popular, robust and battle-tested JavaScript Charting library is now available for iOS with our new Objective-C wrapper. Get gorgeous, multi-touch charts with minimal effort.

Documentation

Access the full API documentation here.

HOWTO

Here we present how to create basic chart and place it in your project.

What we need to do

• Prepare your project for Highcharts
• Create chart view and place it in your view
• Create chart options and add them to your chart view
• Run your app and enjoy!

Preparing your project

• First of all download Highcharts xcframework from here: Highcharts or by using Cocoapods by adding

  pod 'Highcharts', '~> 12.0.2'
  

  to your Podfile

  or Swift Package Manager by adding package dependency

  https://github.com/highcharts/highcharts-ios
  

  or Carthage by adding

  github "https://github.com/highcharts/highcharts-ios" >= 12.0.2
  

  to your Cartfile.

• Now add Highcharts to your project by simply copying it to your project to folder Frameworks (create it if necessary) and remeber to check "Copy items if needed" option

• Click on finish

• Then go to your project settings and add Highcharts to Frameworks, Libraries, and Embedded Content with "Embed & Sign" option

• If your project is leveraging Xcode UI testing, make sure you add the Highcharts framework to Embedded Binaries for the UITests target as well as the main project target

You are now set to use Highcharts!

Using Highcharts (UIKit demo app)

Set AppDelegate

In your AppDelegate.swift import Highcharts at the top

import Highcharts

Add this line to your application:didFinishLaunchingWithOptions method:

HIChartView.preload()

Add HIChartView to your View Controller

In your View Controller.swift file add

import Highcharts

and

var chartView: HIChartView!

Creating chart

Let's start with creating simple chart!

For the purpose of this tutorial, we will create a simple column chart using random data.

In viewDidLoad add following lines

chartView = HIChartView(frame: CGRect(x: view.bounds.origin.x, y: view.bounds.origin.y  +  20, width: view.bounds.size.width, height: 300))

This will create our chartView with defined origin and size.

Done! Now let's create a chart.

The heart of a chart is HIOptions class which contains all the information needed to present it. Some of the options there are optional, some are not (see demo app HighFit provided by Highcharts).

Create instance of HIOptions class

let options = HIOptions()

Now we need to add the options that our chart requires to be presented. Let's start with chart type. To do so, create HIChart class object and set its type to "column"

let chart = HIChart()
chart.type = "column"

Add this object to your options

options.chart = chart

Then let's give our chart a name (title) and also add it to options

let title = HITitle()
title.text = "Demo chart"
options.title = title

Now we need to add some data (in this tutorial it will be some random set of numbers). Since we are creating a column chart, we need to use HIColumn data series

let series = HIColumn()

To add data, just create array of our data objects

series.data = [49.9, 71.5, 106.4, 129.2, 144, 176, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]

Since options can store multiple series, we need to add our series as one-element-array

options.series = [series]

And at last add our options to the chartView

chartView.options = options

Don't forget to add chartView as subview to your View Controller's view! At the end add

view.addSubview(chartView)

That's it! We are now set to run our application! Your View Controller.swift file should look like this

import Highcharts
import UIKit

class ViewController: UIViewController {

  var chartView: HIChartView!

  override func viewDidLoad() {
    super.viewDidLoad()
    // Do any additional setup after loading the view.

    chartView = HIChartView(frame: CGRect(x: view.bounds.origin.x,
                                          y: view.bounds.origin.y + 20,
                                          width: view.bounds.size.width,
                                          height: 300))

    let options = HIOptions()

    let chart = HIChart()
    chart.type = "column"
    options.chart = chart

    let title = HITitle()
    title.text = "Demo chart"
    options.title = title

    let series = HIColumn()
    series.data = [49.9, 71.5, 106.4, 129.2, 144, 176, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
    options.series = [series]

    chartView.options = options

    view.addSubview(chartView)
  }

}

Using Highcharts (SwiftUI demo app)

Setting up preload

In your App.swift import Highcharts at the top

import Highcharts

Add the following line to your init() or application:didFinishLaunchingWithOptions method:

HIChartView.preload()

Creating a simple SwiftUI wrapper for HIChartView

It takes a few steps:

• Create a struct conforming UIViewRepresentable;
• Define a property that stores a HIOptions configuration of the chart;
• Implement makeUIView() that will create our chart view;
• Implement updateUIView() that will update our chart view

In your code it could looks like this:

struct ChartView: UIViewRepresentable {

  var options: HIOptions

  func makeUIView(context: Context) -> HIChartView {
    let chart = HIChartView()
    chart.options = options
    return chart
  }

  func updateUIView(_ uiView: HIChartView, context: Context) {
    uiView.options = options
  }

}

That’s all! We can use now the ChartView component in SwiftUI:

import Highcharts
import SwiftUI

struct ContentView: View {

  private var chartOptions: HIOptions {
    let options = HIOptions()
    
    let chart = HIChart()
    chart.type = "column"
    options.chart = chart
    
    let title = HITitle()
    title.text = "Demo chart in SwiftUI"
    options.title = title
    
    let series = HIColumn()
    series.data = [49.9, 71.5, 106.4, 129.2, 144, 176, 135.6, 148.5, 216.4, 194.1, 95.6, 54.4]
    options.series = [series]
    
    return options
  }

  var body: some View {
    ChartView(options: chartOptions)
  }

}

Full SwiftUI demo project you can find here: HCSwiftUIDemo.

Press "Run" in XCode.

For more complex solutions see demo app HighFit provided by Highcharts or read the following documentation!

Additional info

Additional modules

In case of enabling additional module, add it to plugins of HIChartView object before assign your chart options, e.g.

chartView.plugins = ["annotations"]
...
chartView.options = options

HIColor example

Highcharts iOS wrapper provides its own colors implementation. As you can notice, some options are of HIColor type. You can instantiate the desired color in few ways which are described in the API documentation. In here, we will show the most complex case which is gradient usage. For example, you can instantiate a color for chart background:

chart.backgroundColor = HIColor(linearGradient: ["x1": 0, "x2": 0, "y1": 0, "y2": 300],
                                stops: [
                                  [0, "rgb(102, 153, 161)"],
                                  [1, "rgb(128, 135, 232)"]
                                ])

HIFunction example

Thanks to Highcharts iOS wrapper you can now assign native iOS closures to events for specific chart elements. We will show you a small taste of such usage. For these purpose we will let appear a simple alert with point coordinates when it's clicked but keep in mind that you can achieve much more with HIFunction mechanism!

First of all, you need to create a plotOptions object for your series type:

let plotOptions = HIPlotOptions()
plotOptions.series = HISeries()

Now, you can refer to the point event and add on click function like this:

plotOptions.series.point = HIPoint()
plotOptions.series.point.events = HIEvents()
    
let clickFunction = HIFunction(closure: { [weak self] context in
  guard let self = self, let context = context else { return }

  let category = context.getProperty("this.category") ?? "",
      value = context.getProperty("this.y") ?? ""

  let alertMessage = "Category: \(category), value: \(value)"

  let alertController = UIAlertController(title: nil,
                                          message: alertMessage,
                                          preferredStyle: .alert)

  let okAction = UIAlertAction(title: "OK", style: .default, handler: nil)
  alertController.addAction(okAction)

  self.present(alertController, animated: true, completion: nil)
}, properties: ["this.category", "this.y"])

plotOptions.series.point.events.click = clickFunction

options.plotOptions = plotOptions

As you can see in the above code snippet first argument of the HIFunction is the actual closure. Second argument is simple string array of chart elements. We need to put them here to let wrapper pull them for us during HIFunction instantiation. Thanks to this, we can refer to these elements corresponding values by getProperty: method. You can pull any data from chart like this. Depending on the current needs you can just run some code, withdraw data from chart, return a String to the chart (e.g. in HITooltip formatter) and even put pure Javascript function in the constructor in the String format. For more information feel free to check the API documentation.

Custom fonts

Highcharts iOS wrapper allows you to add custom fonts. If you have your own font and want to use that in your chart, follow next steps:

• Add a font file to your project. Select File -> Add Files to “Your Project Name” from the menu bar or drag and drop the file into your Xcode project, check Copy items if needed option and add the font to your app target.

• Add your font to HIChartView. To do this, firstly, you need to get an absolute path pointing to the location of the font and then call addFont: method:

let fontPath = Bundle.main.path(forResource: "Windsong", ofType: "ttf")
HIChartView.addFont(fontPath)

So, now you can use a custom font in your chart. For example, let's change the chart title font. You only need to create a style object for the title and set its font family to the font file name:

title.style = HICSSObject()
title.style.fontFamily = "Windsong"