Skip to content

Commit 697e86b

Browse files
committed
Cosmetic
1 parent ac5ff06 commit 697e86b

File tree

2 files changed

+2
-44
lines changed

2 files changed

+2
-44
lines changed

MPChartLib/src/main/java/com/github/mikephil/charting/interfaces/datasets/IDataSet.java

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ public interface IDataSet<T extends Entry> {
4848
/**
4949
* Calculates the min and max y-values from the Entry closest to the given fromX to the Entry closest to the given toX value.
5050
* This is only needed for the autoScaleMinMax feature.
51-
*
5251
*/
5352
void calcMinMaxY(float fromX, float toX);
5453

@@ -64,8 +63,6 @@ public interface IDataSet<T extends Entry> {
6463
* @param closestToY If there are multiple y-values for the specified x-value,
6564
* @param rounding determine whether to round up/down/closest
6665
* if there is no Entry matching the provided x-value
67-
*
68-
*
6966
*/
7067
T getEntryForXValue(float xValue, float closestToY, DataSet.Rounding rounding);
7168

@@ -77,7 +74,6 @@ public interface IDataSet<T extends Entry> {
7774
* INFORMATION: This method does calculations at runtime. Do
7875
* not over-use in performance critical situations.
7976
*
80-
*
8177
* @param xValue the x-value
8278
* @param closestToY If there are multiple y-values for the specified x-value,
8379
*/
@@ -88,7 +84,6 @@ public interface IDataSet<T extends Entry> {
8884
* search. An empty array if no Entry object at that x-value.
8985
* INFORMATION: This method does calculations at runtime. Do
9086
* not over-use in performance critical situations.
91-
*
9287
*/
9388
List<T> getEntriesForXValue(float xValue);
9489

@@ -115,7 +110,6 @@ public interface IDataSet<T extends Entry> {
115110
/**
116111
* Returns the position of the provided entry in the DataSets Entry array.
117112
* Returns -1 if doesn't exist.
118-
*
119113
*/
120114
int getEntryIndex(T entry);
121115

@@ -125,7 +119,6 @@ public interface IDataSet<T extends Entry> {
125119
* index in the Entry array of the DataSet for a given xIndex. IMPORTANT: This method does
126120
* calculations at runtime, do not over-use in performance critical
127121
* situations.
128-
*
129122
*/
130123
int getIndexInEntries(int xIndex);
131124

@@ -134,7 +127,6 @@ public interface IDataSet<T extends Entry> {
134127
* Entries are added to the end of the list.
135128
* This will also recalculate the current minimum and maximum
136129
* values of the DataSet and the value-sum.
137-
*
138130
*/
139131
boolean addEntry(T entry);
140132

@@ -144,21 +136,18 @@ public interface IDataSet<T extends Entry> {
144136
* Entries are added to their appropriate index in the values array respective to their x-position.
145137
* This will also recalculate the current minimum and maximum
146138
* values of the DataSet and the value-sum.
147-
*
148139
*/
149140
void addEntryOrdered(T entry);
150141

151142
/**
152143
* Removes the first Entry (at index 0) of this DataSet from the entries array.
153144
* Returns true if successful, false if not.
154-
*
155145
*/
156146
boolean removeFirst();
157147

158148
/**
159149
* Removes the last Entry (at index size-1) of this DataSet from the entries array.
160150
* Returns true if successful, false if not.
161-
*
162151
*/
163152
boolean removeLast();
164153

@@ -167,29 +156,25 @@ public interface IDataSet<T extends Entry> {
167156
* recalculate the current minimum and maximum values of the DataSet and the
168157
* value-sum. Returns true if an Entry was removed, false if no Entry could
169158
* be removed.
170-
*
171159
*/
172160
boolean removeEntry(T entry);
173161

174162
/**
175163
* Removes the Entry object closest to the given x-value from the DataSet.
176164
* Returns true if an Entry was removed, false if no Entry could be removed.
177-
*
178165
*/
179166
boolean removeEntryByXValue(float xValue);
180167

181168
/**
182169
* Removes the Entry object at the given index in the values array from the DataSet.
183170
* Returns true if an Entry was removed, false if no Entry could be removed.
184-
*
185171
*/
186172
boolean removeEntry(int index);
187173

188174
/**
189175
* Checks if this DataSet contains the specified Entry. Returns true if so,
190176
* false if not. NOTE: Performance is pretty bad on this one, do not
191177
* over-use in performance critical situations.
192-
*
193178
*/
194179
boolean contains(T entry);
195180

@@ -200,13 +185,11 @@ public interface IDataSet<T extends Entry> {
200185

201186
/**
202187
* Returns the label string that describes the DataSet.
203-
*
204188
*/
205189
String getLabel();
206190

207191
/**
208192
* Sets the label string that describes the DataSet.
209-
*
210193
*/
211194
void setLabel(String label);
212195

@@ -216,42 +199,36 @@ public interface IDataSet<T extends Entry> {
216199
YAxis.AxisDependency getAxisDependency();
217200

218201
/**
219-
* Set the y-axis this DataSet should be plotted against (either LEFT or
220-
* RIGHT). Default: LEFT
221-
*
202+
* Set the y-axis this DataSet should be plotted against (either LEFT or RIGHT).
203+
* Default: LEFT
222204
*/
223205
void setAxisDependency(YAxis.AxisDependency dependency);
224206

225207
/**
226208
* returns all the colors that are set for this DataSet
227-
*
228209
*/
229210
List<Integer> getColors();
230211

231212
/**
232213
* Returns the first color (index 0) of the colors-array this DataSet
233214
* contains. This is only used for performance reasons when only one color is in the colors array (size == 1)
234-
*
235215
*/
236216
int getColor();
237217

238218
/**
239219
* Returns the color at the given index of the DataSet's color array.
240220
* Performs a IndexOutOfBounds check by modulus.
241-
*
242221
*/
243222
int getColorByIndex(int index);
244223

245224
/**
246225
* returns true if highlighting of values is enabled, false if not
247-
*
248226
*/
249227
boolean isHighlightEnabled();
250228

251229
/**
252230
* If set to true, value highlighting is enabled which means that values can
253231
* be highlighted programmatically or by touch gesture.
254-
*
255232
*/
256233
void setHighlightEnabled(boolean enabled);
257234

@@ -261,68 +238,57 @@ public interface IDataSet<T extends Entry> {
261238
* formatting (concerning decimals) for all the values that are drawn inside
262239
* the chart. Use chart.getDefaultValueFormatter() to use the formatter
263240
* calculated by the chart.
264-
*
265241
*/
266242
void setValueFormatter(IValueFormatter f);
267243

268244
/**
269245
* Returns the formatter used for drawing the values inside the chart.
270-
*
271246
*/
272247
IValueFormatter getValueFormatter();
273248

274249
/**
275250
* Returns true if the valueFormatter object of this DataSet is null.
276-
*
277251
*/
278252
boolean needsFormatter();
279253

280254
/**
281255
* Sets the color the value-labels of this DataSet should have.
282-
*
283256
*/
284257
void setValueTextColor(int color);
285258

286259
/**
287260
* Sets a list of colors to be used as the colors for the drawn values.
288-
*
289261
*/
290262
void setValueTextColors(List<Integer> colors);
291263

292264
/**
293265
* Sets a Typeface for the value-labels of this DataSet.
294-
*
295266
*/
296267
void setValueTypeface(Typeface tf);
297268

298269
/**
299270
* Sets the text-size of the value-labels of this DataSet in dp.
300-
*
301271
*/
302272
void setValueTextSize(float size);
303273

304274
/**
305275
* Returns only the first color of all colors that are set to be used for the values.
306-
*
307276
*/
308277
int getValueTextColor();
309278

310279
/**
311280
* Returns the color at the specified index that is used for drawing the values inside the chart.
312281
* Uses modulus internally.
313-
*
314282
*/
315283
int getValueTextColor(int index);
316284

317285
/**
318286
* Returns the typeface that is used for drawing the values inside the chart
319-
*
320287
*/
321288
Typeface getValueTypeface();
322289

323290
/**
324291
* Returns the text size that is used for drawing the values inside the chart
325-
*
326292
*/
327293
float getValueTextSize();
328294

@@ -363,21 +329,18 @@ public interface IDataSet<T extends Entry> {
363329

364330
/**
365331
* Returns true if y-value drawing is enabled, false if not
366-
*
367332
*/
368333
boolean isDrawValuesEnabled();
369334

370335
/**
371336
* Set this to true to draw y-icons on the chart.
372337
* NOTE (for bar and line charts): if `maxVisibleCount` is reached, no icons will be drawn even
373338
* if this is enabled
374-
*
375339
*/
376340
void setDrawIcons(boolean enabled);
377341

378342
/**
379343
* Returns true if y-icon drawing is enabled, false if not
380-
*
381344
*/
382345
boolean isDrawIconsEnabled();
383346

@@ -396,7 +359,6 @@ public interface IDataSet<T extends Entry> {
396359
/**
397360
* Set the visibility of this DataSet. If not visible, the DataSet will not
398361
* be drawn to the chart upon refreshing it.
399-
*
400362
*/
401363
void setVisible(boolean visible);
402364

MPChartLib/src/main/java/com/github/mikephil/charting/interfaces/datasets/ILineScatterCandleRadarDataSet.kt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,21 @@ import com.github.mikephil.charting.data.Entry
66
interface ILineScatterCandleRadarDataSet<T : Entry> : IBarLineScatterCandleBubbleDataSet<T> {
77
/**
88
* Returns true if vertical highlight indicator lines are enabled (drawn)
9-
* @return
109
*/
1110
val isVerticalHighlightIndicatorEnabled: Boolean
1211

1312
/**
1413
* Returns true if vertical highlight indicator lines are enabled (drawn)
15-
* @return
1614
*/
1715
val isHorizontalHighlightIndicatorEnabled: Boolean
1816

1917
/**
2018
* Returns the line-width in which highlight lines are to be drawn.
21-
* @return
2219
*/
2320
val highlightLineWidth: Float
2421

2522
/**
2623
* Returns the DashPathEffect that is used for highlighting.
27-
* @return
2824
*/
2925
val dashPathEffectHighlight: DashPathEffect?
3026
}

0 commit comments

Comments
 (0)