@@ -180,9 +180,9 @@
API
@@ -197,7 +197,7 @@
API
Declaration
Swift
-
public override func string(forValue value: CGFloat) -> String?
+
public func string(for value: Any) -> String?
Declaration
diff --git a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/index.html b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/index.html
index f93b1b92..b6f00235 100644
--- a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/index.html
+++ b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/index.html
@@ -13,7 +13,7 @@
@@ -33,24 +33,15 @@
UICircularProgressRing
-
- UICircularProgressRingFormatter
-
UICircularRing
-
- UICircularRingValueFormatter
-
UICircularTimerRing
– State
-
- UICircularTimerRingFormatter
-
@@ -70,17 +61,26 @@
UICircularProgressRingDelegate
+
+ UICircularRingValueFormatter
+
Structures
@@ -103,7 +103,7 @@
Authors
diff --git a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/search.json b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/search.json
index 19f9edd4..3021e1ac 100644
--- a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/search.json
+++ b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/Documents/search.json
@@ -1 +1 @@
-{"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV7defaultACvpZ":{"name":"default","abstract":"
a default styling option for the gradient style
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV13startPositionAA0acdG0Ovp":{"name":"startPosition","abstract":"
the start location for the gradient
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV11endPositionAA0acdG0Ovp":{"name":"endPosition","abstract":"
the end location for the gradient
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV6colorsSaySo7UIColorCGvp":{"name":"colors","abstract":"
the colors to use in the gradient, the count of this list must match the count of colorLocations
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV14colorLocationsSay12CoreGraphics7CGFloatVGvp":{"name":"colorLocations","abstract":"
the locations of where to place the colors, valid numbers are from 0.0 - 1.0
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV13startPosition03endG06colors14colorLocationsAcA0acdG0O_AISaySo7UIColorCGSay12CoreGraphics7CGFloatVGtcfc":{"name":"init(startPosition:endPosition:colors:colorLocations:)","abstract":"
create a new UICircularGradientOptions
","parent_name":"UICircularGradientOptions"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV7defaultACvpZ":{"name":"default","abstract":"
default implmementation of the knob style
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size12CoreGraphics7CGFloatVvp":{"name":"size","abstract":"
the size of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV5colorSo7UIColorCvp":{"name":"color","abstract":"
the color of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV10shadowBlur12CoreGraphics7CGFloatVvp":{"name":"shadowBlur","abstract":"
the amount of blur to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV12shadowOffsetSo6CGSizeVvp":{"name":"shadowOffset","abstract":"
the offset to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV11shadowColorSo7UIColorCvp":{"name":"shadowColor","abstract":"
the color for the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size5color10shadowBlur0I6Offset0I5ColorAC12CoreGraphics7CGFloatV_So7UIColorCAKSo6CGSizeVAMtcfc":{"name":"init(size:color:shadowBlur:shadowOffset:shadowColor:)","abstract":"
creates a new UICircularRingValueKnobStyle
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html":{"name":"UICircularRingValueKnobStyle","abstract":"
UICircularRingValueKnobStyle
"},"Structs/UICircularGradientOptions.html":{"name":"UICircularGradientOptions","abstract":"
UICircularGradientOptions
"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didFinishB03foryA2AC_tF":{"name":"didFinishProgress(for:)","abstract":"
Called when progress ring is done animating for current value
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP08didPauseB03foryA2AC_tF":{"name":"didPauseProgress(for:)","abstract":"
Called when progress has paused
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP011didContinueB03foryA2AC_tF":{"name":"didContinueProgress(for:)","abstract":"
Called when the progress has continued after a pause
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didUpdateB5Value3for2toyA2AC_12CoreGraphics7CGFloatVtF":{"name":"didUpdateProgressValue(for:to:)","abstract":"
This method is called whenever the value is updated, this means during animation this method will be called in real time.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP16willDisplayLabel3for_yA2AC_So7UILabelCtF":{"name":"willDisplayLabel(for:_:)","abstract":"
This method is called whenever the label is about to be drawn.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html":{"name":"UICircularProgressRingDelegate","abstract":"
This is the protocol declaration for the UICircularRing delegate property
"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO3topyA2CmF":{"name":"top","abstract":"
Gradient positioned at the top
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO6bottomyA2CmF":{"name":"bottom","abstract":"
Gradient positioned at the bottom
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO4leftyA2CmF":{"name":"left","abstract":"
Gradient positioned to the left
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO5rightyA2CmF":{"name":"right","abstract":"
Gradient positioned to the right
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO7topLeftyA2CmF":{"name":"topLeft","abstract":"
Gradient positioned in the top left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO8topRightyA2CmF":{"name":"topRight","abstract":"
Gradient positioned in the top right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO10bottomLeftyA2CmF":{"name":"bottomLeft","abstract":"
Gradient positioned in the bottom left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO11bottomRightyA2CmF":{"name":"bottomRight","abstract":"
Gradient positioned in the bottom right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6insideyA2CmF":{"name":"inside","abstract":"
inner ring is inside the circle
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO5ontopyA2CmF":{"name":"ontop","abstract":"
inner ring is placed ontop of the outer ring
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dashedyACSay12CoreGraphics7CGFloatVG_tcACmF":{"name":"dashed(pattern:)","abstract":"
outer ring is dashed, the pattern list is how the dashes should appear
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dottedyA2CmF":{"name":"dotted","abstract":"
outer ring is dotted
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8gradientyAcA0A15GradientOptionsV_tcACmF":{"name":"gradient(options:)","abstract":"
inner ring is placed ontop of the outer ring and it has a gradient, look at UICircularGradientOptions
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8borderedyAC12CoreGraphics7CGFloatV_So7UIColorCtcACmF":{"name":"bordered(width:color:)","abstract":"
inner ring is placed ontop of the outer ring and outer ring has border
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html":{"name":"UICircularRingStyle","abstract":"
UICircularRingStyle
"},"Enums/UICircularRingGradientPosition.html":{"name":"UICircularRingGradientPosition","abstract":"
UICircularRingGradientPosition
"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO8finishedyA2EmF":{"name":"finished","abstract":"
the timer has finished
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO9continuedyAESdSg_tcAEmF":{"name":"continued(elapsedTime:)","abstract":"
the timer was continued called continueTimer
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO6pausedyAESdSg_tcAEmF":{"name":"paused(elpasedTime:)","abstract":"
the timer was paused called pauseTimer
","parent_name":"State"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C14valueFormatterAA0adcF0Cvp":{"name":"valueFormatter","abstract":"
The formatter used when formatting the value into a string for the ring.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C0D7Handlera":{"name":"TimerHandler","abstract":"
The handler for the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05startD02to7handlerySd_yAC5StateOcSgtF":{"name":"startTimer(to:handler:)","abstract":"
Starts the timer until the given time is elapsed.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05pauseD0yyF":{"name":"pauseTimer()","abstract":"
Pauses the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C08continueD0yyF":{"name":"continueTimer()","abstract":"
Continues the timer from a previously paused time.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05resetD0yyF":{"name":"resetTimer()","abstract":"
Resets the timer, this means the time is reset and","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing/State.html":{"name":"State","abstract":"
state of the timer ring, used in handler
","parent_name":"UICircularTimerRing"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC14valueIndicatorSSvp":{"name":"valueIndicator","abstract":"
The name of the value indicator the value label will","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC11rightToLeftSbvp":{"name":"rightToLeft","abstract":"
A toggle for either placing the value indicator right or left to the value","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC17showFloatingPointSbvp":{"name":"showFloatingPoint","abstract":"
A toggle for showing or hiding floating points from","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"
The amount of decimal places to show in the value label
","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC6string8forValueSSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
formats the value of the progress ring using the given properties
","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC5unitsSo14NSCalendarUnitVvp":{"name":"units","abstract":"
defines the units allowed to be used when converting string, by default [.minute, .second]
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC5styleSo016NSDateComponentsE10UnitsStyleVvp":{"name":"style","abstract":"
the style of the formatted string, by default .short
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC6string8forValueSSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
formats the value of the ring using the date components formatter with given units/style
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularRingValueFormatter.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter(im)stringForObjectValue:":{"name":"string(for:)","abstract":"
returns result of string(forValue:)
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRingValueFormatter.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter(im)getObjectValue:forString:errorDescription:":{"name":"getObjectValue(_:for:errorDescription:)","abstract":"
always returns false
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRingValueFormatter.html#/s:22UICircularProgressRing0aC14ValueFormatterC6string03forD0SSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
not implemented
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fullCircle":{"name":"fullCircle","abstract":"
Whether or not the progress ring should be a full circle.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C5styleAA0aC5StyleOvp":{"name":"style","abstract":"
The style of the progress ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)shouldShowValueText":{"name":"shouldShowValueText","abstract":"
A toggle for showing or hiding the value label.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C14valueKnobStyleAA0ac5ValueeF0VSgvp":{"name":"valueKnobStyle","abstract":"
Style for the value knob, default is nil.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)startAngle":{"name":"startAngle","abstract":"
The start angle for the entire progress ring view.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)endAngle":{"name":"endAngle","abstract":"
The end angle for the entire progress ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingWidth":{"name":"outerRingWidth","abstract":"
The width of the outer ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingColor":{"name":"outerRingColor","abstract":"
The color for the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13outerCapStyleSo06CGLineE0Vvp":{"name":"outerCapStyle","abstract":"
The style for the tip/cap of the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingWidth":{"name":"innerRingWidth","abstract":"
The width of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingColor":{"name":"innerRingColor","abstract":"
The color of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingSpacing":{"name":"innerRingSpacing","abstract":"
The spacing between the outer ring and inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13innerCapStyleSo06CGLineE0Vvp":{"name":"innerCapStyle","abstract":"
The style for the tip/cap of the inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fontColor":{"name":"fontColor","abstract":"
The text color for the value label field
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)font":{"name":"font","abstract":"
The font to be used for the progress indicator.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C11isAnimatingSbvp":{"name":"isAnimating","abstract":"
This returns whether or not the ring is currently animating
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)isClockwise":{"name":"isClockwise","abstract":"
The direction the circle is drawn in","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C27PropertyAnimationCompletiona":{"name":"PropertyAnimationCompletion","abstract":"
Typealias for animateProperties(duration:animations:completion:) fucntion completion
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(cpy)layerClass":{"name":"layerClass","abstract":"
Overrides the default layer with the custom UICircularRingLayer class
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithFrame:":{"name":"init(frame:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithCoder:":{"name":"init(coder:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)drawRect:":{"name":"draw(_:)","abstract":"
Overriden because of custom layer drawing in UICircularRingLayer
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animationsySd_yyXEtF":{"name":"animateProperties(duration:animations:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animations10completionySd_yyXEyycSgtF":{"name":"animateProperties(duration:animations:completion:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC8delegateAA0abC8Delegate_pSgXwvp":{"name":"delegate","abstract":"
The delegate for the UICircularRing
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)value":{"name":"value","abstract":"
The value property for the progress ring.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC12currentValue12CoreGraphics7CGFloatVSgvp":{"name":"currentValue","abstract":"
The current value of the progress ring
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)minValue":{"name":"minValue","abstract":"
The minimum value for the progress ring. ex: (0) -> 100.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)maxValue":{"name":"maxValue","abstract":"
The maximum value for the progress ring. ex: 0 -> (100)
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC23animationTimingFunctionSo07CAMediaeF4Nameavp":{"name":"animationTimingFunction","abstract":"
The type of animation function the ring view will use
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp":{"name":"valueFormatter","abstract":"
The formatter responsible for formatting the","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC0B10Completiona":{"name":"ProgressCompletion","abstract":"
Typealias for the startProgress(:) method closure
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05startB02to8duration10completiony12CoreGraphics7CGFloatV_SdyycSgtF":{"name":"startProgress(to:duration:completion:)","abstract":"
Sets the current value for the progress ring, calling this method while ring is","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05pauseB0yyF":{"name":"pauseProgress()","abstract":"
Pauses the currently running animation and halts all progress.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC08continueB0yyF":{"name":"continueProgress()","abstract":"
Continues the animation with its remaining time from where it left off before it was paused.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05resetB0yyF":{"name":"resetProgress()","abstract":"
Resets the progress back to the minValue of the progress ring.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html":{"name":"UICircularProgressRing","abstract":"
Undocumented
"},"Classes/UICircularRing.html":{"name":"UICircularRing","abstract":"
UICircularRing
"},"Classes/UICircularRingValueFormatter.html":{"name":"UICircularRingValueFormatter","abstract":"
UICricularRingValueFormatter
"},"Classes/UICircularTimerRingFormatter.html":{"name":"UICircularTimerRingFormatter","abstract":"
UICircularTimerRingFormatter
"},"Classes/UICircularProgressRingFormatter.html":{"name":"UICircularProgressRingFormatter","abstract":"
UICircularProgressRingFormatter
"},"Classes/UICircularTimerRing.html":{"name":"UICircularTimerRing","abstract":"
Undocumented
"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"
The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"
The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"
The following structures are available globally.
"}}
\ No newline at end of file
+{"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV14valueIndicatorSSvp":{"name":"valueIndicator","abstract":"
The name of the value indicator the value label will","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV11rightToLeftSbvp":{"name":"rightToLeft","abstract":"
A toggle for either placing the value indicator right or left to the value","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV17showFloatingPointSbvp":{"name":"showFloatingPoint","abstract":"
A toggle for showing or hiding floating points from","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"
The amount of decimal places to show in the value label
","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
formats the value of the progress ring using the given properties
","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV5unitsSo14NSCalendarUnitVvp":{"name":"units","abstract":"
defines the units allowed to be used when converting string, by default [.minute, .second]
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV5styleSo016NSDateComponentsE10UnitsStyleVvp":{"name":"style","abstract":"
the style of the formatted string, by default .short
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
formats the value of the ring using the date components formatter with given units/style
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV7defaultACvpZ":{"name":"default","abstract":"
a default styling option for the gradient style
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV13startPositionAA0acdG0Ovp":{"name":"startPosition","abstract":"
the start location for the gradient
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV11endPositionAA0acdG0Ovp":{"name":"endPosition","abstract":"
the end location for the gradient
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV6colorsSaySo7UIColorCGvp":{"name":"colors","abstract":"
the colors to use in the gradient, the count of this list must match the count of colorLocations
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV14colorLocationsSay12CoreGraphics7CGFloatVGvp":{"name":"colorLocations","abstract":"
the locations of where to place the colors, valid numbers are from 0.0 - 1.0
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV13startPosition03endG06colors14colorLocationsAcA0acdG0O_AISaySo7UIColorCGSay12CoreGraphics7CGFloatVGtcfc":{"name":"init(startPosition:endPosition:colors:colorLocations:)","abstract":"
create a new UICircularRingGradientOptions
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV7defaultACvpZ":{"name":"default","abstract":"
default implmementation of the knob style
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size12CoreGraphics7CGFloatVvp":{"name":"size","abstract":"
the size of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV5colorSo7UIColorCvp":{"name":"color","abstract":"
the color of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV10shadowBlur12CoreGraphics7CGFloatVvp":{"name":"shadowBlur","abstract":"
the amount of blur to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV12shadowOffsetSo6CGSizeVvp":{"name":"shadowOffset","abstract":"
the offset to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV11shadowColorSo7UIColorCvp":{"name":"shadowColor","abstract":"
the color for the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size5color10shadowBlur0I6Offset0I5ColorAC12CoreGraphics7CGFloatV_So7UIColorCAKSo6CGSizeVAMtcfc":{"name":"init(size:color:shadowBlur:shadowOffset:shadowColor:)","abstract":"
creates a new UICircularRingValueKnobStyle
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html":{"name":"UICircularRingValueKnobStyle","abstract":"
UICircularRingValueKnobStyle
"},"Structs/UICircularRingGradientOptions.html":{"name":"UICircularRingGradientOptions","abstract":"
UICircularRingGradientOptions
"},"Structs/UICircularTimerRingFormatter.html":{"name":"UICircularTimerRingFormatter","abstract":"
UICircularTimerRingFormatter
"},"Structs/UICircularProgressRingFormatter.html":{"name":"UICircularProgressRingFormatter","abstract":"
UICircularProgressRingFormatter
"},"Protocols/UICircularRingValueFormatter.html#/s:22UICircularProgressRing0aC14ValueFormatterP6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
returns a string for the given object
","parent_name":"UICircularRingValueFormatter"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didFinishB03foryA2AC_tF":{"name":"didFinishProgress(for:)","abstract":"
Called when progress ring is done animating for current value
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP08didPauseB03foryA2AC_tF":{"name":"didPauseProgress(for:)","abstract":"
Called when progress has paused
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP011didContinueB03foryA2AC_tF":{"name":"didContinueProgress(for:)","abstract":"
Called when the progress has continued after a pause
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didUpdateB5Value3for2toyA2AC_12CoreGraphics7CGFloatVtF":{"name":"didUpdateProgressValue(for:to:)","abstract":"
This method is called whenever the value is updated, this means during animation this method will be called in real time.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP16willDisplayLabel3for_yA2AC_So7UILabelCtF":{"name":"willDisplayLabel(for:_:)","abstract":"
This method is called whenever the label is about to be drawn.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html":{"name":"UICircularProgressRingDelegate","abstract":"
This is the protocol declaration for the UICircularRing delegate property
"},"Protocols/UICircularRingValueFormatter.html":{"name":"UICircularRingValueFormatter","abstract":"
UICircularRingValueFormatter
"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO3topyA2CmF":{"name":"top","abstract":"
Gradient positioned at the top
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO6bottomyA2CmF":{"name":"bottom","abstract":"
Gradient positioned at the bottom
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO4leftyA2CmF":{"name":"left","abstract":"
Gradient positioned to the left
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO5rightyA2CmF":{"name":"right","abstract":"
Gradient positioned to the right
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO7topLeftyA2CmF":{"name":"topLeft","abstract":"
Gradient positioned in the top left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO8topRightyA2CmF":{"name":"topRight","abstract":"
Gradient positioned in the top right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO10bottomLeftyA2CmF":{"name":"bottomLeft","abstract":"
Gradient positioned in the bottom left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO11bottomRightyA2CmF":{"name":"bottomRight","abstract":"
Gradient positioned in the bottom right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6insideyA2CmF":{"name":"inside","abstract":"
inner ring is inside the circle
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO5ontopyA2CmF":{"name":"ontop","abstract":"
inner ring is placed ontop of the outer ring
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dashedyACSay12CoreGraphics7CGFloatVG_tcACmF":{"name":"dashed(pattern:)","abstract":"
outer ring is dashed, the pattern list is how the dashes should appear
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dottedyA2CmF":{"name":"dotted","abstract":"
outer ring is dotted
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8borderedyAC12CoreGraphics7CGFloatV_So7UIColorCtcACmF":{"name":"bordered(width:color:)","abstract":"
inner ring is placed ontop of the outer ring and outer ring has border
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html":{"name":"UICircularRingStyle","abstract":"
UICircularRingStyle
"},"Enums/UICircularRingGradientPosition.html":{"name":"UICircularRingGradientPosition","abstract":"
UICircularRingGradientPosition
"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO8finishedyA2EmF":{"name":"finished","abstract":"
the timer has finished
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO9continuedyAESdSg_tcAEmF":{"name":"continued(elapsedTime:)","abstract":"
the timer was continued called continueTimer
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO6pausedyAESdSg_tcAEmF":{"name":"paused(elpasedTime:)","abstract":"
the timer was paused called pauseTimer
","parent_name":"State"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C14valueFormatterAA0ac5ValueF0_pvp":{"name":"valueFormatter","abstract":"
The formatter used when formatting the value into a string for the ring.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C0D7Handlera":{"name":"TimerHandler","abstract":"
The handler for the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05startD02to7handlerySd_yAC5StateOcSgtF":{"name":"startTimer(to:handler:)","abstract":"
Starts the timer until the given time is elapsed.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05pauseD0yyF":{"name":"pauseTimer()","abstract":"
Pauses the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C08continueD0yyF":{"name":"continueTimer()","abstract":"
Continues the timer from a previously paused time.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05resetD0yyF":{"name":"resetTimer()","abstract":"
Resets the timer, this means the time is reset and","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing/State.html":{"name":"State","abstract":"
state of the timer ring, used in handler
","parent_name":"UICircularTimerRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fullCircle":{"name":"fullCircle","abstract":"
Whether or not the progress ring should be a full circle.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C5styleAA0aC5StyleOvp":{"name":"style","abstract":"
The style of the progress ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C15gradientOptionsAA0ac8GradientE0VSgvp":{"name":"gradientOptions","abstract":"
The options for a gradient ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)shouldShowValueText":{"name":"shouldShowValueText","abstract":"
A toggle for showing or hiding the value label.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C14valueKnobStyleAA0ac5ValueeF0VSgvp":{"name":"valueKnobStyle","abstract":"
Style for the value knob, default is nil.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)startAngle":{"name":"startAngle","abstract":"
The start angle for the entire progress ring view.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)endAngle":{"name":"endAngle","abstract":"
The end angle for the entire progress ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingWidth":{"name":"outerRingWidth","abstract":"
The width of the outer ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingColor":{"name":"outerRingColor","abstract":"
The color for the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13outerCapStyleSo06CGLineE0Vvp":{"name":"outerCapStyle","abstract":"
The style for the tip/cap of the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingWidth":{"name":"innerRingWidth","abstract":"
The width of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingColor":{"name":"innerRingColor","abstract":"
The color of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingSpacing":{"name":"innerRingSpacing","abstract":"
The spacing between the outer ring and inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13innerCapStyleSo06CGLineE0Vvp":{"name":"innerCapStyle","abstract":"
The style for the tip/cap of the inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fontColor":{"name":"fontColor","abstract":"
The text color for the value label field
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)font":{"name":"font","abstract":"
The font to be used for the progress indicator.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C11isAnimatingSbvp":{"name":"isAnimating","abstract":"
This returns whether or not the ring is currently animating
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)isClockwise":{"name":"isClockwise","abstract":"
The direction the circle is drawn in","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C27PropertyAnimationCompletiona":{"name":"PropertyAnimationCompletion","abstract":"
Typealias for animateProperties(duration:animations:completion:) fucntion completion
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(cpy)layerClass":{"name":"layerClass","abstract":"
Overrides the default layer with the custom UICircularRingLayer class
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithFrame:":{"name":"init(frame:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithCoder:":{"name":"init(coder:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)drawRect:":{"name":"draw(_:)","abstract":"
Overriden because of custom layer drawing in UICircularRingLayer
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animationsySd_yyXEtF":{"name":"animateProperties(duration:animations:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animations10completionySd_yyXEyycSgtF":{"name":"animateProperties(duration:animations:completion:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC8delegateAA0abC8Delegate_pSgXwvp":{"name":"delegate","abstract":"
The delegate for the UICircularRing
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)value":{"name":"value","abstract":"
The value property for the progress ring.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC12currentValue12CoreGraphics7CGFloatVSgvp":{"name":"currentValue","abstract":"
The current value of the progress ring
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)minValue":{"name":"minValue","abstract":"
The minimum value for the progress ring. ex: (0) -> 100.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)maxValue":{"name":"maxValue","abstract":"
The maximum value for the progress ring. ex: 0 -> (100)
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC23animationTimingFunctionSo07CAMediaeF4Nameavp":{"name":"animationTimingFunction","abstract":"
The type of animation function the ring view will use
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp":{"name":"valueFormatter","abstract":"
The formatter responsible for formatting the","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC0B10Completiona":{"name":"ProgressCompletion","abstract":"
Typealias for the startProgress(:) method closure
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05startB02to8duration10completiony12CoreGraphics7CGFloatV_SdyycSgtF":{"name":"startProgress(to:duration:completion:)","abstract":"
Sets the current value for the progress ring, calling this method while ring is","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05pauseB0yyF":{"name":"pauseProgress()","abstract":"
Pauses the currently running animation and halts all progress.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC08continueB0yyF":{"name":"continueProgress()","abstract":"
Continues the animation with its remaining time from where it left off before it was paused.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05resetB0yyF":{"name":"resetProgress()","abstract":"
Resets the progress back to the minValue of the progress ring.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html":{"name":"UICircularProgressRing","abstract":"
Undocumented
"},"Classes/UICircularRing.html":{"name":"UICircularRing","abstract":"
UICircularRing
"},"Classes/UICircularTimerRing.html":{"name":"UICircularTimerRing","abstract":"
Undocumented
"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"
The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"
The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"
The following structures are available globally.
"}}
\ No newline at end of file
diff --git a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/docSet.dsidx b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/docSet.dsidx
index 00596b00..cba9f491 100644
Binary files a/docs/docsets/UICircularProgressRing.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/UICircularProgressRing.docset/Contents/Resources/docSet.dsidx differ
diff --git a/docs/docsets/UICircularProgressRing.tgz b/docs/docsets/UICircularProgressRing.tgz
index a7c3f09c..25da60a7 100644
Binary files a/docs/docsets/UICircularProgressRing.tgz and b/docs/docsets/UICircularProgressRing.tgz differ
diff --git a/docs/index.html b/docs/index.html
index f93b1b92..b6f00235 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -13,7 +13,7 @@
@@ -33,24 +33,15 @@
UICircularProgressRing
-
- UICircularProgressRingFormatter
-
UICircularRing
-
- UICircularRingValueFormatter
-
UICircularTimerRing
– State
-
- UICircularTimerRingFormatter
-
@@ -70,17 +61,26 @@
UICircularProgressRingDelegate
+
+ UICircularRingValueFormatter
+
Structures
@@ -103,7 +103,7 @@
Authors
diff --git a/docs/search.json b/docs/search.json
index 19f9edd4..3021e1ac 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-{"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV7defaultACvpZ":{"name":"default","abstract":"
a default styling option for the gradient style
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV13startPositionAA0acdG0Ovp":{"name":"startPosition","abstract":"
the start location for the gradient
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV11endPositionAA0acdG0Ovp":{"name":"endPosition","abstract":"
the end location for the gradient
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV6colorsSaySo7UIColorCGvp":{"name":"colors","abstract":"
the colors to use in the gradient, the count of this list must match the count of colorLocations
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV14colorLocationsSay12CoreGraphics7CGFloatVGvp":{"name":"colorLocations","abstract":"
the locations of where to place the colors, valid numbers are from 0.0 - 1.0
","parent_name":"UICircularGradientOptions"},"Structs/UICircularGradientOptions.html#/s:22UICircularProgressRing0A15GradientOptionsV13startPosition03endG06colors14colorLocationsAcA0acdG0O_AISaySo7UIColorCGSay12CoreGraphics7CGFloatVGtcfc":{"name":"init(startPosition:endPosition:colors:colorLocations:)","abstract":"
create a new UICircularGradientOptions
","parent_name":"UICircularGradientOptions"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV7defaultACvpZ":{"name":"default","abstract":"
default implmementation of the knob style
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size12CoreGraphics7CGFloatVvp":{"name":"size","abstract":"
the size of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV5colorSo7UIColorCvp":{"name":"color","abstract":"
the color of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV10shadowBlur12CoreGraphics7CGFloatVvp":{"name":"shadowBlur","abstract":"
the amount of blur to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV12shadowOffsetSo6CGSizeVvp":{"name":"shadowOffset","abstract":"
the offset to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV11shadowColorSo7UIColorCvp":{"name":"shadowColor","abstract":"
the color for the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size5color10shadowBlur0I6Offset0I5ColorAC12CoreGraphics7CGFloatV_So7UIColorCAKSo6CGSizeVAMtcfc":{"name":"init(size:color:shadowBlur:shadowOffset:shadowColor:)","abstract":"
creates a new UICircularRingValueKnobStyle
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html":{"name":"UICircularRingValueKnobStyle","abstract":"
UICircularRingValueKnobStyle
"},"Structs/UICircularGradientOptions.html":{"name":"UICircularGradientOptions","abstract":"
UICircularGradientOptions
"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didFinishB03foryA2AC_tF":{"name":"didFinishProgress(for:)","abstract":"
Called when progress ring is done animating for current value
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP08didPauseB03foryA2AC_tF":{"name":"didPauseProgress(for:)","abstract":"
Called when progress has paused
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP011didContinueB03foryA2AC_tF":{"name":"didContinueProgress(for:)","abstract":"
Called when the progress has continued after a pause
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didUpdateB5Value3for2toyA2AC_12CoreGraphics7CGFloatVtF":{"name":"didUpdateProgressValue(for:to:)","abstract":"
This method is called whenever the value is updated, this means during animation this method will be called in real time.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP16willDisplayLabel3for_yA2AC_So7UILabelCtF":{"name":"willDisplayLabel(for:_:)","abstract":"
This method is called whenever the label is about to be drawn.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html":{"name":"UICircularProgressRingDelegate","abstract":"
This is the protocol declaration for the UICircularRing delegate property
"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO3topyA2CmF":{"name":"top","abstract":"
Gradient positioned at the top
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO6bottomyA2CmF":{"name":"bottom","abstract":"
Gradient positioned at the bottom
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO4leftyA2CmF":{"name":"left","abstract":"
Gradient positioned to the left
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO5rightyA2CmF":{"name":"right","abstract":"
Gradient positioned to the right
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO7topLeftyA2CmF":{"name":"topLeft","abstract":"
Gradient positioned in the top left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO8topRightyA2CmF":{"name":"topRight","abstract":"
Gradient positioned in the top right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO10bottomLeftyA2CmF":{"name":"bottomLeft","abstract":"
Gradient positioned in the bottom left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO11bottomRightyA2CmF":{"name":"bottomRight","abstract":"
Gradient positioned in the bottom right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6insideyA2CmF":{"name":"inside","abstract":"
inner ring is inside the circle
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO5ontopyA2CmF":{"name":"ontop","abstract":"
inner ring is placed ontop of the outer ring
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dashedyACSay12CoreGraphics7CGFloatVG_tcACmF":{"name":"dashed(pattern:)","abstract":"
outer ring is dashed, the pattern list is how the dashes should appear
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dottedyA2CmF":{"name":"dotted","abstract":"
outer ring is dotted
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8gradientyAcA0A15GradientOptionsV_tcACmF":{"name":"gradient(options:)","abstract":"
inner ring is placed ontop of the outer ring and it has a gradient, look at UICircularGradientOptions
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8borderedyAC12CoreGraphics7CGFloatV_So7UIColorCtcACmF":{"name":"bordered(width:color:)","abstract":"
inner ring is placed ontop of the outer ring and outer ring has border
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html":{"name":"UICircularRingStyle","abstract":"
UICircularRingStyle
"},"Enums/UICircularRingGradientPosition.html":{"name":"UICircularRingGradientPosition","abstract":"
UICircularRingGradientPosition
"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO8finishedyA2EmF":{"name":"finished","abstract":"
the timer has finished
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO9continuedyAESdSg_tcAEmF":{"name":"continued(elapsedTime:)","abstract":"
the timer was continued called continueTimer
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO6pausedyAESdSg_tcAEmF":{"name":"paused(elpasedTime:)","abstract":"
the timer was paused called pauseTimer
","parent_name":"State"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C14valueFormatterAA0adcF0Cvp":{"name":"valueFormatter","abstract":"
The formatter used when formatting the value into a string for the ring.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C0D7Handlera":{"name":"TimerHandler","abstract":"
The handler for the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05startD02to7handlerySd_yAC5StateOcSgtF":{"name":"startTimer(to:handler:)","abstract":"
Starts the timer until the given time is elapsed.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05pauseD0yyF":{"name":"pauseTimer()","abstract":"
Pauses the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C08continueD0yyF":{"name":"continueTimer()","abstract":"
Continues the timer from a previously paused time.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05resetD0yyF":{"name":"resetTimer()","abstract":"
Resets the timer, this means the time is reset and","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing/State.html":{"name":"State","abstract":"
state of the timer ring, used in handler
","parent_name":"UICircularTimerRing"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC14valueIndicatorSSvp":{"name":"valueIndicator","abstract":"
The name of the value indicator the value label will","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC11rightToLeftSbvp":{"name":"rightToLeft","abstract":"
A toggle for either placing the value indicator right or left to the value","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC17showFloatingPointSbvp":{"name":"showFloatingPoint","abstract":"
A toggle for showing or hiding floating points from","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"
The amount of decimal places to show in the value label
","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterC6string8forValueSSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
formats the value of the progress ring using the given properties
","parent_name":"UICircularProgressRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC5unitsSo14NSCalendarUnitVvp":{"name":"units","abstract":"
defines the units allowed to be used when converting string, by default [.minute, .second]
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC5styleSo016NSDateComponentsE10UnitsStyleVvp":{"name":"style","abstract":"
the style of the formatted string, by default .short
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterC6string8forValueSSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
formats the value of the ring using the date components formatter with given units/style
","parent_name":"UICircularTimerRingFormatter"},"Classes/UICircularRingValueFormatter.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter(im)stringForObjectValue:":{"name":"string(for:)","abstract":"
returns result of string(forValue:)
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRingValueFormatter.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRingValueFormatter(im)getObjectValue:forString:errorDescription:":{"name":"getObjectValue(_:for:errorDescription:)","abstract":"
always returns false
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRingValueFormatter.html#/s:22UICircularProgressRing0aC14ValueFormatterC6string03forD0SSSg12CoreGraphics7CGFloatV_tF":{"name":"string(forValue:)","abstract":"
not implemented
","parent_name":"UICircularRingValueFormatter"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fullCircle":{"name":"fullCircle","abstract":"
Whether or not the progress ring should be a full circle.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C5styleAA0aC5StyleOvp":{"name":"style","abstract":"
The style of the progress ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)shouldShowValueText":{"name":"shouldShowValueText","abstract":"
A toggle for showing or hiding the value label.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C14valueKnobStyleAA0ac5ValueeF0VSgvp":{"name":"valueKnobStyle","abstract":"
Style for the value knob, default is nil.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)startAngle":{"name":"startAngle","abstract":"
The start angle for the entire progress ring view.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)endAngle":{"name":"endAngle","abstract":"
The end angle for the entire progress ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingWidth":{"name":"outerRingWidth","abstract":"
The width of the outer ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingColor":{"name":"outerRingColor","abstract":"
The color for the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13outerCapStyleSo06CGLineE0Vvp":{"name":"outerCapStyle","abstract":"
The style for the tip/cap of the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingWidth":{"name":"innerRingWidth","abstract":"
The width of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingColor":{"name":"innerRingColor","abstract":"
The color of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingSpacing":{"name":"innerRingSpacing","abstract":"
The spacing between the outer ring and inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13innerCapStyleSo06CGLineE0Vvp":{"name":"innerCapStyle","abstract":"
The style for the tip/cap of the inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fontColor":{"name":"fontColor","abstract":"
The text color for the value label field
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)font":{"name":"font","abstract":"
The font to be used for the progress indicator.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C11isAnimatingSbvp":{"name":"isAnimating","abstract":"
This returns whether or not the ring is currently animating
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)isClockwise":{"name":"isClockwise","abstract":"
The direction the circle is drawn in","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C27PropertyAnimationCompletiona":{"name":"PropertyAnimationCompletion","abstract":"
Typealias for animateProperties(duration:animations:completion:) fucntion completion
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(cpy)layerClass":{"name":"layerClass","abstract":"
Overrides the default layer with the custom UICircularRingLayer class
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithFrame:":{"name":"init(frame:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithCoder:":{"name":"init(coder:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)drawRect:":{"name":"draw(_:)","abstract":"
Overriden because of custom layer drawing in UICircularRingLayer
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animationsySd_yyXEtF":{"name":"animateProperties(duration:animations:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animations10completionySd_yyXEyycSgtF":{"name":"animateProperties(duration:animations:completion:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC8delegateAA0abC8Delegate_pSgXwvp":{"name":"delegate","abstract":"
The delegate for the UICircularRing
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)value":{"name":"value","abstract":"
The value property for the progress ring.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC12currentValue12CoreGraphics7CGFloatVSgvp":{"name":"currentValue","abstract":"
The current value of the progress ring
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)minValue":{"name":"minValue","abstract":"
The minimum value for the progress ring. ex: (0) -> 100.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)maxValue":{"name":"maxValue","abstract":"
The maximum value for the progress ring. ex: 0 -> (100)
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC23animationTimingFunctionSo07CAMediaeF4Nameavp":{"name":"animationTimingFunction","abstract":"
The type of animation function the ring view will use
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC14valueFormatterAA0abcE0Cvp":{"name":"valueFormatter","abstract":"
The formatter responsible for formatting the","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC0B10Completiona":{"name":"ProgressCompletion","abstract":"
Typealias for the startProgress(:) method closure
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05startB02to8duration10completiony12CoreGraphics7CGFloatV_SdyycSgtF":{"name":"startProgress(to:duration:completion:)","abstract":"
Sets the current value for the progress ring, calling this method while ring is","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05pauseB0yyF":{"name":"pauseProgress()","abstract":"
Pauses the currently running animation and halts all progress.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC08continueB0yyF":{"name":"continueProgress()","abstract":"
Continues the animation with its remaining time from where it left off before it was paused.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05resetB0yyF":{"name":"resetProgress()","abstract":"
Resets the progress back to the minValue of the progress ring.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html":{"name":"UICircularProgressRing","abstract":"
Undocumented
"},"Classes/UICircularRing.html":{"name":"UICircularRing","abstract":"
UICircularRing
"},"Classes/UICircularRingValueFormatter.html":{"name":"UICircularRingValueFormatter","abstract":"
UICricularRingValueFormatter
"},"Classes/UICircularTimerRingFormatter.html":{"name":"UICircularTimerRingFormatter","abstract":"
UICircularTimerRingFormatter
"},"Classes/UICircularProgressRingFormatter.html":{"name":"UICircularProgressRingFormatter","abstract":"
UICircularProgressRingFormatter
"},"Classes/UICircularTimerRing.html":{"name":"UICircularTimerRing","abstract":"
Undocumented
"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"
The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"
The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"
The following structures are available globally.
"}}
\ No newline at end of file
+{"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV14valueIndicatorSSvp":{"name":"valueIndicator","abstract":"
The name of the value indicator the value label will","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV11rightToLeftSbvp":{"name":"rightToLeft","abstract":"
A toggle for either placing the value indicator right or left to the value","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV17showFloatingPointSbvp":{"name":"showFloatingPoint","abstract":"
A toggle for showing or hiding floating points from","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV13decimalPlacesSivp":{"name":"decimalPlaces","abstract":"
The amount of decimal places to show in the value label
","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularProgressRingFormatter.html#/s:22UICircularProgressRing0abC9FormatterV6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
formats the value of the progress ring using the given properties
","parent_name":"UICircularProgressRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV5unitsSo14NSCalendarUnitVvp":{"name":"units","abstract":"
defines the units allowed to be used when converting string, by default [.minute, .second]
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV5styleSo016NSDateComponentsE10UnitsStyleVvp":{"name":"style","abstract":"
the style of the formatted string, by default .short
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularTimerRingFormatter.html#/s:22UICircularProgressRing0a5TimerC9FormatterV6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
formats the value of the ring using the date components formatter with given units/style
","parent_name":"UICircularTimerRingFormatter"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV7defaultACvpZ":{"name":"default","abstract":"
a default styling option for the gradient style
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV13startPositionAA0acdG0Ovp":{"name":"startPosition","abstract":"
the start location for the gradient
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV11endPositionAA0acdG0Ovp":{"name":"endPosition","abstract":"
the end location for the gradient
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV6colorsSaySo7UIColorCGvp":{"name":"colors","abstract":"
the colors to use in the gradient, the count of this list must match the count of colorLocations
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV14colorLocationsSay12CoreGraphics7CGFloatVGvp":{"name":"colorLocations","abstract":"
the locations of where to place the colors, valid numbers are from 0.0 - 1.0
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingGradientOptions.html#/s:22UICircularProgressRing0aC15GradientOptionsV13startPosition03endG06colors14colorLocationsAcA0acdG0O_AISaySo7UIColorCGSay12CoreGraphics7CGFloatVGtcfc":{"name":"init(startPosition:endPosition:colors:colorLocations:)","abstract":"
create a new UICircularRingGradientOptions
","parent_name":"UICircularRingGradientOptions"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV7defaultACvpZ":{"name":"default","abstract":"
default implmementation of the knob style
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size12CoreGraphics7CGFloatVvp":{"name":"size","abstract":"
the size of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV5colorSo7UIColorCvp":{"name":"color","abstract":"
the color of the knob
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV10shadowBlur12CoreGraphics7CGFloatVvp":{"name":"shadowBlur","abstract":"
the amount of blur to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV12shadowOffsetSo6CGSizeVvp":{"name":"shadowOffset","abstract":"
the offset to give the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV11shadowColorSo7UIColorCvp":{"name":"shadowColor","abstract":"
the color for the shadow
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html#/s:22UICircularProgressRing0aC14ValueKnobStyleV4size5color10shadowBlur0I6Offset0I5ColorAC12CoreGraphics7CGFloatV_So7UIColorCAKSo6CGSizeVAMtcfc":{"name":"init(size:color:shadowBlur:shadowOffset:shadowColor:)","abstract":"
creates a new UICircularRingValueKnobStyle
","parent_name":"UICircularRingValueKnobStyle"},"Structs/UICircularRingValueKnobStyle.html":{"name":"UICircularRingValueKnobStyle","abstract":"
UICircularRingValueKnobStyle
"},"Structs/UICircularRingGradientOptions.html":{"name":"UICircularRingGradientOptions","abstract":"
UICircularRingGradientOptions
"},"Structs/UICircularTimerRingFormatter.html":{"name":"UICircularTimerRingFormatter","abstract":"
UICircularTimerRingFormatter
"},"Structs/UICircularProgressRingFormatter.html":{"name":"UICircularProgressRingFormatter","abstract":"
UICircularProgressRingFormatter
"},"Protocols/UICircularRingValueFormatter.html#/s:22UICircularProgressRing0aC14ValueFormatterP6string3forSSSgyp_tF":{"name":"string(for:)","abstract":"
returns a string for the given object
","parent_name":"UICircularRingValueFormatter"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didFinishB03foryA2AC_tF":{"name":"didFinishProgress(for:)","abstract":"
Called when progress ring is done animating for current value
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP08didPauseB03foryA2AC_tF":{"name":"didPauseProgress(for:)","abstract":"
Called when progress has paused
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP011didContinueB03foryA2AC_tF":{"name":"didContinueProgress(for:)","abstract":"
Called when the progress has continued after a pause
","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP09didUpdateB5Value3for2toyA2AC_12CoreGraphics7CGFloatVtF":{"name":"didUpdateProgressValue(for:to:)","abstract":"
This method is called whenever the value is updated, this means during animation this method will be called in real time.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html#/s:22UICircularProgressRing0abC8DelegateP16willDisplayLabel3for_yA2AC_So7UILabelCtF":{"name":"willDisplayLabel(for:_:)","abstract":"
This method is called whenever the label is about to be drawn.","parent_name":"UICircularProgressRingDelegate"},"Protocols/UICircularProgressRingDelegate.html":{"name":"UICircularProgressRingDelegate","abstract":"
This is the protocol declaration for the UICircularRing delegate property
"},"Protocols/UICircularRingValueFormatter.html":{"name":"UICircularRingValueFormatter","abstract":"
UICircularRingValueFormatter
"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO3topyA2CmF":{"name":"top","abstract":"
Gradient positioned at the top
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO6bottomyA2CmF":{"name":"bottom","abstract":"
Gradient positioned at the bottom
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO4leftyA2CmF":{"name":"left","abstract":"
Gradient positioned to the left
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO5rightyA2CmF":{"name":"right","abstract":"
Gradient positioned to the right
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO7topLeftyA2CmF":{"name":"topLeft","abstract":"
Gradient positioned in the top left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO8topRightyA2CmF":{"name":"topRight","abstract":"
Gradient positioned in the top right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO10bottomLeftyA2CmF":{"name":"bottomLeft","abstract":"
Gradient positioned in the bottom left corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingGradientPosition.html#/s:22UICircularProgressRing0aC16GradientPositionO11bottomRightyA2CmF":{"name":"bottomRight","abstract":"
Gradient positioned in the bottom right corner
","parent_name":"UICircularRingGradientPosition"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6insideyA2CmF":{"name":"inside","abstract":"
inner ring is inside the circle
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO5ontopyA2CmF":{"name":"ontop","abstract":"
inner ring is placed ontop of the outer ring
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dashedyACSay12CoreGraphics7CGFloatVG_tcACmF":{"name":"dashed(pattern:)","abstract":"
outer ring is dashed, the pattern list is how the dashes should appear
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO6dottedyA2CmF":{"name":"dotted","abstract":"
outer ring is dotted
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html#/s:22UICircularProgressRing0aC5StyleO8borderedyAC12CoreGraphics7CGFloatV_So7UIColorCtcACmF":{"name":"bordered(width:color:)","abstract":"
inner ring is placed ontop of the outer ring and outer ring has border
","parent_name":"UICircularRingStyle"},"Enums/UICircularRingStyle.html":{"name":"UICircularRingStyle","abstract":"
UICircularRingStyle
"},"Enums/UICircularRingGradientPosition.html":{"name":"UICircularRingGradientPosition","abstract":"
UICircularRingGradientPosition
"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO8finishedyA2EmF":{"name":"finished","abstract":"
the timer has finished
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO9continuedyAESdSg_tcAEmF":{"name":"continued(elapsedTime:)","abstract":"
the timer was continued called continueTimer
","parent_name":"State"},"Classes/UICircularTimerRing/State.html#/s:22UICircularProgressRing0a5TimerC0C5StateO6pausedyAESdSg_tcAEmF":{"name":"paused(elpasedTime:)","abstract":"
the timer was paused called pauseTimer
","parent_name":"State"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C14valueFormatterAA0ac5ValueF0_pvp":{"name":"valueFormatter","abstract":"
The formatter used when formatting the value into a string for the ring.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C0D7Handlera":{"name":"TimerHandler","abstract":"
The handler for the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05startD02to7handlerySd_yAC5StateOcSgtF":{"name":"startTimer(to:handler:)","abstract":"
Starts the timer until the given time is elapsed.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05pauseD0yyF":{"name":"pauseTimer()","abstract":"
Pauses the timer.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C08continueD0yyF":{"name":"continueTimer()","abstract":"
Continues the timer from a previously paused time.
","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing.html#/s:22UICircularProgressRing0a5TimerC0C05resetD0yyF":{"name":"resetTimer()","abstract":"
Resets the timer, this means the time is reset and","parent_name":"UICircularTimerRing"},"Classes/UICircularTimerRing/State.html":{"name":"State","abstract":"
state of the timer ring, used in handler
","parent_name":"UICircularTimerRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fullCircle":{"name":"fullCircle","abstract":"
Whether or not the progress ring should be a full circle.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C5styleAA0aC5StyleOvp":{"name":"style","abstract":"
The style of the progress ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C15gradientOptionsAA0ac8GradientE0VSgvp":{"name":"gradientOptions","abstract":"
The options for a gradient ring.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)shouldShowValueText":{"name":"shouldShowValueText","abstract":"
A toggle for showing or hiding the value label.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C14valueKnobStyleAA0ac5ValueeF0VSgvp":{"name":"valueKnobStyle","abstract":"
Style for the value knob, default is nil.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)startAngle":{"name":"startAngle","abstract":"
The start angle for the entire progress ring view.
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)endAngle":{"name":"endAngle","abstract":"
The end angle for the entire progress ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingWidth":{"name":"outerRingWidth","abstract":"
The width of the outer ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)outerRingColor":{"name":"outerRingColor","abstract":"
The color for the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13outerCapStyleSo06CGLineE0Vvp":{"name":"outerCapStyle","abstract":"
The style for the tip/cap of the outer ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingWidth":{"name":"innerRingWidth","abstract":"
The width of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingColor":{"name":"innerRingColor","abstract":"
The color of the inner ring for the progres bar
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)innerRingSpacing":{"name":"innerRingSpacing","abstract":"
The spacing between the outer ring and inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C13innerCapStyleSo06CGLineE0Vvp":{"name":"innerCapStyle","abstract":"
The style for the tip/cap of the inner ring
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)fontColor":{"name":"fontColor","abstract":"
The text color for the value label field
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)font":{"name":"font","abstract":"
The font to be used for the progress indicator.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C11isAnimatingSbvp":{"name":"isAnimating","abstract":"
This returns whether or not the ring is currently animating
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(py)isClockwise":{"name":"isClockwise","abstract":"
The direction the circle is drawn in","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C27PropertyAnimationCompletiona":{"name":"PropertyAnimationCompletion","abstract":"
Typealias for animateProperties(duration:animations:completion:) fucntion completion
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(cpy)layerClass":{"name":"layerClass","abstract":"
Overrides the default layer with the custom UICircularRingLayer class
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithFrame:":{"name":"init(frame:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)initWithCoder:":{"name":"init(coder:)","abstract":"
Overriden public init to initialize the layer and view
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularRing(im)drawRect:":{"name":"draw(_:)","abstract":"
Overriden because of custom layer drawing in UICircularRingLayer
","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animationsySd_yyXEtF":{"name":"animateProperties(duration:animations:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularRing.html#/s:22UICircularProgressRing0aC0C17animateProperties8duration10animations10completionySd_yyXEyycSgtF":{"name":"animateProperties(duration:animations:completion:)","abstract":"
This function allows animation of the animatable properties of the UICircularRing.","parent_name":"UICircularRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC8delegateAA0abC8Delegate_pSgXwvp":{"name":"delegate","abstract":"
The delegate for the UICircularRing
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)value":{"name":"value","abstract":"
The value property for the progress ring.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC12currentValue12CoreGraphics7CGFloatVSgvp":{"name":"currentValue","abstract":"
The current value of the progress ring
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)minValue":{"name":"minValue","abstract":"
The minimum value for the progress ring. ex: (0) -> 100.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/c:@M@UICircularProgressRing@objc(cs)UICircularProgressRing(py)maxValue":{"name":"maxValue","abstract":"
The maximum value for the progress ring. ex: 0 -> (100)
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC23animationTimingFunctionSo07CAMediaeF4Nameavp":{"name":"animationTimingFunction","abstract":"
The type of animation function the ring view will use
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC14valueFormatterAA0ac5ValueE0_pvp":{"name":"valueFormatter","abstract":"
The formatter responsible for formatting the","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC0B10Completiona":{"name":"ProgressCompletion","abstract":"
Typealias for the startProgress(:) method closure
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05startB02to8duration10completiony12CoreGraphics7CGFloatV_SdyycSgtF":{"name":"startProgress(to:duration:completion:)","abstract":"
Sets the current value for the progress ring, calling this method while ring is","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05pauseB0yyF":{"name":"pauseProgress()","abstract":"
Pauses the currently running animation and halts all progress.
","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC08continueB0yyF":{"name":"continueProgress()","abstract":"
Continues the animation with its remaining time from where it left off before it was paused.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html#/s:22UICircularProgressRingAAC05resetB0yyF":{"name":"resetProgress()","abstract":"
Resets the progress back to the minValue of the progress ring.","parent_name":"UICircularProgressRing"},"Classes/UICircularProgressRing.html":{"name":"UICircularProgressRing","abstract":"
Undocumented
"},"Classes/UICircularRing.html":{"name":"UICircularRing","abstract":"
UICircularRing
"},"Classes/UICircularTimerRing.html":{"name":"UICircularTimerRing","abstract":"
Undocumented
"},"Classes.html":{"name":"Classes","abstract":"
The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"
The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"
The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"
The following structures are available globally.
"}}
\ No newline at end of file
diff --git a/run-jazzy.sh b/run-jazzy.sh
index e9ce0ab5..385773e0 100755
--- a/run-jazzy.sh
+++ b/run-jazzy.sh
@@ -1,4 +1,4 @@
#!/bin/bash
-jazzy --clean --source-directory src --output docs -a Luis Padron -u https://luispadron.com -m UICircularProgressRing --module-version 5.0.0 -g https://github.com/luispadron/UICircularProgressRing --theme apple
+jazzy --clean --source-directory src --output docs -a Luis Padron -u https://luispadron.com -m UICircularProgressRing --module-version 6.0.0 -g https://github.com/luispadron/UICircularProgressRing --theme apple
diff --git a/src/UICircularProgressRing.xcodeproj/project.pbxproj b/src/UICircularProgressRing.xcodeproj/project.pbxproj
index d3053b10..51a383ef 100644
--- a/src/UICircularProgressRing.xcodeproj/project.pbxproj
+++ b/src/UICircularProgressRing.xcodeproj/project.pbxproj
@@ -12,6 +12,7 @@
A024AE91220A37C600D3DE5D /* Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = A024AE90220A37C600D3DE5D /* Extensions.swift */; };
A024AE93220A395200D3DE5D /* UICircularTimerRing.swift in Sources */ = {isa = PBXBuildFile; fileRef = A024AE92220A395200D3DE5D /* UICircularTimerRing.swift */; };
A034CFFD220D53D5007273AA /* UICircularTimerRingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A034CFFC220D53D5007273AA /* UICircularTimerRingTests.swift */; };
+ A05250D92220854F007E8573 /* ValueFormatterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A05250D82220854F007E8573 /* ValueFormatterTests.swift */; };
A05EDE10220A15FD006FCF1E /* UICircularProgressRing.swift in Sources */ = {isa = PBXBuildFile; fileRef = A05EDE0F220A15FD006FCF1E /* UICircularProgressRing.swift */; };
A0801C1720E3185D009DC236 /* UICircularRing.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0801C1620E3185D009DC236 /* UICircularRing.swift */; };
A0A9E37C220CE33F00EB0861 /* UICircularRingValueFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0A9E37B220CE33F00EB0861 /* UICircularRingValueFormatter.swift */; };
@@ -38,6 +39,7 @@
A024AE90220A37C600D3DE5D /* Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Extensions.swift; sourceTree = "
"; };
A024AE92220A395200D3DE5D /* UICircularTimerRing.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UICircularTimerRing.swift; sourceTree = ""; };
A034CFFC220D53D5007273AA /* UICircularTimerRingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UICircularTimerRingTests.swift; sourceTree = ""; };
+ A05250D82220854F007E8573 /* ValueFormatterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ValueFormatterTests.swift; sourceTree = ""; };
A05EDE0F220A15FD006FCF1E /* UICircularProgressRing.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UICircularProgressRing.swift; sourceTree = ""; };
A0801C1620E3185D009DC236 /* UICircularRing.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UICircularRing.swift; sourceTree = ""; };
A0A9E37B220CE33F00EB0861 /* UICircularRingValueFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UICircularRingValueFormatter.swift; sourceTree = ""; };
@@ -112,6 +114,7 @@
A0C6DE8A1D88CBE2008AE742 /* UICircularProgressRingTests.swift */,
A034CFFC220D53D5007273AA /* UICircularTimerRingTests.swift */,
A0C6DE8C1D88CBE2008AE742 /* Info.plist */,
+ A05250D82220854F007E8573 /* ValueFormatterTests.swift */,
);
path = UICircularProgressRingTests;
sourceTree = "";
@@ -262,6 +265,7 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
+ A05250D92220854F007E8573 /* ValueFormatterTests.swift in Sources */,
A034CFFD220D53D5007273AA /* UICircularTimerRingTests.swift in Sources */,
AB8F17E5212522C100CFB95E /* UICircularProgressRingPauseResetTests.swift in Sources */,
A0C6DE8B1D88CBE2008AE742 /* UICircularProgressRingTests.swift in Sources */,
diff --git a/src/UICircularProgressRing/UICircularProgressRing.swift b/src/UICircularProgressRing/UICircularProgressRing.swift
index f3916dd6..ffd9273b 100644
--- a/src/UICircularProgressRing/UICircularProgressRing.swift
+++ b/src/UICircularProgressRing/UICircularProgressRing.swift
@@ -159,7 +159,7 @@ final public class UICircularProgressRing: UICircularRing {
## Author
Luis Padron
*/
- public var valueFormatter = UICircularProgressRingFormatter() {
+ public var valueFormatter: UICircularRingValueFormatter = UICircularProgressRingFormatter() {
didSet { ringLayer.valueFormatter = valueFormatter }
}
diff --git a/src/UICircularProgressRing/UICircularRing.swift b/src/UICircularProgressRing/UICircularRing.swift
index b152e85c..a6309268 100644
--- a/src/UICircularProgressRing/UICircularRing.swift
+++ b/src/UICircularProgressRing/UICircularRing.swift
@@ -85,6 +85,18 @@ import UIKit
didSet { ringLayer.setNeedsDisplay() }
}
+ /**
+ The options for a gradient ring.
+
+ If this is non-`nil` then a gradient style will be applied.
+
+ ## Important ##
+ Default = `nil`
+ */
+ open var gradientOptions: UICircularRingGradientOptions? = nil {
+ didSet { ringLayer.setNeedsDisplay() }
+ }
+
/**
A toggle for showing or hiding the value label.
If false the current value will not be shown.
diff --git a/src/UICircularProgressRing/UICircularRingLayer.swift b/src/UICircularProgressRing/UICircularRingLayer.swift
index 0b07c5b5..7d2b39bd 100644
--- a/src/UICircularProgressRing/UICircularRingLayer.swift
+++ b/src/UICircularProgressRing/UICircularRingLayer.swift
@@ -44,7 +44,7 @@ class UICircularRingLayer: CAShapeLayer {
@NSManaged weak var ring: UICircularRing!
/// formatter for the text of the value label
- @NSManaged var valueFormatter: UICircularRingValueFormatter?
+ var valueFormatter: UICircularRingValueFormatter?
/// the style for the value knob
var valueKnobStyle: UICircularRingValueKnobStyle?
@@ -197,16 +197,16 @@ class UICircularRingLayer: CAShapeLayer {
ctx.addPath(innerPath.cgPath)
ctx.drawPath(using: .stroke)
- if case let UICircularRingStyle.gradient(options) = ring.style {
+ if let gradientOptions = ring.gradientOptions {
// Create gradient and draw it
var cgColors: [CGColor] = [CGColor]()
- for color: UIColor in options.colors {
+ for color: UIColor in gradientOptions.colors {
cgColors.append(color.cgColor)
}
guard let gradient: CGGradient = CGGradient(colorsSpace: nil,
colors: cgColors as CFArray,
- locations: options.colorLocations)
+ locations: gradientOptions.colorLocations)
else {
fatalError("\nUnable to create gradient for progress ring.\n" +
"Check values of gradientColors and gradientLocations.\n")
@@ -218,8 +218,8 @@ class UICircularRingLayer: CAShapeLayer {
ctx.clip()
drawGradient(gradient,
- start: options.startPosition,
- end: options.endPosition,
+ start: gradientOptions.startPosition,
+ end: gradientOptions.endPosition,
in: ctx)
ctx.restoreGState()
@@ -302,7 +302,7 @@ class UICircularRingLayer: CAShapeLayer {
let knobSize = ring.valueKnobStyle?.size ?? 0
switch ring.style {
- case .inside, .gradient:
+ case .inside:
let difference = ring.outerRingWidth * 2 + ring.innerRingSpacing + knobSize / 2
let offSet = ring.innerRingWidth / 2 + knobSize / 2
radiusIn = (min(bounds.width - difference, bounds.height - difference) / 2) - offSet
@@ -366,7 +366,7 @@ class UICircularRingLayer: CAShapeLayer {
valueLabel.font = ring.font
valueLabel.textAlignment = .center
valueLabel.textColor = ring.fontColor
- valueLabel.text = valueFormatter?.string(forValue: value)
+ valueLabel.text = valueFormatter?.string(for: value)
ring.willDisplayLabel(label: valueLabel)
valueLabel.sizeToFit()
diff --git a/src/UICircularProgressRing/UICircularRingStyle.swift b/src/UICircularProgressRing/UICircularRingStyle.swift
index 6c47fea4..268eaf5a 100644
--- a/src/UICircularProgressRing/UICircularRingStyle.swift
+++ b/src/UICircularProgressRing/UICircularRingStyle.swift
@@ -50,9 +50,6 @@ public enum UICircularRingStyle {
/// outer ring is dotted
case dotted
- /// inner ring is placed ontop of the outer ring and it has a gradient, look at `UICircularGradientOptions`
- case gradient(options: UICircularGradientOptions)
-
/// inner ring is placed ontop of the outer ring and outer ring has border
case bordered(width: CGFloat, color: UIColor)
}
@@ -157,20 +154,20 @@ public enum UICircularRingGradientPosition {
}
}
-// MARK: UICircularGradientOptions
+// MARK: UICircularRingGradientOptions
/**
- UICircularGradientOptions
+ UICircularRingGradientOptions
Struct for defining the options for the UICircularRingStyle.gradient case.
## Important ##
Make sure the number of `colors` is equal to the number of `colorLocations`
*/
-public struct UICircularGradientOptions {
+public struct UICircularRingGradientOptions {
/// a default styling option for the gradient style
- public static let `default` = UICircularGradientOptions(startPosition: .topRight,
+ public static let `default` = UICircularRingGradientOptions(startPosition: .topRight,
endPosition: .bottomLeft,
colors: [.red, .blue],
colorLocations: [0, 1])
@@ -187,7 +184,7 @@ public struct UICircularGradientOptions {
/// the locations of where to place the colors, valid numbers are from 0.0 - 1.0
public let colorLocations: [CGFloat]
- /// create a new UICircularGradientOptions
+ /// create a new UICircularRingGradientOptions
public init(startPosition: UICircularRingGradientPosition,
endPosition: UICircularRingGradientPosition,
colors: [UIColor],
diff --git a/src/UICircularProgressRing/UICircularRingValueFormatter.swift b/src/UICircularProgressRing/UICircularRingValueFormatter.swift
index 4f834eba..d2d5f342 100644
--- a/src/UICircularProgressRing/UICircularRingValueFormatter.swift
+++ b/src/UICircularProgressRing/UICircularRingValueFormatter.swift
@@ -11,33 +11,14 @@ import Foundation
// MARK: UICircularRingValueFormatter
/**
- UICricularRingValueFormatter
+ UICircularRingValueFormatter
- The base class for all the UICircularRing formatters.
- Subclasses should implement `string(forValue:)` as this is used
- to format the value into a string in the base class
+ Any custom formatter must conform to this protocol.
- Two concrete implementations are provided, refer to `UICircularTimerRingFormatter`
- and `UICircularProgressRingFormatter`
*/
-open class UICircularRingValueFormatter: Formatter {
- /// returns result of `string(forValue:)`
- open override func string(for obj: Any?) -> String? {
- guard let value = obj as? CGFloat else { return nil }
- return string(forValue: value)
- }
-
- /// always returns false
- open override func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer?,
- for string: String,
- errorDescription error: AutoreleasingUnsafeMutablePointer?) -> Bool {
- return false
- }
-
- /// not implemented
- open func string(forValue value: CGFloat) -> String? {
- fatalError("UICircularRingValueFormatter: string(forValue:) should be implemented when subclassing")
- }
+public protocol UICircularRingValueFormatter {
+ /// returns a string for the given object
+ func string(for value: Any) -> String?
}
// MARK: UICircularTimerRingFormatter
@@ -48,7 +29,7 @@ open class UICircularRingValueFormatter: Formatter {
The formatter used in UICircularTimerRing class, formats
the ring value into a time string.
*/
-final public class UICircularTimerRingFormatter: UICircularRingValueFormatter {
+public struct UICircularTimerRingFormatter: UICircularRingValueFormatter {
// MARK: Members
/// defines the units allowed to be used when converting string, by default `[.minute, .second]`
@@ -62,17 +43,18 @@ final public class UICircularTimerRingFormatter: UICircularRingValueFormatter {
}
/// formatter which formats the time string of the ring label
- private lazy var formatter: DateComponentsFormatter = {
+ private var formatter: DateComponentsFormatter {
let formatter = DateComponentsFormatter()
formatter.allowedUnits = units
formatter.unitsStyle = style
return formatter
- }()
+ }
// MARK: API
/// formats the value of the ring using the date components formatter with given units/style
- public override func string(forValue value: CGFloat) -> String? {
+ public func string(for value: Any) -> String? {
+ guard let value = value as? CGFloat else { return nil }
return formatter.string(from: value.interval)
}
}
@@ -85,7 +67,7 @@ final public class UICircularTimerRingFormatter: UICircularRingValueFormatter {
The formatter used in UICircularProgressRing class,
responsible for formatting the value of the ring into a readable string
*/
-final public class UICircularProgressRingFormatter: UICircularRingValueFormatter {
+public struct UICircularProgressRingFormatter: UICircularRingValueFormatter {
// MARK: Members
@@ -142,7 +124,9 @@ final public class UICircularProgressRingFormatter: UICircularRingValueFormatter
public var decimalPlaces: Int = 2
/// formats the value of the progress ring using the given properties
- public override func string(forValue value: CGFloat) -> String? {
+ public func string(for value: Any) -> String? {
+ guard let value = value as? CGFloat else { return nil }
+
if rightToLeft {
if showFloatingPoint {
return "\(valueIndicator)" + String(format: "%.\(decimalPlaces)f", value)
diff --git a/src/UICircularProgressRingTests/UICircularProgressRingTests.swift b/src/UICircularProgressRingTests/UICircularProgressRingTests.swift
index b60c56ad..28a0fabd 100644
--- a/src/UICircularProgressRingTests/UICircularProgressRingTests.swift
+++ b/src/UICircularProgressRingTests/UICircularProgressRingTests.swift
@@ -67,14 +67,15 @@ class UICircularProgressRingTests: XCTestCase {
XCTAssertEqual(progressRing.maxValue, 200)
XCTAssertEqual(progressRing.ringLayer.maxValue, 200)
+ var formatter = UICircularProgressRingFormatter()
+ formatter.valueIndicator = " GB"
+ formatter.showFloatingPoint = true
+ formatter.decimalPlaces = 1
+ progressRing.valueFormatter = formatter
+
let layerFormatter = progressRing.ringLayer.valueFormatter as! UICircularProgressRingFormatter
- progressRing.valueFormatter.valueIndicator = " GB"
XCTAssertEqual(layerFormatter.valueIndicator, " GB")
-
- progressRing.valueFormatter.showFloatingPoint = true
XCTAssertEqual(layerFormatter.showFloatingPoint, true)
-
- progressRing.valueFormatter.decimalPlaces = 1
XCTAssertEqual(layerFormatter.decimalPlaces, 1)
progressRing.animationTimingFunction = .linear
diff --git a/src/UICircularProgressRingTests/ValueFormatterTests.swift b/src/UICircularProgressRingTests/ValueFormatterTests.swift
new file mode 100644
index 00000000..f21ebeb4
--- /dev/null
+++ b/src/UICircularProgressRingTests/ValueFormatterTests.swift
@@ -0,0 +1,27 @@
+//
+// ValueFormatterTests.swift
+// UICircularProgressRingTests
+//
+// Created by Luis on 2/22/19.
+// Copyright © 2019 Luis Padron. All rights reserved.
+//
+
+import XCTest
+@testable import UICircularProgressRing
+
+final class ValueFormatterTests: XCTestCase {
+
+ struct LameFormatter: UICircularRingValueFormatter {
+ func string(for value: Any) -> String? {
+ guard let value = value as? CGFloat else { return nil }
+ return "Lame \(value)"
+ }
+ }
+
+ func testCustomFormatter() {
+ let formatter = LameFormatter()
+ XCTAssertEqual(formatter.string(for: CGFloat(69.420))!, "Lame 69.42")
+ XCTAssertNil(formatter.string(for: "Wow this should fail!"))
+ }
+
+}
View on GitHub
View on GitHub
- UICircularRingValueFormatter Class Reference
- 
View on GitHub