annotate DOCS.md @ 127:fc066e00f4b6

Change info files
author Dennis <dennis@denniscm.com>
date Fri, 11 Aug 2023 18:53:38 +0000
parents
children ce6bfc2702fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
127
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
1
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
2 # Table of Contents
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
3
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
4 1. [Installation](#orgd9f2fd7)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
5 2. [Demo app](#orgbd9420c)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
6 3. [Usage](#org57f1418)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
7 1. [Line chart](#org19fa053)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
8 2. [Capsule chart](#orgc225fff)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
9 1. [Example](#org71304cd)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
10
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
11
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
12 <a id="orgd9f2fd7"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
13
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
14 # Installation
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
15
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
16 - In Xcode go to `File` -> `Swift packages` -> `Add package dependency`
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
17 - Copy and paste `https://github.com/denniscmartin/stock-charts.git`
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
18
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
19
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
20 <a id="orgbd9420c"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
21
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
22 # Demo app
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
23
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
24 I've created an example app to show real use cases of this framework, check -> [Trades app](https://github.com/denniscmartin/trades-demo)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
25
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
26
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
27 <a id="org57f1418"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
28
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
29 # Usage
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
30
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
31 import StockCharts
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
32
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
33
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
34 <a id="org19fa053"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
35
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
36 ## Line chart
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
37
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
38 let lineChartController = LineChartController(prices: [Double])
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
39 LineChartView(lineChartController: lineChartController)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
40
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
41 You can customise the line chart with `LineChartController`
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
42
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
43 LineChartController(
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
44 prices: [Double],
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
45 dates: [String]?, // format: yy-MM-dd
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
46 hours: [String]?, // has to correspond to dates
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
47 labelColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
48 indicatorPointColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
49 showingIndicatorLineColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
50 flatTrendLineColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
51 uptrendLineColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
52 downtrendLineColor: Color,
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
53 dragGesture: Bool
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
54 )
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
55
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
56 To enable the drag gesture set `dragGesture` to `true` in the `LineChartController`
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
57
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
58 LineChartView(
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
59 lineChartController:
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
60 LineChartController(
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
61 prices: [Double],
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
62 dragGesture: true
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
63 )
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
64 )
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
65
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
66
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
67 <a id="orgc225fff"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
68
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
69 ## Capsule chart
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
70
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
71 CapsuleChartView(percentageOfWidth: CGFloat)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
72 // percentageOfWidth: must be 0 <= x <= 1
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
73
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
74
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
75 <a id="org71304cd"></a>
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
76
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
77 ### Example
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
78
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
79 import SwiftUI
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
80 import StockCharts
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
81
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
82 struct ContentView: View {
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
83 var body: some View {
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
84 RoundedRectangle(cornerRadius: 25)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
85 .frame(width: 400, height: 120)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
86 .foregroundColor(.white)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
87 .shadow(color: Color(.gray).opacity(0.15), radius: 10)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
88 .overlay(
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
89 VStack(alignment: .leading) {
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
90 Text("Dennis Concepcion")
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
91 .font(.title3)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
92 .fontWeight(.semibold)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
93
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
94 Text("Random guy")
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
95
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
96 CapsuleChartView(percentageOfWidth: 0.6, style: CapsuleChartStyle(capsuleColor: Color.blue))
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
97 .padding(.top)
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
98 }
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
99 .padding()
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
100 )
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
101 }
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
102 }
fc066e00f4b6 Change info files
Dennis <dennis@denniscm.com>
parents:
diff changeset
103