java.lang.Object
- org.meteoinfo.geometry.legend.LegendScheme

public class LegendScheme
extends Object

Legend scheme class

作者:: Yaqiang Wang

构造器概要

构造器
构造器	说明
`LegendScheme()`	Constructor
`LegendScheme(List<ColorBreak> lbs)`	Constructor
`LegendScheme(ShapeTypes aShapeType)`	Constructor
`LegendScheme(ShapeTypes aShapeType, int n)`	Constructor

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`void`	`addLegendBreak(int index, ColorBreak lb)`	Add a legend break by index
`void`	`addLegendBreak(List<ColorBreak> lb)`	Add a legend breaks
`void`	`addLegendBreak(ColorBreak lb)`	Add a legend break
`void`	`asArrow()`	Convert point legend to arrow legend
`Object`	`clone()`	Clone
`LegendScheme`	`convertTo(ShapeTypes shapeType)`	Convert to other shape type
`LegendScheme`	`convertTo(ShapeTypes shapeType, boolean edgeColor)`	Convert to other shape type
`void`	`exportToXML(Document doc, Element parent)`	Export to xml document
`void`	`exportToXMLFile(String aFile)`	Export to xml file
`List<ColorBreak>`	`findBreaks(List<Double> values)`	Find breaks
`ColorBreak`	`findLegendBreak(Number v)`	Find legend break by value
`ColorBreak`	`findLegendBreakAlways(Number v)`	Find legend break by value
`int`	`getBreakNum()`	Get legend break number
`BreakTypes`	`getBreakType()`	Get break type
`ColorMap`	`getColorMap()`	Get color map
`List<Color>`	`getColors()`	Get color list
`ExtendFraction`	`getExtendFraction()`	Get extend fraction
`ExtendType`	`getExtendType()`	Get extend type
`String`	`getFieldName()`	Get field name
`boolean`	`getHasNoData()`	Get if has no data
`ColorBreak`	`getLegendBreak(int i)`	Get legend break by index
`List<ColorBreak>`	`getLegendBreaks()`	Get legend breaks
`LegendType`	`getLegendType()`	Get legend type
`double`	`getMaxValue()`	Get maximum value
`double`	`getMinValue()`	Get minimum value
`Normalize`	`getNormalize()`	Get normalize
`ShapeTypes`	`getShapeType()`	Get shape type
`double`	`getUndefValue()`	Get undefine value
`int`	`getValidBreakNum()`	Get valid legend breaks number
`double[]`	`getValues()`	Get legend values
`double[]`	`getValues(double min, double max)`	Get legend values
`int`	`getVisibleBreakNum()`	Get visible legend breaks number
`void`	`importFromPaletteFile_Graduated(String filePath)`	Import legend scheme from an image color palette file
`void`	`importFromPaletteFile_Unique(String filePath)`	Import legend scheme from an image color palette file
`void`	`importFromXML(Node LSNode)`	Import legend scheme from XML node
`void`	`importFromXML(Node LSNode, boolean keepShape)`	Import legend scheme from xml node
`void`	`importFromXMLFile(String aFile)`	Import legend scheme from XML file
`void`	`importFromXMLFile(String aFile, boolean keepShape)`	Import legend scheme from XML file
`boolean`	`isEmpty()`	Return the legend scheme is empty or not
`boolean`	`isGeometry()`	Is Geometry legend scheme or not
`int`	`legendBreakIndex(double v)`	Get legend break index by value
`void`	`setColorMap(ColorMap value)`	Set color map
`void`	`setExtendFraction(ExtendFraction value)`	Set extend fraction
`void`	`setExtendType(String value)`	Set extend type
`void`	`setExtendType(ExtendType value)`	Set extend type
`void`	`setFieldName(String fn)`	Set field name
`void`	`setFillColor(Color color)`	Set fill value color
`void`	`setHasNoData(boolean istrue)`	Set if has no data
`void`	`setLegendBreak(int i, ColorBreak value)`	Set a legendBreak
`void`	`setLegendBreaks(List<ColorBreak> breaks)`	Set legend breaks
`void`	`setLegendType(LegendType lt)`	Set legend type
`void`	`setMaxValue(double max)`	Set maximum value
`void`	`setMinValue(double min)`	Set minimum value
`void`	`setNormalize(Normalize value)`	Set normalize
`void`	`setShapeType(ShapeTypes st)`	Set shape type
`void`	`setUndefValue(double uv)`	Set undefine value
`void`	`updateColors(ColorMap colorMap)`	Update legend colors by color map
`int`	`VisibleBreakNum()`	Get visible break number

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LegendScheme
```
public LegendScheme()
```
    Constructor
  - LegendScheme
```
public LegendScheme(ShapeTypes aShapeType)
```
    Constructor
    
    参数:
    
    aShapeType -
  - LegendScheme
```
public LegendScheme(ShapeTypes aShapeType,
                    int n)
```
    Constructor
    
    参数:
    
    aShapeType -
    
    n - Break number
  - LegendScheme
```
public LegendScheme(List<ColorBreak> lbs)
```
    Constructor
    
    参数:
    
    lbs - Legend breaks
- 方法详细资料
  - getFieldName
```
public String getFieldName()
```
    Get field name
    
    返回:
    
    The field name
  - setFieldName
```
public void setFieldName(String fn)
```
    Set field name
    
    参数:
    
    fn - The field name
  - isGeometry
```
public boolean isGeometry()
```
    Is Geometry legend scheme or not
    
    返回:
    
    Boolean
  - isEmpty
```
public boolean isEmpty()
```
    Return the legend scheme is empty or not
    
    返回:
    
    Empty or not
  - getLegendType
```
public LegendType getLegendType()
```
    Get legend type
    
    返回:
    
    The legend type
  - setLegendType
```
public void setLegendType(LegendType lt)
```
    Set legend type
    
    参数:
    
    lt - The legend type
  - getShapeType
```
public ShapeTypes getShapeType()
```
    Get shape type
    
    返回:
    
    The shape type
  - setShapeType
```
public void setShapeType(ShapeTypes st)
```
    Set shape type
    
    参数:
    
    st - The shape type
  - getExtendType
```
public ExtendType getExtendType()
```
    Get extend type
    
    返回:
    
    Extend type
  - setExtendType
```
public void setExtendType(ExtendType value)
```
    Set extend type
    
    参数:
    
    value - Extend type
  - getExtendFraction
```
public ExtendFraction getExtendFraction()
```
    Get extend fraction
    
    返回:
    
    Extend fraction
  - setExtendFraction
```
public void setExtendFraction(ExtendFraction value)
```
    Set extend fraction
    
    参数:
    
    value -
  - setExtendType
```
public void setExtendType(String value)
```
    Set extend type
    
    参数:
    
    value - Extend type
  - getBreakType
```
public BreakTypes getBreakType()
```
    Get break type
    
    返回:
    
    The break type
  - getLegendBreaks
```
public List<ColorBreak> getLegendBreaks()
```
    Get legend breaks
    
    返回:
    
    The legend breaks
  - getLegendBreak
```
public ColorBreak getLegendBreak(int i)
```
    Get legend break by index
    
    参数:
    
    i - Index
    
    返回:
    
    A legend break
  - setLegendBreaks
```
public void setLegendBreaks(List<ColorBreak> breaks)
```
    Set legend breaks
    
    参数:
    
    breaks - The legend breaks
  - setLegendBreak
```
public void setLegendBreak(int i,
                           ColorBreak value)
```
    Set a legendBreak
    
    参数:
    
    i - Index
    
    value - Legend break
  - getHasNoData
```
public boolean getHasNoData()
```
    Get if has no data
    
    返回:
    
    If has no data
  - setHasNoData
```
public void setHasNoData(boolean istrue)
```
    Set if has no data
    
    参数:
    
    istrue - If has no data
  - getMinValue
```
public double getMinValue()
```
    Get minimum value
    
    返回:
    
    Minimum value
  - setMinValue
```
public void setMinValue(double min)
```
    Set minimum value
    
    参数:
    
    min -
  - getMaxValue
```
public double getMaxValue()
```
    Get maximum value
    
    返回:
    
    Maximum value
  - setMaxValue
```
public void setMaxValue(double max)
```
    Set maximum value
    
    参数:
    
    max - Maximum value
  - getUndefValue
```
public double getUndefValue()
```
    Get undefine value
    
    返回:
    
    Undefine value
  - setUndefValue
```
public void setUndefValue(double uv)
```
    Set undefine value
    
    参数:
    
    uv - Undefine value
  - getBreakNum
```
public int getBreakNum()
```
    Get legend break number
    
    返回:
    
    Legend break number
  - getValidBreakNum
```
public int getValidBreakNum()
```
    Get valid legend breaks number
    
    返回:
    
    The valid legend breaks number
  - getVisibleBreakNum
```
public int getVisibleBreakNum()
```
    Get visible legend breaks number
    
    返回:
    
    The visible legend breaks number
  - VisibleBreakNum
```
public int VisibleBreakNum()
```
    Get visible break number
    
    返回:
    
    Visible break number
  - getColorMap
```
public ColorMap getColorMap()
```
    Get color map
    
    返回:
    
    Color map
  - setColorMap
```
public void setColorMap(ColorMap value)
```
    Set color map
    
    参数:
    
    value - Color map
  - getNormalize
```
public Normalize getNormalize()
```
    Get normalize
    
    返回:
    
    Normalize
  - setNormalize
```
public void setNormalize(Normalize value)
```
    Set normalize
    
    参数:
    
    value - Normalize
  - addLegendBreak
```
public void addLegendBreak(ColorBreak lb)
```
    Add a legend break
    
    参数:
    
    lb - Legend break
  - addLegendBreak
```
public void addLegendBreak(int index,
                           ColorBreak lb)
```
    Add a legend break by index
    
    参数:
    
    index - The index
    
    lb - Legend break
  - addLegendBreak
```
public void addLegendBreak(List<ColorBreak> lb)
```
    Add a legend breaks
    
    参数:
    
    lb - Legend breaks
  - findBreaks
```
public List<ColorBreak> findBreaks(List<Double> values)
```
    Find breaks
    
    参数:
    
    values - Values
    
    返回:
    
    Color breaks
  - findLegendBreakAlways
```
public ColorBreak findLegendBreakAlways(Number v)
```
    Find legend break by value
    
    参数:
    
    v - Value
    
    返回:
    
    Legend break
  - findLegendBreak
```
public ColorBreak findLegendBreak(Number v)
```
    Find legend break by value
    
    参数:
    
    v - Value
    
    返回:
    
    Legend break
  - legendBreakIndex
```
public int legendBreakIndex(double v)
```
    Get legend break index by value
    
    参数:
    
    v - Value
    
    返回:
    
    Legend break index
  - getValues
```
public double[] getValues()
```
    Get legend values
    
    返回:
    
    Legend values
  - getValues
```
public double[] getValues(double min,
                          double max)
```
    Get legend values
    
    返回:
    
    Legend values
  - getColors
```
public List<Color> getColors()
```
    Get color list
    
    返回:
    
    Color list
  - updateColors
```
public void updateColors(ColorMap colorMap)
```
    Update legend colors by color map
    
    参数:
    
    colorMap - The color map
  - setFillColor
```
public void setFillColor(Color color)
```
    Set fill value color
    
    参数:
    
    color - The fill value color
  - convertTo
```
public LegendScheme convertTo(ShapeTypes shapeType)
```
    Convert to other shape type
    
    参数:
    
    shapeType - The shape type
    
    返回:
    
    Result legend scheme
  - convertTo
```
public LegendScheme convertTo(ShapeTypes shapeType,
                              boolean edgeColor)
```
    Convert to other shape type
    
    参数:
    
    shapeType - The shape type
    
    edgeColor - Colors to edge colors
    
    返回:
    
    Result legend scheme
  - asArrow
```
public void asArrow()
```
    Convert point legend to arrow legend
  - exportToXML
```
public void exportToXML(Document doc,
                        Element parent)
```
    Export to xml document
    
    参数:
    
    doc - xml document
    
    parent - Parent xml element
  - exportToXMLFile
```
public void exportToXMLFile(String aFile)
                     throws ParserConfigurationException
```
    Export to xml file
    
    参数:
    
    aFile - xml file path
    
    抛出:
    
    ParserConfigurationException
  - importFromXML
```
public void importFromXML(Node LSNode)
```
    Import legend scheme from XML node
    
    参数:
    
    LSNode - xml node
  - importFromXML
```
public void importFromXML(Node LSNode,
                          boolean keepShape)
```
    Import legend scheme from xml node
    
    参数:
    
    LSNode - xml node
    
    keepShape - if keep the legend shape type
  - importFromXMLFile
```
public void importFromXMLFile(String aFile)
                       throws ParserConfigurationException,
                              SAXException,
                              IOException
```
    Import legend scheme from XML file
    
    参数:
    
    aFile - File path
    
    抛出:
    
    ParserConfigurationException
    
    SAXException
    
    IOException
  - importFromXMLFile
```
public void importFromXMLFile(String aFile,
                              boolean keepShape)
                       throws ParserConfigurationException,
                              SAXException,
                              IOException
```
    Import legend scheme from XML file
    
    参数:
    
    aFile - file path
    
    keepShape - If keep shape type
    
    抛出:
    
    ParserConfigurationException
    
    SAXException
    
    IOException
  - importFromPaletteFile_Unique
```
public void importFromPaletteFile_Unique(String filePath)
```
    Import legend scheme from an image color palette file
    
    参数:
    
    filePath - File path
  - importFromPaletteFile_Graduated
```
public void importFromPaletteFile_Graduated(String filePath)
```
    Import legend scheme from an image color palette file
    
    参数:
    
    filePath - File path
  - clone
```
public Object clone()
```
    Clone
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    Legend scheme

类 LegendScheme

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

LegendScheme

LegendScheme

LegendScheme

LegendScheme

方法详细资料

getFieldName

setFieldName

isGeometry

isEmpty

getLegendType

setLegendType

getShapeType

setShapeType

getExtendType

setExtendType

getExtendFraction

setExtendFraction

setExtendType

getBreakType

getLegendBreaks

getLegendBreak

setLegendBreaks

setLegendBreak

getHasNoData

setHasNoData

getMinValue

setMinValue

getMaxValue

setMaxValue

getUndefValue

setUndefValue

getBreakNum

getValidBreakNum

getVisibleBreakNum

VisibleBreakNum

getColorMap

setColorMap

getNormalize

setNormalize

addLegendBreak

addLegendBreak

addLegendBreak

findBreaks

findLegendBreakAlways

findLegendBreak

legendBreakIndex

getValues

getValues

getColors

updateColors

setFillColor

convertTo

convertTo

asArrow

exportToXML

exportToXMLFile

importFromXML

importFromXML

importFromXMLFile

importFromXMLFile

importFromPaletteFile_Unique

importFromPaletteFile_Graduated

clone