Fix assorted bugs in BEMSimpleLineGraph, especially null-data related

mackworth · mackworth · commit 78c8cac4e8dd · 2017-03-25T18:04:38.000-07:00
AverageLine:
•Color should be picked up from line if not set (default nil)
Typo in encoding macro

Line:
If null data and interpolation on, then extrapolate for beginning/ending nulls.
Bezier curve should be used even when only two points.
If interpolation off, then bezier line should be interrupted by gaps (but not top/bottom).
Avoid infinity result in midPoint calculation

SimpleLineGraphView:
Support restoration during startup.
NoDataLabel color should not default from Line (which defaults to white, same as background)
If null value, ensure corresponding Dot isn't left on chart
If label isn't used after initially being created, ensure it's removed from view
If neither X nor Y reference lines, set line's enableRefLines to NO (although default, might have been previously YES
If Xaxis background is defaulting to colorBottom, then also use alphaBottom to match; same for Yaxis and colorTop.
Avoid possible infinite loop if delegate gives a zero incrementIndex for x axis
Fix one-pixel gap between yaxis and graph
Remove spurious NSLogs
diff --git a/Classes/BEMAverageLine.m b/Classes/BEMAverageLine.m
@@ -14,7 +14,6 @@ - (instancetype)init {
     self = [super init];
     if (self) {
         _enableAverageLine = NO;
-        _color = [UIColor whiteColor];
         _alpha = 1.0;
         _width = 3.0;
         _yValue = NAN;
@@ -49,7 +48,7 @@ - (instancetype) initWithCoder:(NSCoder *)coder {
 
 - (void) encodeWithCoder: (NSCoder *)coder {
 
-#define EncodeProperty(property, type) [coder encode ## type :self.property forKey:@"property" ]
+#define EncodeProperty(property, type) [coder encode ## type: self.property forKey:@#property]
     EncodeProperty (enableAverageLine, Bool);
     EncodeProperty (color, Object);
     EncodeProperty (yValue, Float);
diff --git a/Classes/BEMLine.m b/Classes/BEMLine.m
@@ -142,20 +142,56 @@ - (void)drawRect:(CGRect)rect {
 
     self.points = [NSMutableArray arrayWithCapacity:self.arrayOfPoints.count];
     for (NSUInteger i = 0; i < self.arrayOfPoints.count; i++) {
-        CGPoint value = CGPointMake(xIndexScale * i, [self.arrayOfPoints[i] CGFloatValue]);
-        if (value.y < BEMNullGraphValue || !self.interpolateNullValues) {
-            [self.points addObject:[NSValue valueWithCGPoint:value]];
-        }
-    }
+        CGFloat value = [self.arrayOfPoints[i] CGFloatValue];;
+        if (value >= BEMNullGraphValue  && self.interpolateNullValues) {
+            //need to interpolate. For midpoints, just don't add a point
+            if (i ==0) {
+                //extrapolate a left edge point from next two actual values
+                NSUInteger firstPos = 1; //look for first real value
+                while (firstPos < self.arrayOfPoints.count && [self.arrayOfPoints[firstPos] CGFloatValue] >= BEMNullGraphValue) firstPos++;
+                if (firstPos >= self.arrayOfPoints.count) break;  // all NaNs?? =>don't create any line
+
+                CGFloat firstValue = [self.arrayOfPoints[firstPos] CGFloatValue];
+                NSUInteger secondPos = firstPos+1; //look for second real value
+                while (secondPos < self.arrayOfPoints.count && [self.arrayOfPoints[secondPos] CGFloatValue] >= BEMNullGraphValue) secondPos++;
+                if (secondPos >= self.arrayOfPoints.count) {
+                    // only one real number
+                    value = firstValue;
+                } else {
+                    CGFloat delta = firstValue - [self.arrayOfPoints[secondPos] CGFloatValue];
+                    value = firstValue + firstPos*delta/(secondPos-firstPos);
+                }
 
-    BOOL bezierStatus = self.bezierCurveIsEnabled;
-    if (self.arrayOfPoints.count <= 2 && self.bezierCurveIsEnabled == YES) bezierStatus = NO;
+            } else if (i == self.arrayOfPoints.count-1) {
+                //extrapolate a right edge poit from previous two actual values
+                NSInteger firstPos = i-1; //look for first real value
+                while (firstPos >= 0 && [self.arrayOfPoints[firstPos] CGFloatValue] >= BEMNullGraphValue) firstPos--;
+                if (firstPos < 0 ) continue;  // all NaNs?? =>don't create any line; should already be gone
+
+                CGFloat firstValue = [self.arrayOfPoints[firstPos] CGFloatValue];
+                NSInteger secondPos = firstPos-1; //look for second real value
+                while (secondPos >= 0 && [self.arrayOfPoints[secondPos] CGFloatValue] >= BEMNullGraphValue) secondPos--;
+                if (secondPos < 0) {
+                    // only one real number
+                    value = firstValue;
+                } else {
+                    CGFloat delta = firstValue - [self.arrayOfPoints[secondPos] CGFloatValue];
+                    value = firstValue + (self.arrayOfPoints.count - firstPos-1)*delta/(firstPos - secondPos);
+                }
 
-    if (!self.disableMainLine && bezierStatus) {
-        line = [BEMLine quadCurvedPathWithPoints:self.points];
-        fillBottom = [BEMLine quadCurvedPathWithPoints:self.bottomPointsArray];
-        fillTop = [BEMLine quadCurvedPathWithPoints:self.topPointsArray];
-    } else if (!self.disableMainLine && !bezierStatus) {
+            } else {
+                continue; //skip this (middle Null) point, let graphics handle interpolation
+            }
+        }
+        CGPoint newPoint = CGPointMake(xIndexScale * i, value);
+        [self.points addObject:[NSValue valueWithCGPoint:newPoint]];
+  }
+
+    if (!self.disableMainLine && self.bezierCurveIsEnabled) {
+        line = [BEMLine quadCurvedPathWithPoints:self.points open:YES];
+        fillBottom = [BEMLine quadCurvedPathWithPoints:self.bottomPointsArray open:NO];
+        fillTop = [BEMLine quadCurvedPathWithPoints:self.topPointsArray open:NO];
+    } else if (!self.disableMainLine && !self.bezierCurveIsEnabled) {
         line = [BEMLine linesToPoints:self.points];
         fillBottom = [BEMLine linesToPoints:self.bottomPointsArray];
         fillTop = [BEMLine linesToPoints:self.topPointsArray];
@@ -317,34 +353,33 @@ + (UIBezierPath *)linesToPoints:(NSArray <NSValue *> *)points {
     return path;
 }
 
-+ (UIBezierPath *)quadCurvedPathWithPoints:(NSArray <NSValue *> *)points {
++ (UIBezierPath *)quadCurvedPathWithPoints:(NSArray <NSValue *> *)points open:(BOOL) canSkipPoints {
     UIBezierPath *path = [UIBezierPath bezierPath];
 
     NSValue *value = points[0];
     CGPoint p1 = [value CGPointValue];
     [path moveToPoint:p1];
 
-    if (points.count == 2) {
-        value = points[1];
-        CGPoint p2 = [value CGPointValue];
-        [path addLineToPoint:p2];
-        return path;
-    }
-
     for (NSValue * point in points) {
+        if (point == value) continue; //already at first point
         CGPoint p2 = [point CGPointValue];
 
-        CGPoint midPoint = midPointForPoints(p1, p2);
-        [path addQuadCurveToPoint:midPoint controlPoint:controlPointForPoints(midPoint, p1)];
-        [path addQuadCurveToPoint:p2 controlPoint:controlPointForPoints(midPoint, p2)];
-
+        if (canSkipPoints && (p1.y >= BEMNullGraphValue || p2.y >= BEMNullGraphValue)) {
+            [path moveToPoint:p2];
+        } else {
+            CGPoint midPoint = midPointForPoints(p1, p2);
+            [path addQuadCurveToPoint:midPoint controlPoint:controlPointForPoints(midPoint, p1)];
+            [path addQuadCurveToPoint:p2 controlPoint:controlPointForPoints(midPoint, p2)];
+        }
         p1 = p2;
     }
     return path;
 }
 
 static CGPoint midPointForPoints(CGPoint p1, CGPoint p2) {
-    return CGPointMake((p1.x + p2.x) / 2, (p1.y + p2.y) / 2);
+    CGFloat avgY = (p1.y + p2.y) / 2.0;
+    if (isinf(avgY)) avgY = BEMNullGraphValue;
+    return CGPointMake((p1.x + p2.x) / 2, avgY);
 }
 
 static CGPoint controlPointForPoints(CGPoint p1, CGPoint p2) {
diff --git a/Classes/BEMSimpleLineGraphView.m b/Classes/BEMSimpleLineGraphView.m
@@ -129,6 +129,16 @@ - (instancetype) initWithFrame:(CGRect)frame {
 - (instancetype) initWithCoder:(NSCoder *)coder {
     self = [super initWithCoder:coder];
     if (self) [self commonInit];
+    [self restorePropertyWithCoder:coder];
+    return self;
+}
+
+-(void) decodeRestorableStateWithCoder:(NSCoder *)coder {
+    [super decodeRestorableStateWithCoder:coder];
+    [self restorePropertyWithCoder:coder];
+}
+
+-(void) restorePropertyWithCoder:(NSCoder *) coder {
 
 #define RestoreProperty(property, type) \
 if ([coder containsValueForKey:@#property]) { \
@@ -179,23 +189,26 @@ - (instancetype) initWithCoder:(NSCoder *)coder {
     RestoreProperty (formatStringForValues, Object);
 
     RestoreProperty (averageLine, Object);
-    return self;
 #pragma clang diagnostic pop
 }
 
-- (void) encodeWithEncoder: (NSCoder *)coder {
+-(void) encodeRestorableStateWithCoder:(NSCoder *)coder {
+    [super encodeRestorableStateWithCoder:coder];
+    [self encodePropertiesWithCoder:coder];
+}
 
-#define EncodeProperty(property, type) [coder encode ## type: self.property forKey:@#property]
+- (void) encodeWithCoder: (NSCoder *)coder {
+    [super encodeWithCoder:coder];
+    [self encodePropertiesWithCoder:coder];
+}
 
+-(void) encodePropertiesWithCoder: (NSCoder *) coder {
 
-    [super encodeWithCoder:coder];
+#define EncodeProperty(property, type) [coder encode ## type: self.property forKey:@#property]
 
     EncodeProperty (labelFont, Object);
     EncodeProperty (animationGraphEntranceTime, Float);
     EncodeProperty (animationGraphStyle, Integer);
-    EncodeProperty (enableReferenceAxisFrame, Bool);
-    EncodeProperty (enableTopReferenceAxisFrameLine, Bool);
-    EncodeProperty (enableRightReferenceAxisFrameLine, Bool);
 
     EncodeProperty (colorXaxisLabel, Object);
     EncodeProperty (colorYaxisLabel, Object);
@@ -383,7 +396,7 @@ - (void)layoutNumberOfPoints {
         }
         self.noDataLabel.text = noDataText ?: NSLocalizedString(@"No Data", nil);
         self.noDataLabel.font = self.noDataLabelFont ?: [UIFont preferredFontForTextStyle:UIFontTextStyleCaption1];
-        self.noDataLabel.textColor = self.noDataLabelColor ?: (self.colorLine ?: [UIColor blackColor]);
+        self.noDataLabel.textColor = self.noDataLabelColor ?: (self.colorXaxisLabel ?: [UIColor blackColor]);
 
         [self.viewForFirstBaselineLayout addSubview:self.noDataLabel];
 
@@ -522,16 +535,20 @@ -(BEMCircle *) circleDotAtIndex:(NSUInteger) index forValue:(CGFloat) dotValue r
 
     [yAxisValues addObject:@(positionOnYAxis)];
 
+    BEMCircle *circleDot = nil;
+    if (reuseNumber < self.circleDots.count) {
+        circleDot = self.circleDots[reuseNumber];
+    }
     if (dotValue >= BEMNullGraphValue) {
         // If we're dealing with an null value, don't draw the dot (but put it in yAxis to interpolate line)
+        [circleDot removeFromSuperview];
         return nil;
     }
 
-    BEMCircle *circleDot;
     CGRect dotFrame = CGRectMake(0, 0, self.sizePoint, self.sizePoint);
-    if (reuseNumber < self.circleDots.count) {
-        circleDot = self.circleDots[reuseNumber];
+    if (circleDot) {
         circleDot.frame = dotFrame;
+        [circleDot setNeedsDisplay];
     } else {
         circleDot = [[BEMCircle alloc] initWithFrame:dotFrame];
         [self.circleDots addObject:circleDot];
@@ -573,34 +590,37 @@ - (void)drawDots {
 
             BEMCircle * circleDot = [self circleDotAtIndex: index forValue: dotValue reuseNumber: index];
             UILabel * label = nil;
+            if (index < self.permanentPopups.count) {
+                label = self.permanentPopups[index];
+            } else {
+                label = [[UILabel alloc] initWithFrame:CGRectZero];
+                [self.permanentPopups addObject:label ];
+            }
+
             if (circleDot) {
                 [self addSubview:circleDot];
 
-                if (self.alwaysDisplayPopUpLabels == YES) {
-                    if (![self.delegate respondsToSelector:@selector(lineGraph:alwaysDisplayPopUpAtIndex:)] ||
-                        [self.delegate lineGraph:self alwaysDisplayPopUpAtIndex:index]) {
-                        if (index < self.permanentPopups.count) {
-                            label = self.permanentPopups[index];
-                        } else {
-                            label = [[UILabel alloc] initWithFrame:CGRectZero];
-                            [self.permanentPopups addObject:label ];
-                        }
-                        label = [self configureLabel:label forPoint: circleDot ];
-
-                        [self adjustXLocForLabel:label avoidingDot:circleDot.frame];
-
-                        UILabel * leftNeighbor = (index >= 1 && self.permanentPopups[index-1].superview) ? self.permanentPopups[index-1] : nil;
-                        UILabel * secondNeighbor = (index >= 2 && self.permanentPopups[index-2].superview) ? self.permanentPopups[index-2] : nil;
-                        BOOL showLabel =  [self adjustYLocForLabel:label
-                                                       avoidingDot:circleDot.frame
-                                                      andNeighbors:leftNeighbor.frame
-                                                               and:secondNeighbor.frame ];
-                        if (showLabel) {
-                            [self addSubview:label];
-                        } else {
-                            [label removeFromSuperview];
-                        }
+                if ((self.alwaysDisplayPopUpLabels == YES)  &&
+                    (![self.delegate respondsToSelector:@selector(lineGraph:alwaysDisplayPopUpAtIndex:)] ||
+                      [self.delegate lineGraph:self alwaysDisplayPopUpAtIndex:index])) {
+                    label = [self configureLabel:label forPoint: circleDot ];
+
+                    [self adjustXLocForLabel:label avoidingDot:circleDot.frame];
+
+                    UILabel * leftNeighbor = (index >= 1 && self.permanentPopups[index-1].superview) ? self.permanentPopups[index-1] : nil;
+                    UILabel * secondNeighbor = (index >= 2 && self.permanentPopups[index-2].superview) ? self.permanentPopups[index-2] : nil;
+                    BOOL showLabel =  [self adjustYLocForLabel:label
+                                                   avoidingDot:circleDot.frame
+                                                  andNeighbors:leftNeighbor.frame
+                                                           and:secondNeighbor.frame ];
+                    if (showLabel) {
+                        [self addSubview:label];
+                    } else {
+                        [label removeFromSuperview];
                     }
+                } else {
+                    //not showing labels this time, so remove if any
+                    [label removeFromSuperview];
                 }
 
                 // Dot and/or label entrance animation
@@ -628,6 +648,8 @@ - (void)drawDots {
                     } completion:nil];
                 }
 
+            } else {
+                [label removeFromSuperview];
             }
         }
         for (NSUInteger i = self.circleDots.count -1; i>=numberOfPoints; i--) {
@@ -679,6 +701,8 @@ - (void)drawLine {
         line.verticalReferenceHorizontalFringeNegation = xAxisHorizontalFringeNegationValue;
         line.arrayOfVerticalReferenceLinePoints = self.enableReferenceXAxisLines ? xAxisLabelPoints : nil;
         line.arrayOfHorizontalReferenceLinePoints = self.enableReferenceYAxisLines ? yAxisLabelPoints : nil;
+    } else {
+        line.enableReferenceLines = NO;
     }
 
     line.color = self.colorLine;
@@ -726,8 +750,13 @@ - (void)drawXAxis {
     }
     [self addSubview:self.backgroundXAxis];
 
-    self.backgroundXAxis.backgroundColor = self.colorBackgroundXaxis ?: self.colorBottom;
-    self.backgroundXAxis.alpha = self.alphaBackgroundXaxis;
+    if (self.colorBackgroundXaxis) {
+        self.backgroundXAxis.backgroundColor = self.colorBackgroundXaxis;
+        self.backgroundXAxis.alpha = self.alphaBackgroundXaxis;
+    } else {
+        self.backgroundXAxis.backgroundColor = self.colorBottom;
+        self.backgroundXAxis.alpha = self.alphaBottom;
+    }
 
     NSArray <NSNumber *> *axisIndices = nil;
     if ([self.delegate respondsToSelector:@selector(incrementPositionsForXAxisOnLineGraph:)]) {
@@ -751,6 +780,7 @@ - (void)drawXAxis {
                 baseIndex = increment - 1 - offset;
             }
         }
+        if (increment == 0) increment = 1;
         NSMutableArray <NSNumber *> *values = [NSMutableArray array ];
         NSUInteger index = baseIndex;
         while (index < numberOfPoints) {
@@ -933,7 +963,7 @@ - (void)drawYAxis {
                                                  self.frame.size.width - self.YAxisLabelXOffset - 1.0f:
                                                  0.0),
                                                 0,
-                                                self.YAxisLabelXOffset - 1.0f,
+                                                self.YAxisLabelXOffset,
                                                 self.frame.size.height);
 
     if (!self.backgroundYAxis) {
@@ -942,8 +972,13 @@ - (void)drawYAxis {
         self.backgroundYAxis.frame = frameForBackgroundYAxis;
     }
     [self addSubview:self.backgroundYAxis];
-    self.backgroundYAxis.backgroundColor = self.colorBackgroundYaxis ?: self.colorTop;
-    self.backgroundYAxis.alpha = self.alphaBackgroundYaxis;
+    if (self.colorBackgroundYaxis) {
+        self.backgroundYAxis.backgroundColor = self.colorBackgroundYaxis;
+        self.backgroundYAxis.alpha = self.alphaBackgroundYaxis;
+    } else {
+        self.backgroundYAxis.backgroundColor =  self.colorTop;
+        self.backgroundYAxis.alpha = self.alphaTop;
+    }
 
     [yAxisLabelPoints removeAllObjects];
 
@@ -1114,14 +1149,13 @@ - (UILabel *)configureLabel: (UILabel *) oldLabel forPoint: (BEMCircle *)circleD
         NSNumber *value = (index <= dataPoints.count) ? value = dataPoints[index] : @(0); // @((NSInteger) circleDot.absoluteValue)
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wformat-nonliteral"
+        //note this can indeed crash if delegate provides junk for formatString (e.g. %@); try/catch doesn't work
         NSString *formattedValue = [NSString stringWithFormat:self.formatStringForValues, value.doubleValue];
 #pragma clang diagnostic pop
         newPopUpLabel.text = [NSString stringWithFormat:@"%@%@%@", prefix, formattedValue, suffix];
     }
-    NSLog(@"%@ before SizeToFit: %@",newPopUpLabel.text, NSStringFromCGRect(newPopUpLabel.frame));
     CGSize requiredSize = [newPopUpLabel sizeThatFits:CGSizeMake(100.0f, CGFLOAT_MAX)];
     newPopUpLabel.frame = CGRectMake(10, 10, requiredSize.width+10.0f, requiredSize.height+10.0f);
-    NSLog(@"%@ after SizeToFit: %@",newPopUpLabel.text, NSStringFromCGRect(newPopUpLabel.frame));
     return newPopUpLabel;
 }
 
