Color (Groovy Documentation)

geoscript.filter.Color

A Color Expression and a set of Color Utilities used in the Style module. You can create a Color from an RGB String
```
 new Color("0,255,0")
 
```
or from a CSS color name:
```
 new Color("silver")
 
```
or from a hexadecimal:
```
 new Color("#00ff00")
 
```
or from a RGB List:
```
 new Color([0,255,0])
 
```
or from a RGB Map:
```
 new Color([r: 0, g: 255, b: 0, a: 125])
 
```
or from a HSL Map:
```
 new Color([h: 0, s: 1.0, l: 0.5])
 
```
Authors:
Jared Erickson

Inherited fields
Fields inherited from class	Fields
`class Expression`	`filterFactory`

Properties Summary

Properties
Type	Name and description
`static java.util.Map`	`colorNameMap` CSS Color names

Constructor Summary

Constructors
Constructor and description
`Color (java.lang.Object value)` Create a new Color from a value

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.awt.Color`	`asColor()` Get a java.awt.Color for this Color
	`Color`	`brighter(int n = 1)` Create a new brighter Color
	`Color`	`darker(int n = 1)` Create a new darker Color
	`static void`	`draw(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)` Draw a List of Colors to a JFrame
	`static java.awt.image.BufferedImage`	`drawToImage(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)` Draw a List of Colors to an Image
	`java.lang.String`	`getHex()` Get this Color's hex value
	`java.util.List`	`getHsl()` Get this Color's HSL value
	`static java.util.List`	`getPaletteColors(java.lang.String name, int count = -1)` Get a List of Colors from a Palette by name
	`static java.util.List`	`getPaletteNames(java.lang.String type = "all")` Get a List of Palette names by type (defaults to All)
	`static Color`	`getRandom()` Generate a random color
	`static Color`	`getRandomPastel()` Get a random pastel color
	`java.util.List`	`getRgb()` Get this Color's RGB value
	`java.util.List`	`interpolate(Color color, int n = 10)` Interpolate a List of Colors between this Color and the given Color
	`static java.util.List`	`interpolate(Color start, Color end, int n = 10)` Interpolate a List Colors between the start and end Color
	`static java.lang.String`	`toHex(java.lang.Object color)` Convert a Color to a hex color string

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Expression`	`evaluate, fromCQL, getValue, toString`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.util.Map colorNameMap
    
    CSS Color names
- Constructor Detail
  - Color(java.lang.Object value)
    
    Create a new Color from a value
    Parameters:
    value - The value
- Method Detail
  - java.awt.Color asColor()
    
    Get a java.awt.Color for this Color
    Returns:
    A java.awt.Color
  - Color brighter(int n = 1)
    
    Create a new brighter Color
    Returns:
    A new Color
    Parameters:
    n - The number of times to brighten the Color. Defaults to 1.
  - Color darker(int n = 1)
    
    Create a new darker Color
    Returns:
    A new Color
    Parameters:
    n - The number of times to darken the Color. Defaults to 1.
  - static void draw(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)
    
    Draw a List of Colors to a JFrame
    Parameters:
    colors - The List of Colors
    orientation - The orientation (vertical or horizontal)
    size - The size of each Color swatch
  - static java.awt.image.BufferedImage drawToImage(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)
    
    Draw a List of Colors to an Image
    Returns:
    A BufferedImage
    Parameters:
    colors - The List of Colors
    orientation - The orientation (vertical or horizontal)
    size - The size of each Color swatch
  - java.lang.String getHex()
    
    Get this Color's hex value
    Returns:
    The hex value
  - java.util.List getHsl()
    
    Get this Color's HSL value
    Returns:
    A List of HSL values all between 0 and 1
  - static java.util.List getPaletteColors(java.lang.String name, int count = -1)
    
    Get a List of Colors from a Palette by name
    Returns:
    A List of Colors. The List will be empty if the Palette can't be found. The number of Colors is constrained by the number of maximum colors for the given palette.
    Parameters:
    name - The Palette name
    count - The number of colors
  - static java.util.List getPaletteNames(java.lang.String type = "all")
    
    Get a List of Palette names by type (defaults to All)
    Returns:
    A List of Palette names
    Parameters:
    type - The type (all, diverging, qualitative, sequential)
  - static Color getRandom()
    
    Generate a random color
    Returns:
    A Color
  - static Color getRandomPastel()
    
    Get a random pastel color
    Returns:
    A Color
  - java.util.List getRgb()
    
    Get this Color's RGB value
    Returns:
    A List of RGB values
  - java.util.List interpolate(Color color, int n = 10)
    
    Interpolate a List of Colors between this Color and the given Color
    Returns:
    A List of Colors
    Parameters:
    color - The other Color
    n - The number of Colors
  - static java.util.List interpolate(Color start, Color end, int n = 10)
    
    Interpolate a List Colors between the start and end Color
    Returns:
    A List of Colors
    Parameters:
    start - The start Color
    end - The end Color
    n - The number of Colors
  - static java.lang.String toHex(java.lang.Object color)
    
    Convert a Color to a hex color string
    Returns:
    A hex color string
    Parameters:
    color - The color value

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Color

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.util.Map colorNameMap

Constructor Detail

Color(java.lang.Object value)

Method Detail

java.awt.Color asColor()

Color brighter(int n = 1)

Color darker(int n = 1)

static void draw(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)

static java.awt.image.BufferedImage drawToImage(java.util.List colors, java.lang.String orientation = "vertical", int size = 50)

java.lang.String getHex()

java.util.List getHsl()

static java.util.List getPaletteColors(java.lang.String name, int count = -1)

static java.util.List getPaletteNames(java.lang.String type = "all")

static Color getRandom()

static Color getRandomPastel()

java.util.List getRgb()

java.util.List interpolate(Color color, int n = 10)

static java.util.List interpolate(Color start, Color end, int n = 10)

static java.lang.String toHex(java.lang.Object color)