adding interpolator view to verify schemes

Author: heckj

Sources/SwiftVizScale/ColorInterpolator.swift

@@ -57,10 +57,12 @@ public struct ColorInterpolator {
     /// - Parameters:
     ///   - colors: The sequences of colors to map through.
     public init(_ colors: [CGColor]) {
-        precondition(colors.count > 2, "ArrayInterpolator requires at least 2 colors.")
+        precondition(colors.count > 2, "ColorInterpolator requires at least 2 colors.")
         self.colors = colors
     }
 
+    /// Creates a new color interpolator using sequences of 6 Hex Digits to represent a color.
+    /// - Parameter hexSequence: The sequence to convert into the colors.
     public init(_ hexSequence: String) {
         precondition(hexSequence.count >= 12)
         let colors = CGColor.fromHexSequence(hexSequence)

Sources/SwiftVizScale/Documentation.docc/ColorInterpolator.md

@@ -2,14 +2,52 @@
 
 ## Topics
 
-### Creating an Interpolator
+### Sequential Single Hue Color Schemes
 
 - ``SwiftVizScale/ColorInterpolator/Grays``
 - ``SwiftVizScale/ColorInterpolator/Blues``
 - ``SwiftVizScale/ColorInterpolator/Greens``
 - ``SwiftVizScale/ColorInterpolator/Reds``
+- ``SwiftVizScale/ColorInterpolator/Oranges``
+- ``SwiftVizScale/ColorInterpolator/Purples``
+
+### Sequential Multi Hue Color Schemes
+
+- ``SwiftVizScale/ColorInterpolator/BuGn``
+- ``SwiftVizScale/ColorInterpolator/BuPu``
+- ``SwiftVizScale/ColorInterpolator/GnBu``
+- ``SwiftVizScale/ColorInterpolator/OrRd``
+- ``SwiftVizScale/ColorInterpolator/PuBu``
+- ``SwiftVizScale/ColorInterpolator/PuBuGn``
+- ``SwiftVizScale/ColorInterpolator/PuRd``
+- ``SwiftVizScale/ColorInterpolator/RdPu``
+- ``SwiftVizScale/ColorInterpolator/RdPu``
+- ``SwiftVizScale/ColorInterpolator/YlGn``
+- ``SwiftVizScale/ColorInterpolator/YlGnBu``
+- ``SwiftVizScale/ColorInterpolator/YlOrBr``
+- ``SwiftVizScale/ColorInterpolator/YlOrRd``
+- ``SwiftVizScale/ColorInterpolator/Viridis``
+- ``SwiftVizScale/ColorInterpolator/Inferno``
+- ``SwiftVizScale/ColorInterpolator/Magma``
+- ``SwiftVizScale/ColorInterpolator/Plasma``
+
+### Diverging Color Schemes
+
+- ``SwiftVizScale/ColorInterpolator/BrBG``
+- ``SwiftVizScale/ColorInterpolator/PrGN``
+- ``SwiftVizScale/ColorInterpolator/PiYG``
+- ``SwiftVizScale/ColorInterpolator/PuOR``
+- ``SwiftVizScale/ColorInterpolator/RdBu``
+- ``SwiftVizScale/ColorInterpolator/RdGy``
+- ``SwiftVizScale/ColorInterpolator/RdYlBu``
+- ``SwiftVizScale/ColorInterpolator/RdYlGn``
+- ``SwiftVizScale/ColorInterpolator/Spectral``
+
+### Creating an Interpolator
+
+- ``SwiftVizScale/ColorInterpolator/init(_:)-417qd``
+- ``SwiftVizScale/ColorInterpolator/init(_:)-5lx8r``
 - ``SwiftVizScale/ColorInterpolator/init(_:_:)``
-- ``SwiftVizScale/ColorInterpolator/init(_:)``
 
 ### Mapping values to colors
 

Sources/VisualTests/ColorInterpolatorView.swift

@@ -0,0 +1,37 @@
+//
+//  ColorInterpolatorView.swift
+//
+
+import SwiftUI
+@testable import SwiftVizScale
+
+@available(macOS 12.0, iOS 15.0, *)
+struct ColorInterpolatorView: View {
+    var steps: CGFloat
+    var interpolator: ColorInterpolator
+
+    func color(_ stepValue: Int) -> CGColor {
+        let t = normalize(Double(stepValue),
+                          lower: 0.0,
+                          higher: steps - 1)
+        return interpolator.interpolate(t)
+    }
+
+    var body: some View {
+        GeometryReader { proxy in
+            HStack(spacing: 0.0) {
+                ForEach(0 ... Int(steps - 1), id: \.self) { stepValue in
+                    Color(cgColor: color(stepValue))
+                        .frame(width: proxy.size.width / steps)
+                }
+            }
+        }
+    }
+}
+
+@available(macOS 12.0, iOS 15.0, *)
+struct ColorInterpolatorView_Previews: PreviewProvider {
+    static var previews: some View {
+        ColorInterpolatorView(steps: 128, interpolator: .Viridis)
+    }
+}

docs/data/documentation/swiftvizscale.json

@@ -1 +1 @@
-{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftvizscale\/band\/higher"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/higher","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"title":"higher","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13SwiftVizScale4BandV6higherq_vp","modules":[{"name":"SwiftVizScale"}]},"hierarchy":{"paths":[["doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band"]]},"seeAlsoSections":[{"title":"Inspecting a Band","identifiers":["doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/middle","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/lower","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/value"],"generated":true}],"references":{"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/lower":{"role":"symbol","title":"lower","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"lower"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/lower","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/lower"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/middle":{"role":"symbol","title":"middle","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"middle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/middle","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/middle"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale":{"role":"collection","title":"SwiftVizScale","abstract":[{"type":"text","text":"A collection of components to provide structures that support data visualization."}],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/higher":{"role":"symbol","title":"higher","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/higher","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/higher"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band":{"role":"symbol","title":"Band","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Band"}],"abstract":[{"type":"text","text":"A type used to indicate the start and stop positions for a band associated with the provided value."}],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Band"}],"url":"\/documentation\/swiftvizscale\/band"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/value":{"role":"symbol","title":"value","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"EnclosedType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/value","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/value"}}}
+{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftvizscale\/band\/higher"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/higher","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"title":"higher","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13SwiftVizScale4BandV6higherq_vp","modules":[{"name":"SwiftVizScale"}]},"hierarchy":{"paths":[["doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band"]]},"seeAlsoSections":[{"title":"Inspecting a Band","identifiers":["doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/middle","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/lower","doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/value"],"generated":true}],"references":{"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale":{"role":"collection","title":"SwiftVizScale","abstract":[{"type":"text","text":"A collection of components to provide structures that support data visualization."}],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/higher":{"role":"symbol","title":"higher","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"higher"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/higher","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/higher"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/lower":{"role":"symbol","title":"lower","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"lower"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/lower","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/lower"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/value":{"role":"symbol","title":"value","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"value"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"EnclosedType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/value","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/value"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band":{"role":"symbol","title":"Band","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Band"}],"abstract":[{"type":"text","text":"A type used to indicate the start and stop positions for a band associated with the provided value."}],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Band"}],"url":"\/documentation\/swiftvizscale\/band"},"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/Band/middle":{"role":"symbol","title":"middle","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"middle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"RangeType"}],"abstract":[],"identifier":"doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/Band\/middle","kind":"symbol","type":"topic","url":"\/documentation\/swiftvizscale\/band\/middle"}}}