ChartLegend (MeteoInfoLib 1.9 API)

java.lang.Object
- org.meteoinfo.chart.ChartLegend

直接已知子类:

ChartColorBar
```
public class ChartLegend
extends Object
```
作者:

Yaqiang Wang

嵌套类概要

嵌套类
限定符和类型类说明

class ChartLegend.LayoutLegendBean

static class ChartLegend.LayoutLegendBeanBeanInfo

static class ChartLegend.PlotOrientationEditor

嵌套类
限定符和类型	类	说明
`class`	`ChartLegend.LayoutLegendBean`
`static class`	`ChartLegend.LayoutLegendBeanBeanInfo`
`static class`	`ChartLegend.PlotOrientationEditor`

字段概要

字段
限定符和类型	字段	说明
`protected double`	`_hBarHeight`
`protected double`	`_vBarWidth`
`protected int`	`aspect`
`protected boolean`	`autoExtendFrac`
`protected Color`	`background`
`protected boolean`	`drawBackground`
`protected boolean`	`drawMaxLabel`
`protected boolean`	`drawMinLabel`
`protected boolean`	`drawNeatLine`
`protected boolean`	`extendRect`
`protected int`	`height`
`protected ChartText`	`label`
`protected String`	`labelLocation`
`protected int`	`legendHeight`
`protected LegendScheme`	`legendScheme`
`protected int`	`legendWidth`
`protected Color`	`neatLineColor`
`protected float`	`neatLineSize`
`protected PlotOrientation`	`orientation`
`protected float`	`shrink`
`protected float`	`tickLabelAngle`
`protected Color`	`tickLabelColor`
`protected Font`	`tickLabelFont`
`protected int`	`width`
`protected float`	`x`
`protected float`	`xshift`
`protected float`	`y`
`protected float`	`yshift`

构造器概要

构造器
构造器说明

ChartLegend(LegendScheme ls)
Constructor

构造器
构造器	说明
`ChartLegend(LegendScheme ls)`	Constructor

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`draw(Graphics2D g, PointF point)`	Draw legend
`int`	`getAspect()`	Get aspect
`Color`	`getBackground()`	Get background
`int`	`getColumnNumber()`	Get column number
`int`	`getHeight()`	Get height
`ChartText`	`getLabel()`	Get label
`Color`	`getLabelColor()`	Get label color
`Font`	`getLabelFont()`	Get label font
`String`	`getLabelLocation()`	Get label location (in, out, top, bottom, left, right)
`Dimension`	`getLegendDimension(Graphics2D g, Dimension limitDim)`	Get legend dimension
`int`	`getLegendHeight()`	Get legend height
`LegendScheme`	`getLegendScheme()`	Get legend scheme
`int`	`getLegendWidth()`	Get legend width
`Color`	`getNeatLineColor()`	Get neat line color
`float`	`getNeatLineSize()`	Get neat line size
`PlotOrientation`	`getPlotOrientation()`	Get plot orientation
`LegendPosition`	`getPosition()`	Get legend position
`float`	`getShrink()`	Get shrink
`Dimension`	`getSymbolDimension()`	Get symbol dimension
`protected int`	`getTickGap(Graphics2D g)`	Update tick gap
`protected int`	`getTickHeight(Graphics2D g)`
`float`	`getTickLabelAngle()`	Get tick lable angle
`Color`	`getTickLabelColor()`	Get tick label color
`Font`	`getTickLabelFont()`	Get Tick label font
`protected int`	`getTickWidth(Graphics2D g)`
`int`	`getWidth()`	Get width
`float`	`getX()`	Get X
`float`	`getXShift()`	Get x shift - pixel unit
`float`	`getY()`	Get Y
`float`	`getYShift()`	Get y shift - pixel unit
`boolean`	`isAutoExtendFrac()`	Get if auto set extend fraction - extend has save width and height Only valid for colorbar
`boolean`	`isAutoRowColNum()`	Get if automatic set row/col number
`boolean`	`isColorbar()`	Get if is color bar
`boolean`	`isDrawBackground()`	Get if draw background
`boolean`	`isDrawMaxLabel()`	Get if draw maximum value label
`boolean`	`isDrawMinLabel()`	Get if draw minimum value label
`boolean`	`isDrawNeatLine()`	Get if draw neat line
`boolean`	`isExtendRect()`	Get if extend rectangle - or triangle
`void`	`setAspect(int value)`	Set aspect
`void`	`setAutoExtendFrac(boolean value)`	Set if auto set extend fraction - extend has save width and height Only valid for colorbar
`void`	`setAutoRowColNum(boolean value)`	Set if automatic set row/col number
`void`	`setBackground(Color value)`	Set background
`void`	`setColorbar(boolean value)`	Set if is color bar
`void`	`setColumnNumber(int value)`	Set column number
`void`	`setDrawBackground(boolean value)`	Set if draw background
`void`	`setDrawMaxLabel(boolean value)`	Set if draw maximum value label
`void`	`setDrawMinLabel(boolean value)`	Set if draw minimum value label
`void`	`setDrawNeatLine(boolean istrue)`	Set if draw neat line
`void`	`setExtendRect(boolean value)`	Set if extend rectangle - or triangle
`void`	`setHeight(int value)`	Set height
`void`	`setLabel(ChartText value)`	Set label
`void`	`setLabelColor(Color value)`	Set label color
`void`	`setLabelFont(Font value)`	Set label font
`void`	`setLabelLocation(String value)`	Set label location
`void`	`setLegendHeight(int value)`	Set legend height
`void`	`setLegendScheme(LegendScheme value)`	Set legend scheme
`void`	`setLegendWidth(int value)`	Set legend width
`void`	`setNeatLineColor(Color color)`	Set neat line color
`void`	`setNeatLineSize(float size)`	Set neat line size
`void`	`setPlotOrientation(PlotOrientation value)`	Set plot orientation
`void`	`setPosition(LegendPosition value)`	Set legend position
`void`	`setShrink(float value)`	Set shrink
`void`	`setSymbolDimension(Dimension value)`	Set symbol dimension
`void`	`setSymbolHeight(int value)`	Set symbol height
`void`	`setSymbolScale(float value)`	Set symbol scale
`void`	`setSymbolWidth(int value)`	Set symbol width
`void`	`setTickCaptions(List<String> value)`	Set tick labels
`void`	`setTickLabelAngle(float value)`	Set tick label angle
`void`	`setTickLabelColor(Color value)`	Set tick label color
`void`	`setTickLabelFont(Font font)`	Set Tick label font
`void`	`setWidth(int value)`	Set width
`void`	`setX(float value)`	Set X
`void`	`setXShift(float value)`	Set x shift
`void`	`setY(float value)`	Set Y
`void`	`setYShift(float value)`	Set y shift

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

- 字段详细资料
  - legendScheme
```
protected LegendScheme legendScheme
```
  - shrink
```
protected float shrink
```
  - aspect
```
protected int aspect
```
  - x
```
protected float x
```
  - y
```
protected float y
```
  - orientation
```
protected PlotOrientation orientation
```
  - background
```
protected Color background
```
  - drawBackground
```
protected boolean drawBackground
```
  - width
```
protected int width
```
  - height
```
protected int height
```
  - legendWidth
```
protected int legendWidth
```
  - legendHeight
```
protected int legendHeight
```
  - label
```
protected ChartText label
```
  - labelLocation
```
protected String labelLocation
```
  - tickLabelFont
```
protected Font tickLabelFont
```
  - tickLabelColor
```
protected Color tickLabelColor
```
  - tickLabelAngle
```
protected float tickLabelAngle
```
  - drawNeatLine
```
protected boolean drawNeatLine
```
  - neatLineColor
```
protected Color neatLineColor
```
  - neatLineSize
```
protected float neatLineSize
```
  - _vBarWidth
```
protected double _vBarWidth
```
  - _hBarHeight
```
protected double _hBarHeight
```
  - extendRect
```
protected boolean extendRect
```
  - autoExtendFrac
```
protected boolean autoExtendFrac
```
  - drawMinLabel
```
protected boolean drawMinLabel
```
  - drawMaxLabel
```
protected boolean drawMaxLabel
```
  - xshift
```
protected float xshift
```
  - yshift
```
protected float yshift
```
- 构造器详细资料
  - ChartLegend
```
public ChartLegend(LegendScheme ls)
```
    Constructor
    
    参数:
    
    ls - LegendScheme
- 方法详细资料
  - getLegendScheme
```
public LegendScheme getLegendScheme()
```
    Get legend scheme
    
    返回:
    
    Legend scheme
  - setLegendScheme
```
public void setLegendScheme(LegendScheme value)
```
    Set legend scheme
    
    参数:
    
    value - Legend scheme
  - isColorbar
```
public boolean isColorbar()
```
    Get if is color bar
    
    返回:
    
    Boolean
  - setColorbar
```
public void setColorbar(boolean value)
```
    Set if is color bar
    
    参数:
    
    value - Boolean
  - getPosition
```
public LegendPosition getPosition()
```
    Get legend position
    
    返回:
    
    Legend position
  - setPosition
```
public void setPosition(LegendPosition value)
```
    Set legend position
    
    参数:
    
    value - Legend position
  - getShrink
```
public float getShrink()
```
    Get shrink
    
    返回:
    
    Shrink
  - setShrink
```
public void setShrink(float value)
```
    Set shrink
    
    参数:
    
    value - Shrink
  - getAspect
```
public int getAspect()
```
    Get aspect
    
    返回:
    
    Aspect
  - setAspect
```
public void setAspect(int value)
```
    Set aspect
    
    参数:
    
    value - Aspect
  - getX
```
public float getX()
```
    Get X
    
    返回:
    
    X value
  - setX
```
public void setX(float value)
```
    Set X
    
    参数:
    
    value - X value
  - getY
```
public float getY()
```
    Get Y
    
    返回:
    
    Y value
  - setY
```
public void setY(float value)
```
    Set Y
    
    参数:
    
    value - Y value
  - getWidth
```
public int getWidth()
```
    Get width
    
    返回:
    
    Width
  - setWidth
```
public void setWidth(int value)
```
    Set width
    
    参数:
    
    value - Width
  - getHeight
```
public int getHeight()
```
    Get height
    
    返回:
    
    Height
  - setHeight
```
public void setHeight(int value)
```
    Set height
    
    参数:
    
    value - Height
  - getLegendWidth
```
public int getLegendWidth()
```
    Get legend width
    
    返回:
    
    Legend width
  - setLegendWidth
```
public void setLegendWidth(int value)
```
    Set legend width
    
    参数:
    
    value - Legend width
  - getLegendHeight
```
public int getLegendHeight()
```
    Get legend height
    
    返回:
    
    Legend height
  - setLegendHeight
```
public void setLegendHeight(int value)
```
    Set legend height
    
    参数:
    
    value - Legend height
  - getPlotOrientation
```
public PlotOrientation getPlotOrientation()
```
    Get plot orientation
    
    返回:
    
    Plot orientation
  - setPlotOrientation
```
public void setPlotOrientation(PlotOrientation value)
```
    Set plot orientation
    
    参数:
    
    value - Plot orientation
  - getBackground
```
public Color getBackground()
```
    Get background
    
    返回:
    
    Background
  - setBackground
```
public void setBackground(Color value)
```
    Set background
    
    参数:
    
    value - Background
  - isDrawBackground
```
public boolean isDrawBackground()
```
    Get if draw background
    
    返回:
    
    Boolean
  - setDrawBackground
```
public void setDrawBackground(boolean value)
```
    Set if draw background
    
    参数:
    
    value - Boolean
  - isDrawNeatLine
```
public boolean isDrawNeatLine()
```
    Get if draw neat line
    
    返回:
    
    If draw neat line
  - setDrawNeatLine
```
public void setDrawNeatLine(boolean istrue)
```
    Set if draw neat line
    
    参数:
    
    istrue - If draw neat line
  - getNeatLineColor
```
public Color getNeatLineColor()
```
    Get neat line color
    
    返回:
    
    Neat line color
  - setNeatLineColor
```
public void setNeatLineColor(Color color)
```
    Set neat line color
    
    参数:
    
    color - Neat line color
  - getNeatLineSize
```
public float getNeatLineSize()
```
    Get neat line size
    
    返回:
    
    Neat line size
  - setNeatLineSize
```
public void setNeatLineSize(float size)
```
    Set neat line size
    
    参数:
    
    size - Neat line size
  - getLabel
```
public ChartText getLabel()
```
    Get label
    
    返回:
    
    Label
  - setLabel
```
public void setLabel(ChartText value)
```
    Set label
    
    参数:
    
    value - Label
  - getLabelFont
```
public Font getLabelFont()
```
    Get label font
    
    返回:
    
    Label font
  - setLabelFont
```
public void setLabelFont(Font value)
```
    Set label font
    
    参数:
    
    value - Label font
  - getLabelColor
```
public Color getLabelColor()
```
    Get label color
    
    返回:
    
    Label color
  - setLabelColor
```
public void setLabelColor(Color value)
```
    Set label color
    
    参数:
    
    value - Label color
  - getLabelLocation
```
public String getLabelLocation()
```
    Get label location (in, out, top, bottom, left, right)
    
    返回:
    
    Label location
  - setLabelLocation
```
public void setLabelLocation(String value)
```
    Set label location
    
    参数:
    
    value - Label location
  - getTickLabelFont
```
public Font getTickLabelFont()
```
    Get Tick label font
    
    返回:
    
    The Tick label font
  - setTickLabelFont
```
public void setTickLabelFont(Font font)
```
    Set Tick label font
    
    参数:
    
    font - The Tick label font
  - getTickLabelColor
```
public Color getTickLabelColor()
```
    Get tick label color
    
    返回:
    
    Tick label color
  - setTickLabelColor
```
public void setTickLabelColor(Color value)
```
    Set tick label color
    
    参数:
    
    value - Tick label color
  - getTickLabelAngle
```
public float getTickLabelAngle()
```
    Get tick lable angle
    
    返回:
    
    Tick label angle
  - setTickLabelAngle
```
public void setTickLabelAngle(float value)
```
    Set tick label angle
    
    参数:
    
    value - Tick label angle
  - getColumnNumber
```
public int getColumnNumber()
```
    Get column number
    
    返回:
    
    Column number
  - setColumnNumber
```
public void setColumnNumber(int value)
```
    Set column number
    
    参数:
    
    value - Column number
  - isAutoRowColNum
```
public boolean isAutoRowColNum()
```
    Get if automatic set row/col number
    
    返回:
    
    Boolean
  - setAutoRowColNum
```
public void setAutoRowColNum(boolean value)
```
    Set if automatic set row/col number
    
    参数:
    
    value - Boolean
  - getSymbolDimension
```
public Dimension getSymbolDimension()
```
    Get symbol dimension
    
    返回:
    
    Symbol dimension
  - setSymbolDimension
```
public void setSymbolDimension(Dimension value)
```
    Set symbol dimension
    
    参数:
    
    value - Symbol dimension
  - setSymbolWidth
```
public void setSymbolWidth(int value)
```
    Set symbol width
    
    参数:
    
    value - Width
  - setSymbolHeight
```
public void setSymbolHeight(int value)
```
    Set symbol height
    
    参数:
    
    value - height
  - setSymbolScale
```
public void setSymbolScale(float value)
```
    Set symbol scale
    
    参数:
    
    value - Symble scale
  - isExtendRect
```
public boolean isExtendRect()
```
    Get if extend rectangle - or triangle
    
    返回:
    
    Boolean
  - setExtendRect
```
public void setExtendRect(boolean value)
```
    Set if extend rectangle - or triangle
    
    参数:
    
    value - Boolean
  - isAutoExtendFrac
```
public boolean isAutoExtendFrac()
```
    Get if auto set extend fraction - extend has save width and height Only valid for colorbar
    
    返回:
    
    Boolean
  - setAutoExtendFrac
```
public void setAutoExtendFrac(boolean value)
```
    Set if auto set extend fraction - extend has save width and height Only valid for colorbar
    
    参数:
    
    value -
  - setTickCaptions
```
public void setTickCaptions(List<String> value)
```
    Set tick labels
    
    参数:
    
    value - Tick labels
  - isDrawMinLabel
```
public boolean isDrawMinLabel()
```
    Get if draw minimum value label
    
    返回:
    
    Boolean
  - setDrawMinLabel
```
public void setDrawMinLabel(boolean value)
```
    Set if draw minimum value label
    
    参数:
    
    value - Boolean
  - isDrawMaxLabel
```
public boolean isDrawMaxLabel()
```
    Get if draw maximum value label
    
    返回:
    
    Boolean
  - setDrawMaxLabel
```
public void setDrawMaxLabel(boolean value)
```
    Set if draw maximum value label
    
    参数:
    
    value - Boolean
  - getXShift
```
public float getXShift()
```
    Get x shift - pixel unit
    
    返回:
    
    X shift
  - setXShift
```
public void setXShift(float value)
```
    Set x shift
    
    参数:
    
    value - X shift
  - getYShift
```
public float getYShift()
```
    Get y shift - pixel unit
    
    返回:
    
    Y shift
  - setYShift
```
public void setYShift(float value)
```
    Set y shift
    
    参数:
    
    value - Y shift
  - draw
```
public void draw(Graphics2D g,
                 PointF point)
```
    Draw legend
    
    参数:
    
    g - Graphics2D
    
    point - Start point
  - getLegendDimension
```
public Dimension getLegendDimension(Graphics2D g,
                                    Dimension limitDim)
```
    Get legend dimension
    
    参数:
    
    g - Graphics2D
    
    limitDim - Limit dimension
    
    返回:
    
    Legend dimension
  - getTickWidth
```
protected int getTickWidth(Graphics2D g)
```
  - getTickHeight
```
protected int getTickHeight(Graphics2D g)
```
  - getTickGap
```
protected int getTickGap(Graphics2D g)
```
    Update tick gap
    
    参数:
    
    g - Graphics2D
    
    返回:
    
    Ticks gap

类 ChartLegend

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

legendScheme

shrink

aspect

x

y

orientation

background

drawBackground

width

height

legendWidth

legendHeight

label

labelLocation

tickLabelFont

tickLabelColor

tickLabelAngle

drawNeatLine

neatLineColor

neatLineSize

_vBarWidth

_hBarHeight

extendRect

autoExtendFrac

drawMinLabel

drawMaxLabel

xshift

yshift

构造器详细资料

ChartLegend

方法详细资料

getLegendScheme

setLegendScheme

isColorbar

setColorbar

getPosition

setPosition

getShrink

setShrink

getAspect

setAspect

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getLegendWidth

setLegendWidth

getLegendHeight

setLegendHeight

getPlotOrientation

setPlotOrientation

getBackground

setBackground

isDrawBackground

setDrawBackground

isDrawNeatLine

setDrawNeatLine

getNeatLineColor

setNeatLineColor

getNeatLineSize

setNeatLineSize

getLabel

setLabel

getLabelFont

setLabelFont

getLabelColor

setLabelColor

getLabelLocation

setLabelLocation