de.javagl.colors.brewer

Class ColorBrewer

java.lang.Object

de.javagl.colors.brewer.ColorBrewer

public class ColorBrewer
extends Object

A class providing color schemes based on the ColorBrewer colors.


Original license:

 Apache-Style Software License for ColorBrewer software and ColorBrewer Color
 Schemes
 
 Copyright (c) 2002 Cynthia Brewer, Mark Harrower, and The Pennsylvania State
 University.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not
 use this file except in compliance with the License. You may obtain a copy of
 the License at
 
 http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 License for the specific language governing permissions and limitations under
 the License.
 
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 1. Redistributions as source code must retain the above copyright notice,
 this list of conditions and the following disclaimer. 2. The end-user
 documentation included with the redistribution, if any, must include the
 following acknowledgment: This product includes color specifications and
 designs developed by Cynthia Brewer (http://colorbrewer.org/). Alternately,
 this acknowledgment may appear in the software itself, if and wherever such
 third-party acknowledgments normally appear. 4. The name "ColorBrewer" must
 not be used to endorse or promote products derived from this software without
 prior written permission. For written permission, please contact Cynthia
 Brewer at cbrewer@psu.edu. 5. Products derived from this software may not be
 called "ColorBrewer", nor may "ColorBrewer" appear in their name, without
 prior written permission of Cynthia Brewer.
 

Constructor Summary

Constructors

Constructor and Description
ColorBrewer()

Method Summary

Modifier and Type	Method and Description
static List<Color>	get(ColorSchemeType type, String name, int numColors) Returns an unmodifiable list containing the colors of a color scheme with the given name and the given number of colors
static int	getMax(ColorSchemeType type, String name) Returns the maximum number of colors that any color scheme with the given name and type has
static List<String>	getNames(ColorSchemeType type) Returns the names of all ColorScheme instances with the given type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColorBrewer

public ColorBrewer()

Method Detail

getMax

public static int getMax(ColorSchemeType type,
                         String name)

Returns the maximum number of colors that any color scheme with the given name and type has

Parameters:

type - The type

name - The name

Returns:

The maximum number of colors

Throws:

IllegalArgumentException - If no color scheme with the given name and requested type could be found

get

public static List<Color> get(ColorSchemeType type,
                              String name,
                              int numColors)

Returns an unmodifiable list containing the colors of a color scheme with the given name and the given number of colors

Parameters:

type - The type

name - The name

numColors - The number of colors

Returns:

The colors

Throws:

IllegalArgumentException - If no color scheme with the given name and requested type and number of colors could be found

getNames

public static List<String> getNames(ColorSchemeType type)

Returns the names of all ColorScheme instances with the given type

Parameters:

type - The type

Returns:

The names