Add support for color range with units (#27)

Author: eliascarv

ext/ColorfyUnitfulExt.jl

@@ -14,4 +14,6 @@ function Colorfy.getcolors(colorfier::Colorfier{<:Values{Quantity}})
   Colorfy.getcolors(ucolorfier)
 end
 
+Colorfy.ascolorrange(colorrange::NTuple{2,Quantity}) = Colorfy.ascolorrange(ustrip.(colorrange))
+
 end

src/Colorfy.jl

@@ -37,7 +37,7 @@ Colorfier(
   alphas=defaultalphas(values),
   colorscheme=defaultcolorscheme(values),
   colorrange=defaultcolorrange(values)
-) = Colorfier(values, asalphas(alphas, values), ascolorscheme(colorscheme), colorrange)
+) = Colorfier(values, asalphas(alphas, values), ascolorscheme(colorscheme), ascolorrange(colorrange))
 
 """
     colorfy(values; kwargs...)
@@ -131,6 +131,37 @@ Default color range for `values`.
 """
 defaultcolorrange(_) = :extrema
 
+"""
+    Colorfy.asalphas(alphas, values)
+
+Valid color alphas for a given `alphas` and `values`.
+"""
+asalphas(alpha, values) = fill(alpha, length(values))
+function asalphas(alphas::AbstractVector, values)
+  if length(alphas) ≠ length(values)
+    throw(ArgumentError("the number of alphas must be equal to the number of values"))
+  end
+  alphas
+end
+
+"""
+    Colorfy.ascolorscheme(colorscheme)
+
+Valid `ColorScheme` object for a given `colorscheme`.
+"""
+ascolorscheme(colorscheme::Symbol) = colorschemes[colorscheme]
+ascolorscheme(colorscheme::AbstractString) = ascolorscheme(Symbol(colorscheme))
+ascolorscheme(colorscheme::ColorScheme) = colorscheme
+
+"""
+    Colorfy.ascolorrange(colorrange)
+
+Valid color range, accepted by the `ColorSchemes.get` function, for a given `colorrange`.
+"""
+ascolorrange(colorrange::Symbol) = colorrange
+ascolorrange(colorrange::NTuple{2,T}) where {T<:Real} = colorrange
+ascolorrange(colorrange::NTuple{2,Real}) = promote(colorrange...)
+
 """
     Colorfy.colors(colorfier)
 
@@ -197,18 +228,6 @@ end
 # HELPER FUNCTIONS
 # -----------------
 
-ascolorscheme(name::Symbol) = colorschemes[name]
-ascolorscheme(name::AbstractString) = ascolorscheme(Symbol(name))
-ascolorscheme(scheme::ColorScheme) = scheme
-
-asalphas(alpha, values) = fill(alpha, length(values))
-function asalphas(alphas::AbstractVector, values)
-  if length(alphas) ≠ length(values)
-    throw(ArgumentError("the number of alphas must be equal to the number of values"))
-  end
-  alphas
-end
-
 nonmissingvec(x::AbstractVector{T}) where {T} = convert(AbstractVector{nonmissingtype(T)}, x)
 
 function genvec(vecinds, vec, valinds, val, len)

test/runtests.jl

@@ -34,6 +34,18 @@ using Test
     @test Colorfy.colorscheme(colorfier) == colorschemes[:grays]
     @test Colorfy.colorrange(colorfier) == :extrema
 
+    colorfier = Colorfier(values, colorrange=(0.25, 0.75))
+    @test Colorfy.values(colorfier) == values
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == (0.25, 0.75)
+
+    colorfier = Colorfier(values, colorrange=(0, 0.5))
+    @test Colorfy.values(colorfier) == values
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == (0.0, 0.5)
+
     alphas = rand(10)
     colorfier = Colorfier(values; alphas, colorscheme=colorschemes[:grays], colorrange=(0.25, 0.75))
     @test Colorfy.values(colorfier) == values
@@ -163,5 +175,6 @@ using Test
     @test colorfy(values) == colorfy(ustrip.(values))
     @test colorfy(values, alphas=0.5) == colorfy(ustrip.(values), alphas=0.5)
     @test colorfy(values, colorrange=(0.25, 0.75)) == colorfy(ustrip.(values), colorrange=(0.25, 0.75))
+    @test colorfy(values, colorrange=(0.25u"m", 0.75u"m")) == colorfy(ustrip.(values), colorrange=(0.25, 0.75))
   end
 end