SwiftUICharts

https://github.com/willdale/swiftuicharts
Admin
A charts and plotting library for SwiftUI, supporting macOS, iOS, watchOS, and tvOS with built-in...
Tokens:3,233
Snippets:32
Trust Score:8.1
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### SwiftUICharts Installation Import

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This code snippet shows how to import the SwiftUICharts library into your Swift project using Swift Package Manager. Ensure the package is added via File > Swift Packages > Add Package Dependency...

```swift
import SwiftUICharts
```

--------------------------------

### SwiftUI View Update with .id() Modifier

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This example demonstrates how to ensure SwiftUI views update correctly when using SwiftUICharts, particularly if issues arise. Appending the `.id()` modifier to the chart view with a unique identifier can resolve update problems.

```swift
LineChart(chartData: LineChartData)
    .id(LineChartData.id)
```

--------------------------------

### Add Y Axis Grid to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Adds horizontal lines along the Y-axis of a line or bar chart. Setup is configured in ChartData -> ChartStyle.

```swift
.yAxisGrid(chartData: CTLineBarChartDataProtocol)
```

--------------------------------

### SwiftUI Line Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet shows how to implement a basic Line Chart using the SwiftUICharts library. It requires a LineChartData model as input. The chart is designed for SwiftUI views.

```swift
LineChart(chartData: LineChartData)
```

--------------------------------

### SwiftUI Bar Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This code demonstrates the implementation of a Bar Chart in SwiftUI using the SwiftUICharts library. It requires a BarChartData model and is designed for SwiftUI views.

```swift
BarChart(chartData: BarChartData)
```

--------------------------------

### SwiftUI Pie Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This code shows how to implement a Pie Chart in SwiftUI using the SwiftUICharts library. It requires a PieChartData model as input.

```swift
PieChart(chartData: PieChartData)
```

--------------------------------

### SwiftUI Doughnut Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet demonstrates the implementation of a Doughnut Chart in SwiftUI using the SwiftUICharts library. It utilizes the DoughnutChartData model.

```swift
DoughnutChart(chartData: DoughnutChartData)
```

--------------------------------

### SwiftUI Filled Line Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet demonstrates the implementation of a Filled Line Chart in SwiftUI using the SwiftUICharts library. It utilizes the LineChartData model and is suitable for SwiftUI environments.

```swift
FilledLineChart(chartData: LineChartData)
```

--------------------------------

### Display Chart Header Box

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Displays metadata about the chart, configurable via Chart Data -> ChartMetadata. It can also show information from Touch Overlay if InfoBoxPlacement is set to .header.

```swift
.headerBox(chartData: CTChartData)
```

--------------------------------

### SwiftUI Multi Line Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This code illustrates how to create a Multi Line Chart within a SwiftUI interface using the SwiftUICharts library. It requires a MultiLineChartData object.

```swift
MultiLineChart(chartData: MultiLineChartData)
```

--------------------------------

### SwiftUI Stacked Bar Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet demonstrates the integration of a Stacked Bar Chart in SwiftUI using the SwiftUICharts library. It depends on the StackedBarChartData model.

```swift
StackedBarChart(chartData: StackedBarChartData)
```

--------------------------------

### SwiftUI Grouped Bar Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This code illustrates the implementation of a Grouped Bar Chart within a SwiftUI application using the SwiftUICharts library. It requires a GroupedBarChartData object.

```swift
GroupedBarChart(chartData: GroupedBarChartData)
```

--------------------------------

### SwiftUI Ranged Line Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet shows the integration of a Ranged Line Chart in SwiftUI using the SwiftUICharts library. It depends on the RangedLineChartData model for data representation.

```swift
RangedLineChart(chartData: RangedLineChartData)
```

--------------------------------

### SwiftUI Line Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This SwiftUI code defines a `LineChartDemoView` that displays a line chart representing weekly step counts. It configures the chart with data points, legends, axes, grid lines, touch overlays, and custom markers. The `weekOfData` function generates the necessary `LineChartData` structure with custom styling and metadata.

```swift
struct LineChartDemoView: View {
    
    let data : LineChartData = weekOfData()
    
    var body: some View {
        VStack {
            LineChart(chartData: data)
                .pointMarkers(chartData: data)
                .touchOverlay(chartData: data, specifier: "%.0f")
                .yAxisPOI(chartData: data,
                          markerName: "Step Count Aim",
                          markerValue: 15_000,
                          labelPosition: .center(specifier: "%.0f"),
                          labelColour: Color.black,
                          labelBackground: Color(red: 1.0, green: 0.75, blue: 0.25),
                          lineColour: Color(red: 1.0, green: 0.75, blue: 0.25),
                          strokeStyle: StrokeStyle(lineWidth: 3, dash: [5,10]))
                .yAxisPOI(chartData: data,
                          markerName: "Minimum Recommended",
                          markerValue: 10_000,
                          labelPosition: .center(specifier: "%.0f"),
                          labelColour: Color.white,
                          labelBackground: Color(red: 0.25, green: 0.75, blue: 1.0),
                          lineColour: Color(red: 0.25, green: 0.75, blue: 1.0),
                          strokeStyle: StrokeStyle(lineWidth: 3, dash: [5,10]))
                .averageLine(chartData: data,
                             strokeStyle: StrokeStyle(lineWidth: 3, dash: [5,10]))
                .xAxisGrid(chartData: data)
                .yAxisGrid(chartData: data)
                .xAxisLabels(chartData: data)
                .yAxisLabels(chartData: data)
                .infoBox(chartData: data)
                .headerBox(chartData: data)
                .legends(chartData: data, columns: [GridItem(.flexible()), GridItem(.flexible())])
                .id(data.id)
                .frame(minWidth: 150, maxWidth: 900, minHeight: 150, idealHeight: 250, maxHeight: 400, alignment: .center)
        }
        .navigationTitle("Week of Data")
    }
    
    static func weekOfData() -> LineChartData {
        let data = LineDataSet(dataPoints: [
            LineChartDataPoint(value: 12000, xAxisLabel: "M", description: "Monday"),
            LineChartDataPoint(value: 10000, xAxisLabel: "T", description: "Tuesday"),
            LineChartDataPoint(value: 8000,  xAxisLabel: "W", description: "Wednesday"),
            LineChartDataPoint(value: 17500, xAxisLabel: "T", description: "Thursday"),
            LineChartDataPoint(value: 16000, xAxisLabel: "F", description: "Friday"),
            LineChartDataPoint(value: 11000, xAxisLabel: "S", description: "Saturday"),
            LineChartDataPoint(value: 9000,  xAxisLabel: "S", description: "Sunday")
        ],
        legendTitle: "Steps",
        pointStyle: PointStyle(),
        style: LineStyle(lineColour: ColourStyle(colour: .red), lineType: .curvedLine))
        
        let metadata   = ChartMetadata(title: "Step Count", subtitle: "Over a Week")
        
        let gridStyle  = GridStyle(numberOfLines: 7,
                                   lineColour   : Color(.lightGray).opacity(0.5),
                                   lineWidth    : 1,
                                   dash         : [8],
                                   dashPhase    : 0)
        
        let chartStyle = LineChartStyle(infoBoxPlacement    : .infoBox(isStatic: false),
                                        infoBoxBorderColour : Color.primary,
                                        infoBoxBorderStyle  : StrokeStyle(lineWidth: 1),
                                        
                                        markerType          : .vertical(attachment: .line(dot: .style(DotStyle()))),
                                        
                                        xAxisGridStyle      : gridStyle,
                                        xAxisLabelPosition  : .bottom,
                                        xAxisLabelColour    : Color.primary,
                                        xAxisLabelsFrom     : .dataPoint(rotation: .degrees(0)),
                                        
                                        yAxisGridStyle      : gridStyle,
                                        yAxisLabelPosition  : .leading,
                                        yAxisLabelColour    : Color.primary,
                                        yAxisNumberOfLabels : 7,
                                        
                                        baseline            : .minimumWithMaximum(of: 5000),
                                        topLine             : .maximum(of: 20000),
                                        
                                        globalAnimation     : .easeOut(duration: 1))
        
        return LineChartData(dataSets       : data,
                             metadata       : metadata,
                             chartStyle     : chartStyle)
        
    }
}
```

--------------------------------

### Add Point Markers to Line Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Adds markers to each data point on a line chart. The style of these markers is configured in Data Set -> PointStyle.

```swift
.pointMarkers(chartData: CTLineChartDataProtocol)
```

--------------------------------

### Display Chart Legends

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Renders legends for the chart, laying out markers over each data point. This is a fundamental component for interpreting chart data.

```swift
.legends()
```

--------------------------------

### SwiftUI Ranged Bar Chart Implementation

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This snippet shows how to implement a Ranged Bar Chart in SwiftUI with the SwiftUICharts library. It utilizes the RangedBarChartData model for its data.

```swift
RangedBarChart(chartData: RangedBarChartData)
```

--------------------------------

### Localize Data Point VoiceOver Description

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Localizes the string spoken by VoiceOver when a user interacts with a data point. It defines the format for announcing the chart title, data point value, and its description.

```swift
"%@ <local_description_of_a_data_point>" = "%@, <Description of a data point>"
```

--------------------------------

### Add X Axis Labels to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Includes labels for the X-axis of a line or bar chart. Configuration is managed within ChartData -> ChartStyle.

```swift
.xAxisLabels(chartData: CTLineBarChartDataProtocol)
```

--------------------------------

### Localize POI Marker VoiceOver Description

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Localizes the string read out by VoiceOver before a POI marker. It includes the marker's legend title and value, ensuring clear accessibility information.

```swift
"<local_marker_legend_title> %@" = "local_marker_legend_title, %@";
```

--------------------------------

### Localize POI Marker and Average Labels

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Localizes the labels for Point of Interest (POI) markers and the 'Average' value. This ensures these terms are correctly announced by VoiceOver in localized formats.

```swift
"P-O-I-Marker" = "P O I Marker";
"Average" = "Average";
```

--------------------------------

### Localize Chart Type Legends for VoiceOver

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Localizes the legend titles for various chart types (Line, POI-Marker, Bar, Pie) to be read by VoiceOver. This enhances chart accessibility by providing clear, localized legend information.

```swift
"Line-Chart-Legend" = "Line Chart Legend";
"P-O-I-Marker-Legend" = "P O I Marker Legend";
"Bar-Chart-Legend" = "Bar Chart Legend";
"Pie-Chart-Legend" = "Pie Chart Legend";
```

--------------------------------

### SwiftUI Touch Overlay View Modifier

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This modifier enables touch and pointer input detection for charts, identifying the nearest data point. The placement of the info box is configured within the ChartStyle's infoBoxPlacement property.

```swift
.touchOverlay(chartData: CTChartData, specifier: String, unit: TouchUnit)
```

--------------------------------

### Localize Axis Labels for VoiceOver

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Localizes the strings for axis labels, which are read out by VoiceOver before the axis value. This ensures charts are accessible across different languages.

```swift
"X-Axis-Label" = "X Axis Label";
"Y-Axis-Label" = "Y Axis Label";
```

--------------------------------

### Add Average Line to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Adds a marker line to a line or bar chart that indicates the average of all data points. It allows customization of the marker name, label position, and line style.

```swift
.averageLine(chartData: CTLineBarChartDataProtocol,
             markerName: "Average",
             labelPosition: .yAxis(specifier: "%.0f"),
             lineColour: .primary,
             strokeStyle: StrokeStyle(lineWidth: 3, dash: [5,10]))
```

--------------------------------

### SwiftUI Info Box View Modifier

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This view modifier displays information detected by the Touch Overlay when the infoBoxPlacement is set to .infoBox within the ChartStyle. It requires the chart data model.

```swift
.infoBox(chartData: CTChartData)
```

--------------------------------

### Add Y Axis Labels to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Automatically generates labels for the Y-axis of a line or bar chart, with options for decimal precision. Custom labels can also be provided via ChartData -> yAxisLabels.

```swift
.yAxisLabels(chartData: CTLineBarChartDataProtocol, specifier: "%.0f")
```

--------------------------------

### Add Y Axis Point of Interest to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Configures a point of interest on the Y-axis of a line or bar chart. Allows specification of marker value, label appearance, line color, and stroke style. Returns a new view with the marker.

```swift
.yAxisPOI(chartData: CTLineBarChartDataProtocol,
          markerName: "Marker",
          markerValue: 123,
          labelPosition: .center(specifier: "%.0f"),
          labelColour: Color.black,
          labelBackground: Color.orange,
          lineColour: Color.orange,
          strokeStyle: StrokeStyle(lineWidth: 3, dash: [5,10]))
```

--------------------------------

### Add X Axis Grid to Line/Bar Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Adds vertical lines along the X-axis of a line or bar chart. The grid is typically set up within ChartData -> ChartStyle.

```swift
.xAxisGrid(chartData: CTLineBarChartDataProtocol)
```

--------------------------------

### Add Filled Top Line to FilledLineChart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Creates an additional, distinct line on top of a FilledLineChart, allowing for a clear line over data points with a semi-opaque fill underneath. Requires line color and stroke style.

```swift
.filledTopLine(chartData: LineChartData,
               lineColour: ColourStyle,
               strokeStyle: StrokeStyle)
```

--------------------------------

### Add Linear Trend Line to Chart

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

Draws a line across the chart to illustrate the data's trend. Requires the chart data, the first and last values, and styling for the line.

```swift
.linearTrendLine(chartData: CTLineBarChartDataProtocol,
                 firstValue: Double,
                 lastValue: Double,
                 lineColour: ColourStyle,
                 strokeStyle: StrokeStyle)
```

--------------------------------

### SwiftUI Floating Info Box View Modifier

Source: https://github.com/willdale/swiftuicharts/blob/main/README.md

This modifier displays information detected by the Touch Overlay when the infoBoxPlacement is set to .floating within the ChartStyle. It requires the chart data model.

```swift
.floatingInfoBox(chartData: CTChartData)
```
Tokens:
Raw