@sqlrooms/color-scales / isSteppedColorScale

Function: isSteppedColorScale()

isSteppedColorScale(colorScale): colorScale is { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "quantize"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; domain: "auto" | [number, number]; bins?: number; clamp?: boolean } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "quantile"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; bins?: number } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "threshold"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; thresholds: number[] }

Parameters

Parameter

Type

colorScale

{ field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; type: "sequential"; scheme: "Blues" | "BuGn" | "BuPu" | "Cividis" | "Cool" | "CubehelixDefault" | "GnBu" | "Greens" | "Greys" | "Inferno" | "Magma" | "OrRd" | "Oranges" | "Plasma" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "Turbo" | "Viridis" | "Warm" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "Rainbow" | "Sinebow"; domain: "auto" | [number, number]; clamp?: boolean; } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; type: "diverging"; scheme: "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; domain: [number, number, number] | "auto"; clamp?: boolean; } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; type: "quantize"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; domain: "auto" | [number, number]; bins?: number; clamp?: boolean; } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; type: "quantile"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; bins?: number; } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; type: "threshold"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; thresholds: number[]; } | { field: string; type: "categorical"; scheme: "Accent" | "Dark2" | "Paired" | "Pastel1" | "Pastel2" | "Set1" | "Set2" | "Set3" | "Tableau10" | "Observable10" | "Category10"; reverse?: boolean; unknownColor?: [number, number, number] | [number, number, number, number]; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string; }; }

Returns

colorScale is { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "quantize"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; domain: "auto" | [number, number]; bins?: number; clamp?: boolean } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "quantile"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; bins?: number } | { field: string; reverse?: boolean; nullColor?: [number, number, number] | [number, number, number, number]; legend?: { title?: string }; type: "threshold"; scheme: "Blues" | "BuGn" | "BuPu" | "GnBu" | "Greens" | "Greys" | "OrRd" | "Oranges" | "PuBu" | "PuBuGn" | "PuRd" | "Purples" | "RdPu" | "Reds" | "YlGn" | "YlGnBu" | "YlOrBr" | "YlOrRd" | "BrBG" | "PRGn" | "PiYG" | "PuOr" | "RdBu" | "RdGy" | "RdYlBu" | "RdYlGn" | "Spectral"; thresholds: number[] }