LegendScheme (MeteoInfoLib 1.9 API)

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

public class LegendScheme
extends Object

Legend scheme class

作者:: Yaqiang Wang

构造器概要

构造器
构造器说明

LegendScheme()
Constructor

LegendScheme(List<ColorBreak> lbs)
Constructor

LegendScheme(ShapeTypes aShapeType)
Constructor

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`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
`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(double v)`	Find legend break by value
`int`	`getBreakNum()`	Get legend break number
`BreakTypes`	`getBreakType()`	Get break type
`List<Color>`	`getColors()`	Get color list
`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
`ShapeTypes`	`getShapeType()`	Get shape type
`double`	`getUndefValue()`	Get undefine value
`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`	`isConsistent(DrawType2D drawTyp)`	Judge if shape type is consistent with draw type
`boolean`	`isGeometry()`	Is Geometry legend scheme or not
`void`	`setFieldName(String fn)`	Set field name
`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`	`setShapeType(ShapeTypes st)`	Set shape type
`void`	`setUndefValue(double uv)`	Set undefine value
`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(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
  - 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
  - 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
  - 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
  - addLegendBreak
```
public void addLegendBreak(ColorBreak lb)
```
    Add a legend break
    
    参数:
    
    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
  - findLegendBreak
```
public ColorBreak findLegendBreak(double v)
```
    Find legend break by value
    
    参数:
    
    v - Value
    
    返回:
    
    Legend break
  - getColors
```
public List<Color> getColors()
```
    Get color list
    
    返回:
    
    Color list
  - isConsistent
```
public boolean isConsistent(DrawType2D drawTyp)
```
    Judge if shape type is consistent with draw type
    
    参数:
    
    drawTyp - Draw type
    
    返回:
    
    Boolean
  - convertTo
```
public LegendScheme convertTo(ShapeTypes shapeType)
```
    Convert to other shape type
    
    参数:
    
    shapeType - The shape type
    
    返回:
    
    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

方法详细资料

getFieldName

setFieldName

isGeometry

getLegendType

setLegendType

getShapeType

setShapeType

getBreakType

getLegendBreaks

getLegendBreak

setLegendBreaks

setLegendBreak

getHasNoData

setHasNoData

getMinValue

setMinValue

getMaxValue

setMaxValue

getUndefValue

setUndefValue

getBreakNum

getVisibleBreakNum

VisibleBreakNum

addLegendBreak

addLegendBreak

findBreaks

findLegendBreak

getColors

isConsistent

convertTo

asArrow

exportToXML

exportToXMLFile

importFromXML

importFromXML

importFromXMLFile

importFromXMLFile

importFromPaletteFile_Unique

importFromPaletteFile_Graduated

clone