Package io.jenkins.plugins.echarts

Enum Class JenkinsPalette

java.lang.Object

java.lang.Enum<JenkinsPalette>

io.jenkins.plugins.echarts.JenkinsPalette

All Implemented Interfaces:

Serializable, Comparable<JenkinsPalette>, Constable

public enum JenkinsPalette
extends Enum<JenkinsPalette>

Jenkins color palette. Each color is represented as a CSS variable that will be rendered according to the selected theme.

Author:

Ullrich Hafner

See Also:

• "JS method resolveJenkinsColors in file echarts-scope.js"
• Jenkins colors

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACK
BLUE
BROWN
CYAN
GREEN
GREY
INDIGO
ORANGE
PINK
PURPLE
RED
WHITE
YELLOW

Method Summary

Modifier and Type	Method	Description
static JenkinsPalette	chartColor(int n)	Returns a chart color that can be used to render element n in a chart.
String	dark()	Returns the CSS variable name for this color (dark variation).
String	light()	Returns the CSS variable name for this color (light variation).
String	normal()	Returns the CSS variable name for this color.
static JenkinsPalette	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JenkinsPalette[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLACK

public static final JenkinsPalette BLACK

BLUE

public static final JenkinsPalette BLUE

BROWN

public static final JenkinsPalette BROWN

CYAN

public static final JenkinsPalette CYAN

GREY

public static final JenkinsPalette GREY

GREEN

public static final JenkinsPalette GREEN

INDIGO

public static final JenkinsPalette INDIGO

ORANGE

public static final JenkinsPalette ORANGE

PINK

public static final JenkinsPalette PINK

PURPLE

public static final JenkinsPalette PURPLE

RED

public static final JenkinsPalette RED

WHITE

public static final JenkinsPalette WHITE

YELLOW

public static final JenkinsPalette YELLOW

Method Details

values

public static JenkinsPalette[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JenkinsPalette valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

chartColor

public static JenkinsPalette chartColor(int n)

Returns a chart color that can be used to render element n in a chart. If n is greater than the number of available colors then the color will be selected from the beginning of the list, and so on.

Parameters:

n - the n-th element to render

Returns:

a color to be used for rendering the n-th element

light

public String light()

Returns the CSS variable name for this color (light variation).

Returns:

the CSS variable name

normal

public String normal()

Returns the CSS variable name for this color.

Returns:

the CSS variable name

dark

public String dark()

Returns the CSS variable name for this color (dark variation).

Returns:

the CSS variable name