Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve comment to warn users how to use setVisibleRange APIs #1245

Merged
merged 1 commit into from
Aug 5, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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, chart must have data or it has no effect
///
/// 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, chart must have data or it has no effect
///
/// 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, chart must have data or it has no effect
///
/// 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, chart must have data or it has no effect
///
/// - parameter yRange:
/// - parameter axis: - the axis for which this limit should apply
Expand Down