swi

SwiftChart

Line and area chart library for iOS

Showing:

Popularity

Downloads/wk

0

GitHub Stars

979

Maintenance

Last Commit

3yrs ago

Contributors

19

Package

Dependencies

0

License

MIT

Categories

Readme

SwiftChart

Version License Platform

A simple line and area charting library for iOS.

  • 📈 Line and area charts
  • 🌞 Multiple series
  • 🌒 Partially filled series
  • 🏊 Works with signed Double
  • 🖖 Touch events


Table of Content

Getting started

Installing SwiftChart via CocoaPods

SwiftChart is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "SwiftChart"

Installing SwiftChart manually

  1. Download SwiftChart.zip from the last release and extract its content in your project's folder.
  2. From the Xcode project, choose Add Files to ... from the File menu and add the extracted files.

What’s included in SwiftChart

The library includes:

  • the Chart main class, to initialize and configure the chart’s content, e.g. for adding series or setting up the its appearance
  • the ChartSeries class, for creating datasets and configure their appearance
  • the ChartDelegate protocol, which tells other objects about the chart’s touch events
  • the ChartColor struct, containing some predefined colors

Example

let chart = Chart()
let series = ChartSeries([0, 6, 2, 8, 4, 7, 3, 10, 8])
series.color = ChartColors.greenColor()
chart.add(series)

To run the example project, clone the repo, and run pod install from the Example directory first.

How to use SwiftChart

Initialize a chart from the Interface Builder

The chart can be initialized from the Interface Builder. Drag a normal View into a View Controller and assign to it the Chart Custom Class from the Identity Inspector.

Initialize a chart programmatically

To initialize a chart programmatically, use the Chart(frame: ...) initializer, which requires a frame:

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))

If you prefer to use Autolayout, set the frame to 0 and add the constraints later:

let chart = Chart(frame: CGRectZero)
// add constraints now

Adding a series to a chart

Initialize each series before adding them to the chart. To do so, pass an array to initialize a ChartSeries object:

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))
let series = ChartSeries([0, 6.5, 2, 8, 4.1, 7, -3.1, 10, 8])
chart.add(series)

Result:

As you can see, as default the values on the x-axis are the progressive indexes of the passed array. You can customize those values by passing an array of (x: Double, y: Double) tuples to the series initializer:

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))
// Create a new series specifying x and y values
let data = [
  (x: 0, y: 0),
  (x: 1, y: 3.1),
  (x: 4, y: 2),
  (x: 5, y: 4.2),
  (x: 7, y: 5),
  (x: 9, y: 9),
  (x: 10, y: 8)
]
let series = ChartSeries(data: data)
chart.add(series)

Result:

Using partially filled series

Use the chart.xLabels property to make the x-axis showing more labels than those inferred from the actual data. For example,

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))
let data = [
  (x: 0, y: 0),
  (x: 3, y: 2.5),
  (x: 4, y: 2),
  (x: 5, y: 2.3),
  (x: 7, y: 3),
  (x: 8, y: 2.2),
  (x: 9, y: 2.5)
]
let series = ChartSeries(data: data)
series.area = true

// Use `xLabels` to add more labels, even if empty
chart.xLabels = [0, 3, 6, 9, 12, 15, 18, 21, 24]

// Format the labels with a unit
chart.xLabelsFormatter = { String(Int(round($1))) + "h" }

chart.add(series)

Result:

Using different colors above and below zero

The chart displays the series in different colors when below or above the zero-axis:

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))
let data: [Double] = [0, -2, -2, 3, -3, 4, 1, 0, -1]

let series = ChartSeries(data)
series.area = true

chart.add(series)

// Set minimum and maximum values for y-axis
chart.minY = -7
chart.maxY = 7

// Format y-axis, e.g. with units
chart.yLabelsFormatter = { String(Int($1)) +  "ºC" }

Result:

You can customize the zero-axis and the colors with the colors options in the ChartSeries class.

series.colors = (
  above: ChartColors.greenColor(),
  below: ChartColors.yellowColor(),
  zeroLevel: -1
)

Result:

Adding multiple series to a chart

Using the chart.add(series: ChartSeries) and chart.add(series: Array<ChartSeries>) methods you can add more series. Those will be indentified with a progressive index in the chart’s series property.

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))

let series1 = ChartSeries([0, 6, 2, 8, 4, 7, 3, 10, 8])
series1.color = ChartColors.yellowColor()
series1.area = true

let series2 = ChartSeries([1, 0, 0.5, 0.2, 0, 1, 0.8, 0.3, 1])
series2.color = ChartColors.redColor()
series2.area = true

// A partially filled series
let series3 = ChartSeries([9, 8, 10, 8.5, 9.5, 10])
series3.color = ChartColors.purpleColor()

chart.add([series1, series2, series3])

Result:

screen shot 2018-01-07 at 11 06 55

Configuring touch events

To make the chart respond to touch events, implement the ChartDelegate protocol in your class, e.g. a View Controller, and then set the chart’s delegate property:

class MyViewController: UIViewController, ChartDelegate {
  override func viewDidLoad() {
    let chart = Chart(frame: CGRect(x: 0, y: 0, width: 100, height: 200))
    chart.delegate = self
  }

  // Chart delegate
  func didTouchChart(chart: Chart, indexes: Array<Int?>, x: Double, left: CGFloat) {
    // Do something on touch
  }

  func didFinishTouchingChart(chart: Chart) {
    // Do something when finished
  }

  func didEndTouchingChart(chart: Chart) {
    // Do something when ending touching chart
  }
}

The didTouchChart method passes an array of indexes, one for each series, with an optional Int referring to the data’s index:

 func didTouchChart(chart: Chart, indexes: Array<Int?>, x: Double, left: CGFloat) {
    for (seriesIndex, dataIndex) in enumerate(indexes) {
      if dataIndex != nil {
        // The series at `seriesIndex` is that which has been touched
        let value = chart.valueForSeries(seriesIndex, atIndex: dataIndex)
      }
    }
  }

You can use chart.valueForSeries() to access the value for the touched position.

The x: Double argument refers to the value on the x-axis: it is inferred from the horizontal position of the touch event, and may be not part of the series values.

The left: CGFloat is the x position on the chart’s view, starting from the left side. It may be used to set the position for a label moving above the chart:

API

Chart class

Use the Chart class to initialize and configure the chart’s content, e.g. for adding series or setting up the its appearance.

Example

let chart = Chart(frame: CGRect(x: 0, y: 0, width: 200, height: 100))

Chart options

Option NameDescription
areaAlphaComponentAlpha factor for the areas colors (CGFloat, default 0.1)
axesColorThe color of the axes (UIColor, default .gray)
bottomInsetHeight of the area at the bottom of the chart, containing the labels for the x-axis (CGFloat, default 20)
delegateThe delegate to listen to touch events (ChartDelegate)
highlightLineColorThe color of the highlight line (UIColor, default gray)
highlightLineWidthThe width of the highlight line (CGFloat, default 0.5)
hideHighlightLineOnTouchEndHide the highlight line when the touch event ends, e.g. when stop swiping over the chart (Bool, default false)
gridColorThe color of the grid (UIColor, default .gray)
labelColorThe color of the labels (UIColor, default .black)
labelFontThe font used for the labels (UIFont?)
lineWidthThe width of the chart's lines (CGFloat, default 2)
maxXA custom maximum x-value (Double?)
maxYA custom maximum y-value (Double?)
minXA custom minimum x-value (Double?)
minYA custom minimum y-value (Double?)
showXLabelsAndGridEnable the lines for the labels on the x-axis (Bool, default true)
showYLabelsAndGridEnable the lines for the labels on the y-axis (Bool, default true)
topInsetHeight of the area at the top of the chart, acting a padding to make place for the top y-axis label (CGFloat, default 20)
xLabelsThe values to display as labels on the x-axis. You can format these values with the xLabelFormatter attribute. As default, it will display the values of the series which has the most data. [Double]?
xLabelsFormatterFunction to format the labels on the x-axis ((Int, Double) -> String)
xLabelsOrientation:Set the x-axis labels orientation to vertical or horizontal (ChartLabelOrientation, default .horizontal)
xLabelsTextAlignment:Alignment for the text in the x-labels (NSTextAlignment, default .left)
xLabelsSkipLast:Skip the last x-label. Setting this to false will make the label overflow the frame width, so use carefully (Bool, default true)
yLabelsValues to display as labels of the y-axis. If not specified, will display the lowest, the middle and the highest values.
yLabelsFormatterFunction to format the labels on the y-axis ((Int, Double) -> String)
yLabelsOnRightSidePlace the y-labels on the right side (Bool, default false)

Public Methods

Method NameDescription
addAdd a series to the chart (_ series: ChartSeries) (_ series: [ChartSeries])
removeSeriesAtRemove the series at the specified index (_ index: Int)
removeAllSeriesRemove all the series
valueForSeriesReturns the value for the specified series at the given index (_ seriesIndex: Int, atIndex dataIndex: Int?) -> Double?

ChartSeries class

Use the ChartSeries class to create a chart series and configure its appearance and behavior.

Example

let data: [Double] = [0, -2, -2, 3, -3, 4, 1, 0, -1]
let series = ChartSeries(data)
Option NameDescription
areaDraws an area below the series line (Bool, default false)
lineWhen set to false, will hide the series line. Useful for drawing only the area with area=true (Bool, default true)
colorThe series color. You can use the ChartColors struct for some colors shortcuts. (UIColor, default .blueColor())
colorsA tuple to specify the color above or below the zero (or the value specified by zeroLevel) (above: UIColor, below: UIColor, zeroLevel: Double)

ChartDelegate protocol

Use the ChartDelegate protocol to tell other objects about the chart’s touch events.

MethodDescription
didTouchChartTells the delegate that the specified chart has been touched
didFinishTouchingChartTells the delegate that the user finished touching the chart. The user will "finish" touching the chart only swiping left/right outside the chart.
didEndTouchingChartTells the delegate that the user ended touching the chart. The user will "end" touching the chart whenever the touchesDidEnd method is being called.

ChartColors enum

Shorthands for various colors.

Example

let series = ChartSeries([0, 6, 2, 8, 4, 7, 3, 10, 8])
series.color = ChartColors.blueColor()

Common issues and solutions

If you have issue with this library, please tag your question with swiftchart on Stack Overflow.

The chart is not showing

The Chart class inherits from UIView, so if your chart is not displaying it is likely a problem related to the view's size. Check your view constraints and make sure you initialize it on viewDidLoad, when UIKit can calculate the view dimensions.

Some tips for debugging an hidden chart:

  • start your app and then debug the UI Hierarchy from the Debug navigator
  • initialize a simple UIView with a colored background instead of the chart to easily see how the view is positioned
  • try to not to nest the chart in a subview for better debugging

License

SwiftChart is available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100