Skip to content

Commit

Permalink
Merge pull request #3518 from JCMcLovin/getFormattedValue-stringForValue
Browse files Browse the repository at this point in the history
Changed comment that referenced getFormattedValue() method in IValueFormatter
  • Loading branch information
pmairoldi committed Aug 1, 2018
2 parents 5a5121d + e1f3b71 commit 4fca1f7
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions Source/Charts/Formatters/IValueFormatter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@

import Foundation

/// Interface that allows custom formatting of all values inside the chart before they are being drawn to the screen.
/// Interface that allows custom formatting of all values inside the chart before they are drawn to the screen.
///
/// Simply create your own formatting class and let it implement ValueFormatter.
///
/// Then override the getFormattedValue(...) method and return whatever you want.
/// Simply create your own formatting class and let it implement ValueFormatter. Then override the stringForValue()
/// method and return whatever you want.

@objc(IChartValueFormatter)
public protocol IValueFormatter: class
{
Expand All @@ -24,12 +24,10 @@ public protocol IValueFormatter: class
///
/// For performance reasons, avoid excessive calculations and memory allocations inside this method.
///
/// - returns: The formatted label ready for being drawn
/// - returns: The formatted label ready to be drawn
///
/// - parameter value: The value to be formatted
///
/// - parameter axis: The entry the value belongs to - in e.g. BarChart, this is of class BarEntry
///
/// - parameter dataSetIndex: The index of the DataSet the entry in focus belongs to
///
/// - parameter viewPortHandler: provides information about the current chart state (scale, translation, ...)
Expand Down

0 comments on commit 4fca1f7

Please sign in to comment.