Style Intelligence v12.0

inetsoft.graph.aesthetic
Class BrightnessColorFrame

java.lang.Object
  extended by inetsoft.graph.aesthetic.VisualFrame
      extended by inetsoft.graph.aesthetic.ColorFrame
          extended by inetsoft.graph.aesthetic.LinearColorFrame
              extended by inetsoft.graph.aesthetic.HSLColorFrame
                  extended by inetsoft.graph.aesthetic.BrightnessColorFrame
All Implemented Interfaces:
Serializable, Cloneable

public class BrightnessColorFrame
extends HSLColorFrame

This class defines a continuous color frame that returns colors varying on the brightness of the color.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.graph.aesthetic.HSLColorFrame
brightness, color, hue, saturation
 
Constructor Summary
BrightnessColorFrame()
          Create a color frame.
BrightnessColorFrame(String field)
          Create a color frame.
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 Color getColor(double ratio)
          Get a color at the relative scale.
 double getMaxBrightness()
          Get the maximum brightness value.
 double getMinBrightness()
          Get the minimum brightness value.
 boolean isIncrease()
          Check whether to increase or decrease brightness for larger values.
 void setIncrease(boolean increase)
          Set whether to increase or decrease brightness for larger values.
 void setMaxBrightness(double max)
          Set the maximum brightness value.
 void setMinBrightness(double min)
          Set the minimum brightness value.
 
Methods inherited from class inetsoft.graph.aesthetic.HSLColorFrame
getColor, hslToRGB, init, setColor
 
Methods inherited from class inetsoft.graph.aesthetic.LinearColorFrame
getColor, getColor
 
Methods inherited from class inetsoft.graph.aesthetic.ColorFrame
getBrightness, isGrayscale, process, setBrightness, setGrayscale
 
Methods inherited from class inetsoft.graph.aesthetic.VisualFrame
clone, createComparator, getField, getLabels, getLegendFrame, getLegendSpec, getScale, getScaleOption, getTitle, getValues, hashCode, init, isValid, isVisible, setField, setLegendFrame, setLegendSpec, setScale, setScaleOption, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BrightnessColorFrame

public BrightnessColorFrame()
Create a color frame. The field needs to be set by calling setField.


BrightnessColorFrame

public BrightnessColorFrame(String field)
Create a color frame.

Parameters:
field - field to get value to map to color.
Method Detail

setMinBrightness

public void setMinBrightness(double min)
Set the minimum brightness value.

Parameters:
min - a value between 0 and 1.

getMinBrightness

public double getMinBrightness()
Get the minimum brightness value.


setMaxBrightness

public void setMaxBrightness(double max)
Set the maximum brightness value.

Parameters:
max - a value between 0 and 1.

getMaxBrightness

public double getMaxBrightness()
Get the maximum brightness value.


setIncrease

public void setIncrease(boolean increase)
Set whether to increase or decrease brightness for larger values.


isIncrease

public boolean isIncrease()
Check whether to increase or decrease brightness for larger values.


getColor

public Color getColor(double ratio)
Description copied from class: LinearColorFrame
Get a color at the relative scale.

Specified by:
getColor in class LinearColorFrame
Parameters:
ratio - a value from 0 to 1.

equals

public boolean equals(Object obj)
Description copied from class: HSLColorFrame
Check if equals another object.

Overrides:
equals in class HSLColorFrame

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.