Skip to content

Commit 3d2c603

Browse files
committed
docs: update docs
1 parent 638977e commit 3d2c603

7 files changed

Lines changed: 60 additions & 42 deletions

File tree

docs/interfaces/ActivePointConfig.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ false
2424

2525
#### Defined in
2626

27-
[src/types.ts:220](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L220)
27+
[src/types.ts:225](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L225)
2828

2929
***
3030

@@ -42,7 +42,7 @@ the border color for the active point circle
4242

4343
#### Defined in
4444

45-
[src/types.ts:175](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L175)
45+
[src/types.ts:180](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L180)
4646

4747
***
4848

@@ -60,7 +60,7 @@ the border width for the active point circle
6060

6161
#### Defined in
6262

63-
[src/types.ts:180](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L180)
63+
[src/types.ts:185](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L185)
6464

6565
***
6666

@@ -78,7 +78,7 @@ The color of the active point circle
7878

7979
#### Defined in
8080

81-
[src/types.ts:170](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L170)
81+
[src/types.ts:175](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L175)
8282

8383
***
8484

@@ -96,7 +96,7 @@ the border radius for the active point circle
9696

9797
#### Defined in
9898

99-
[src/types.ts:185](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L185)
99+
[src/types.ts:190](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L190)
100100

101101
***
102102

@@ -114,7 +114,7 @@ true
114114

115115
#### Defined in
116116

117-
[src/types.ts:195](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L195)
117+
[src/types.ts:200](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L200)
118118

119119
***
120120

@@ -132,7 +132,7 @@ false
132132

133133
#### Defined in
134134

135-
[src/types.ts:190](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L190)
135+
[src/types.ts:195](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L195)
136136

137137
***
138138

@@ -150,7 +150,7 @@ The color of the vertical line
150150

151151
#### Defined in
152152

153-
[src/types.ts:200](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L200)
153+
[src/types.ts:205](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L205)
154154

155155
***
156156

@@ -168,7 +168,7 @@ The dash array for the vertical line (this will create a dashed line)
168168

169169
#### Defined in
170170

171-
[src/types.ts:215](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L215)
171+
[src/types.ts:220](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L220)
172172

173173
***
174174

@@ -186,7 +186,7 @@ The opacity of the vertical line (number between 0 and 1)
186186

187187
#### Defined in
188188

189-
[src/types.ts:205](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L205)
189+
[src/types.ts:210](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L210)
190190

191191
***
192192

@@ -204,4 +204,4 @@ The width of the vertical line
204204

205205
#### Defined in
206206

207-
[src/types.ts:210](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L210)
207+
[src/types.ts:215](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L215)

docs/interfaces/AnimationConfig.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Animation presets
2727

2828
#### Defined in
2929

30-
[src/types.ts:288](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L288)
30+
[src/types.ts:293](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L293)
3131

3232
***
3333

@@ -45,4 +45,4 @@ Animation Duration
4545

4646
#### Defined in
4747

48-
[src/types.ts:283](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L283)
48+
[src/types.ts:288](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L288)

docs/interfaces/EndPointConfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Weather the end point should be animated (pulse animation)
1818

1919
#### Defined in
2020

21-
[src/types.ts:159](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L159)
21+
[src/types.ts:164](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L164)
2222

2323
***
2424

@@ -30,7 +30,7 @@ The color of the end point
3030

3131
#### Defined in
3232

33-
[src/types.ts:151](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L151)
33+
[src/types.ts:156](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L156)
3434

3535
***
3636

@@ -42,4 +42,4 @@ The border radius of the end point
4242

4343
#### Defined in
4444

45-
[src/types.ts:155](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L155)
45+
[src/types.ts:160](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L160)

docs/interfaces/ExtraConfig.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Supplying activeOffsetX for the gesture handler, if the offset is reached, the s
2424

2525
#### Defined in
2626

27-
[src/types.ts:252](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L252)
27+
[src/types.ts:257](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L257)
2828

2929
***
3030

@@ -42,7 +42,7 @@ false
4242

4343
#### Defined in
4444

45-
[src/types.ts:231](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L231)
45+
[src/types.ts:236](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L236)
4646

4747
***
4848

@@ -54,7 +54,7 @@ Settings this to true will make the chart y axis start from zero even if the min
5454

5555
#### Defined in
5656

57-
[src/types.ts:243](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L243)
57+
[src/types.ts:248](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L248)
5858

5959
***
6060

@@ -66,7 +66,7 @@ Animation configuration
6666

6767
#### Defined in
6868

69-
[src/types.ts:269](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L269)
69+
[src/types.ts:274](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L274)
7070

7171
***
7272

@@ -78,7 +78,7 @@ supplying this function will allow you to customize the x axis min and max value
7878

7979
#### Defined in
8080

81-
[src/types.ts:265](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L265)
81+
[src/types.ts:270](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L270)
8282

8383
***
8484

@@ -90,7 +90,7 @@ supplying this function will allow you to customize the y axis min and max value
9090

9191
#### Defined in
9292

93-
[src/types.ts:261](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L261)
93+
[src/types.ts:266](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L266)
9494

9595
***
9696

@@ -108,7 +108,7 @@ Space between the end of the chart the the end of the view (like paddingEnd)
108108

109109
#### Defined in
110110

111-
[src/types.ts:257](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L257)
111+
[src/types.ts:262](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L262)
112112

113113
***
114114

@@ -120,7 +120,7 @@ Settings this to true will make the active point always visible after the user t
120120

121121
#### Defined in
122122

123-
[src/types.ts:239](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L239)
123+
[src/types.ts:244](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L244)
124124

125125
***
126126

@@ -132,7 +132,7 @@ This is the index of the initial active point (the point that will be active whe
132132

133133
#### Defined in
134134

135-
[src/types.ts:235](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L235)
135+
[src/types.ts:240](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L240)
136136

137137
***
138138

@@ -144,4 +144,4 @@ Supplying simultaneousHandlers will make the chart work with other gesture handl
144144

145145
#### Defined in
146146

147-
[src/types.ts:247](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L247)
147+
[src/types.ts:252](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L252)

docs/interfaces/Line.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The component to render when the user taps on the chart
1818

1919
#### Defined in
2020

21-
[src/types.ts:91](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L91)
21+
[src/types.ts:96](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L96)
2222

2323
***
2424

@@ -30,7 +30,7 @@ The same as (activePointComponent) but the component will receive the shared val
3030

3131
#### Defined in
3232

33-
[src/types.ts:95](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L95)
33+
[src/types.ts:100](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L100)
3434

3535
***
3636

@@ -42,7 +42,7 @@ The configuration for the active point (the point that is shown when the user ta
4242

4343
#### Defined in
4444

45-
[src/types.ts:67](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L67)
45+
[src/types.ts:67](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L67)
4646

4747
***
4848

@@ -60,7 +60,7 @@ The curve of the line
6060

6161
#### Defined in
6262

63-
[src/types.ts:108](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L108)
63+
[src/types.ts:113](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L113)
6464

6565
***
6666

@@ -72,7 +72,7 @@ The data points for the line containing an array of objects with x and y values
7272

7373
#### Defined in
7474

75-
[src/types.ts:63](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L63)
75+
[src/types.ts:63](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L63)
7676

7777
***
7878

@@ -84,7 +84,7 @@ The end point configuration (the point appearing at the end of the line)
8484

8585
#### Defined in
8686

87-
[src/types.ts:103](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L103)
87+
[src/types.ts:108](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L108)
8888

8989
***
9090

@@ -102,7 +102,7 @@ The fill opacity of the area chart
102102

103103
#### Defined in
104104

105-
[src/types.ts:118](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L118)
105+
[src/types.ts:123](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L123)
106106

107107
***
108108

@@ -120,7 +120,7 @@ false
120120

121121
#### Defined in
122122

123-
[src/types.ts:113](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L113)
123+
[src/types.ts:118](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L118)
124124

125125
***
126126

@@ -132,7 +132,7 @@ Optional key to indicate that the line has changed (helps with triggering animat
132132

133133
#### Defined in
134134

135-
[src/types.ts:59](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L59)
135+
[src/types.ts:59](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L59)
136136

137137
***
138138

@@ -150,7 +150,7 @@ the opacity of the begging of the line (gives it gradient effect if you have col
150150

151151
#### Defined in
152152

153-
[src/types.ts:76](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L76)
153+
[src/types.ts:76](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L76)
154154

155155
***
156156

@@ -162,7 +162,7 @@ The color of the line (supplying an array of colors will create a linear gradien
162162

163163
#### Defined in
164164

165-
[src/types.ts:71](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L71)
165+
[src/types.ts:71](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L71)
166166

167167
***
168168

@@ -174,7 +174,25 @@ The width of the line
174174

175175
#### Defined in
176176

177-
[src/types.ts:99](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L99)
177+
[src/types.ts:104](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L104)
178+
179+
***
180+
181+
### opacityDirection?
182+
183+
> `optional` **opacityDirection**: `"horizontal"` \| `"vertical"`
184+
185+
The direction of the opacity (horizontal or vertical)
186+
187+
#### Default
188+
189+
```ts
190+
'horizontal'
191+
```
192+
193+
#### Defined in
194+
195+
[src/types.ts:88](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L88)
178196

179197
***
180198

@@ -186,7 +204,7 @@ specify the strokeDasharray for the line
186204

187205
#### Defined in
188206

189-
[src/types.ts:87](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L87)
207+
[src/types.ts:92](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L92)
190208

191209
***
192210

@@ -204,4 +222,4 @@ the opacity of the end of the line (gives it gradient effect if you have colored
204222

205223
#### Defined in
206224

207-
[src/types.ts:81](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L81)
225+
[src/types.ts:81](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L81)

docs/type-aliases/LineChart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,4 @@ The width of the chart (default value is the width of the screen)
9090

9191
## Defined in
9292

93-
[src/types.ts:9](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/6e0215dbd194df10ddb3d5a2a472fbe3c71a004f/src/types.ts#L9)
93+
[src/types.ts:9](https://github.com/Malaa-tech/react-native-simple-line-chart/blob/638977e1064b855904c85112815974f31c2777e9/src/types.ts#L9)

example/src/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ const Chart = ({
409409
? ['#f5dd4b', '#81b0ff']
410410
: color,
411411
leadingOpacity: 0.5,
412-
opacityDirection: 'vertical',
412+
opacityDirection: 'vertical' as const,
413413
isAreaChart,
414414
curve: chartType,
415415
endPointConfig: isEndPoint

0 commit comments

Comments
 (0)