API Reference
ColorVintner.get_all_schemes
— Methodget_all_schemes()
Get all available color schemes as a combined vector.
Returns
Vector{Symbol}
: All sequential, diverging, and qualitative schemes combined
Examples
all_schemes = get_all_schemes()
ColorVintner.get_scheme_count
— Methodget_scheme_count()
Get the count of schemes in each category.
Returns
Dict
: Dictionary with counts for each category
Examples
counts = get_scheme_count()
ColorVintner.list_scheme_colors_in_rbg
— Methodlist_scheme_colors_in_rbg(scheme_name::Symbol)
Display information about a specific color scheme including its colors in hex format.
Arguments
scheme_name::Symbol
: The name of the color scheme to examine
Returns
Vector{Color}
: The colors in the scheme, ornothing
if the scheme is not found
Examples
colors = list_scheme_colors_in_rbg(:Blues_5)
ColorVintner.list_schemes_colors_in_hex
— Methodlist_schemes_colors_in_hex()
Create a DataFrame containing all color schemes with their hex color representations.
This function combines all sequential, diverging, and qualitative color schemes and creates a DataFrame with scheme names and their corresponding hex color strings.
Returns
DataFrame
: A DataFrame with columnsScheme_Name
andColors
Examples
df = list_schemes_colors_in_hex()
first(df, 5) # Show first 5 schemes
ColorVintner.plot_color_bars
— Methodplot_color_bars(schemes::Vector{Symbol};
schemes_per_row::Int=4,
bar_height::Float64=1.0,
figsize::Tuple{Int,Int}=(1600, 1200),
save_path::Union{String,Nothing}=nothing,
plot_title::Union{String,Nothing}=nothing)
Create color bar plots for a list of color schemes using Makie.
This function creates a grid of color bars, where each subplot shows the colors in a specific color scheme. The bars are sized to be approximately 1cm in height when displayed.
Arguments
schemes::Vector{Symbol}
: Vector of color scheme symbols to plotschemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_path::Union{String,Nothing}=nothing
: Optional path to save the plotplot_title::Union{String,Nothing}=nothing
: Optional title for the entire plot
Returns
Figure
: The Makie figure object
Examples
# Plot a few schemes
plot_color_bars([:Blues_5, :Reds_5, :Greens_5])
# Plot with custom settings
plot_color_bars(sequential[1:8], schemes_per_row=2,
save_path="my_plot.pdf", plot_title="My Color Schemes")
ColorVintner.plot_diverging_schemes_split
— Methodplot_diverging_schemes_split(;
schemes_per_row::Int=4,
bar_height::Float64=1.0,
figsize::Tuple{Int,Int}=(1600, 1200),
save_dir::Union{String,Nothing}=nothing)
Create separate plots for diverging schemes split into multiple subplots for better organization.
This function splits the diverging color schemes into 3 parts to create more manageable and readable plots. Each part is displayed separately and optionally saved to files.
Arguments
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns
Dict
: Dictionary containing the three diverging plot parts
Examples
# Create diverging scheme plots
div_plots = plot_diverging_schemes_split()
# Save to directory
div_plots = plot_diverging_schemes_split(save_dir="./diverging_plots")
ColorVintner.plot_qualitative_schemes_split
— Methodplot_qualitative_schemes_split(;
schemes_per_row::Int=4,
bar_height::Float64=1.0,
figsize::Tuple{Int,Int}=(1600, 1200),
save_dir::Union{String,Nothing}=nothing)
Create separate plots for qualitative schemes split into multiple subplots for better organization.
This function splits the qualitative color schemes into 2 parts to create more manageable and readable plots. Each part is displayed separately and optionally saved to files.
Arguments
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns
Dict
: Dictionary containing the two qualitative plot parts
Examples
# Create qualitative scheme plots
qual_plots = plot_qualitative_schemes_split()
# Save to directory
qual_plots = plot_qualitative_schemes_split(save_dir="./qualitative_plots")
ColorVintner.plot_schemes_by_category
— Methodplot_schemes_by_category(;
schemes_per_row::Int=4,
bar_height::Float64=1.0,
figsize::Tuple{Int,Int}=(1600, 1200),
save_dir::Union{String,Nothing}=nothing)
Create separate plots for sequential, diverging, and qualitative schemes using Makie.
This function creates comprehensive plots for all three categories of color schemes, splitting them into manageable parts for better visualization. It displays plots on screen by default and optionally saves them to a directory.
Arguments
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns
Dict
: Dictionary containing all created plot objects
Examples
# Create all category plots
plots = plot_schemes_by_category()
# Save to a directory
plots = plot_schemes_by_category(save_dir="./color_plots")
ColorVintner.plot_sequential_schemes_split
— Methodplot_sequential_schemes_split(;
schemes_per_row::Int=4,
bar_height::Float64=1.0,
figsize::Tuple{Int,Int}=(1600, 1200),
save_dir::Union{String,Nothing}=nothing)
Create separate plots for sequential schemes split into multiple subplots for better organization.
This function splits the sequential color schemes into 4 parts to create more manageable and readable plots. Each part is displayed separately and optionally saved to files.
Arguments
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns
Dict
: Dictionary containing the four sequential plot parts
Examples
# Create sequential scheme plots
seq_plots = plot_sequential_schemes_split()
# Save to directory
seq_plots = plot_sequential_schemes_split(save_dir="./sequential_plots")
ColorVintner.show_all_scheme_names
— Methodshow_all_scheme_names()
Print all available color scheme names to the console.
This function iterates through all color schemes (sequential, diverging, and qualitative) and prints their names. Useful for browsing available schemes or debugging.
Examples
show_all_scheme_names()
ColorVintner.show_diverging_distribution
— Methodshow_diverging_distribution()
Show how diverging schemes are distributed across the 3 parts.
This function displays information about how the diverging color schemes are distributed across the three parts created by plot_diverging_schemes_split()
. It prints summary information and returns a dictionary with the scheme groupings.
Returns
Dict
: Dictionary containing the three parts of diverging schemes
Examples
distribution = show_diverging_distribution()
ColorVintner.show_qualitative_distribution
— Methodshow_qualitative_distribution()
Show how qualitative schemes are distributed across the 2 parts.
This function displays information about how the qualitative color schemes are distributed across the two parts created by plot_qualitative_schemes_split()
. It prints summary information and returns a dictionary with the scheme groupings.
Returns
Dict
: Dictionary containing the two parts of qualitative schemes
Examples
distribution = show_qualitative_distribution()
ColorVintner.show_sequential_distribution
— Methodshow_sequential_distribution()
Show how sequential schemes are distributed across the 4 parts.
This function displays information about how the sequential color schemes are distributed across the four parts created by plot_sequential_schemes_split()
. It prints summary information and returns a dictionary with the scheme groupings.
Returns
Dict
: Dictionary containing the four parts of sequential schemes
Examples
distribution = show_sequential_distribution()
Exploration Functions
show_all_scheme_names()
Print all available color scheme names to the console.
show_all_scheme_names()
list_scheme_colors_in_rbg(scheme_name::Symbol)
Display information about a specific color scheme including its colors in hex format.
Arguments:
scheme_name::Symbol
: The name of the color scheme to examine
Returns:
Vector{Color}
: The colors in the scheme, ornothing
if the scheme is not found
Example:
colors = list_scheme_colors_in_rbg(:Blues_5)
list_schemes_colors_in_hex()
Create a DataFrame containing all color schemes with their hex color representations.
Returns:
DataFrame
: A DataFrame with columnsScheme_Name
andColors
Example:
df = list_schemes_colors_in_hex()
first(df, 5) # Show first 5 schemes
Plotting Functions
plot_color_bars(schemes::Vector{Symbol}; ...)
Create color bar plots for a list of color schemes using Makie.
Arguments:
schemes::Vector{Symbol}
: Vector of color scheme symbols to plotschemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_path::Union{String,Nothing}=nothing
: Optional path to save the plotplot_title::Union{String,Nothing}=nothing
: Optional title for the entire plot
Returns:
Figure
: The Makie figure object
Example:
# Plot a few schemes
plot_color_bars([:Blues_5, :Reds_5, :Greens_5])
# Plot with custom settings
plot_color_bars(sequential[1:8], schemes_per_row=2,
save_path="my_plot.pdf", plot_title="My Color Schemes")
plot_schemes_by_category(; ...)
Create separate plots for sequential, diverging, and qualitative schemes using Makie.
Arguments:
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns:
Dict
: Dictionary containing all created plot objects
Example:
# Create all category plots
plots = plot_schemes_by_category()
# Save to a directory
plots = plot_schemes_by_category(save_dir="./color_plots")
plot_sequential_schemes_split(; ...)
Create separate plots for sequential schemes split into multiple subplots for better organization.
Arguments:
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns:
Dict
: Dictionary containing the four sequential plot parts
plot_diverging_schemes_split(; ...)
Create separate plots for diverging schemes split into multiple subplots for better organization.
Arguments:
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns:
Dict
: Dictionary containing the three diverging plot parts
plot_qualitative_schemes_split(; ...)
Create separate plots for qualitative schemes split into multiple subplots for better organization.
Arguments:
schemes_per_row::Int=4
: Number of schemes to display per rowbar_height::Float64=1.0
: Height of each color bar (in data coordinates)figsize::Tuple{Int,Int}=(1600, 1200)
: Figure size (width, height) in pixelssave_dir::Union{String,Nothing}=nothing
: Optional directory to save plots
Returns:
Dict
: Dictionary containing the two qualitative plot parts
Distribution Functions
show_sequential_distribution()
Show how sequential schemes are distributed across the 4 parts.
Returns:
Dict
: Dictionary containing the four parts of sequential schemes
show_diverging_distribution()
Show how diverging schemes are distributed across the 3 parts.
Returns:
Dict
: Dictionary containing the three parts of diverging schemes
show_qualitative_distribution()
Show how qualitative schemes are distributed across the 2 parts.
Returns:
Dict
: Dictionary containing the two parts of qualitative schemes
Utility Functions
get_all_schemes()
Get all available color schemes as a combined vector.
Returns:
Vector{Symbol}
: All sequential, diverging, and qualitative schemes combined
get_scheme_count()
Get the count of schemes in each category.
Returns:
Dict
: Dictionary with counts for each category
Constants
sequential
Vector of all sequential color scheme symbols.
diverging
Vector of all diverging color scheme symbols.
qualitative
Vector of all qualitative color scheme symbols.