Skip to content

Commit

Permalink
improve descriptions to warn users how to use setVisibleRange APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
liuxuan30 committed Jul 13, 2016
1 parent a7155c6 commit 623ade5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Charts/Classes/Charts/BarLineChartViewBase.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1186,6 +1186,9 @@ public class BarLineChartViewBase: ChartViewBase, BarLineScatterCandleBubbleChar
}

/// Sets the size of the area (range on the x-axis) that should be maximum visible at once (no further zomming out allowed).
///
/// If you call this method, make sure you feed chart data, otherwise it won't work
///
/// If this is e.g. set to 10, no more than 10 values on the x-axis can be viewed at once without scrolling.
public func setVisibleXRangeMaximum(maxXRange: CGFloat)
{
Expand All @@ -1194,6 +1197,9 @@ public class BarLineChartViewBase: ChartViewBase, BarLineScatterCandleBubbleChar
}

/// Sets the size of the area (range on the x-axis) that should be minimum visible at once (no further zooming in allowed).
///
/// If you call this method, make sure you feed chart data, otherwise it won't work
///
/// If this is e.g. set to 10, no less than 10 values on the x-axis can be viewed at once without scrolling.
public func setVisibleXRangeMinimum(minXRange: CGFloat)
{
Expand All @@ -1202,6 +1208,9 @@ public class BarLineChartViewBase: ChartViewBase, BarLineScatterCandleBubbleChar
}

/// Limits the maximum and minimum value count that can be visible by pinching and zooming.
///
/// If you call this method, make sure you feed chart data, otherwise it won't work
///
/// e.g. minRange=10, maxRange=100 no less than 10 values and no more that 100 values can be viewed
/// at once without scrolling
public func setVisibleXRange(minXRange minXRange: CGFloat, maxXRange: CGFloat)
Expand All @@ -1212,6 +1221,8 @@ public class BarLineChartViewBase: ChartViewBase, BarLineScatterCandleBubbleChar
}

/// Sets the size of the area (range on the y-axis) that should be maximum visible at once.
///
/// If you call this method, make sure you feed chart data, otherwise it won't work
///
/// - parameter yRange:
/// - parameter axis: - the axis for which this limit should apply
Expand Down

0 comments on commit 623ade5

Please sign in to comment.