org.jplot2d.element

Interface SymbolAnnotation

All Superinterfaces:

Annotation, Element, MovableComponent, PComponent, PointAnnotation, TextComponent

All Known Subinterfaces:

CoordinateAnnotation, CoordinateAnnotationEx, SymbolAnnotationEx

All Known Implementing Classes:

CoordinateAnnotationImpl, SymbolAnnotationImpl

public interface SymbolAnnotation
extends PointAnnotation, TextComponent

A point annotation with a symbol and a text string.

Method Summary

Modifier and Type	Method and Description
double	getAngle() Returns the rotation angle of the text.
float	getSymbolScale() Returns the scale apply to effective font size to derive symbol size when symbol size is NaN.
SymbolShape	getSymbolShape() Returns the symbol shape of this annotation
float	getSymbolSize() Returns the symbol size of this annotation
float	getTextOffsetFactorX() Returns the X offset factor of text.
float	getTextOffsetFactorY() Returns the Y offset of text.The offset is relative to the base point of this annotation.
void	setAngle(double angle) Set the rotation angle of the text.
void	setSymbolScale(float scale) Sets the scale apply to effective font size to derive symbol size when symbol size is NaN.
void	setSymbolShape(SymbolShape symbol) Sets the symbol shape of this annotation
void	setSymbolSize(float size) Sets the symbol shape of this annotation
void	setTextOffsetFactorX(float offset) Sets the X offset factor of text.
void	setTextOffsetFactorY(float offset) Sets the Y offset of text.The offset is relative to the base point of this annotation.

Methods inherited from interface org.jplot2d.element.PointAnnotation

getValuePoint, setValuePoint, setValuePoint

Methods inherited from interface org.jplot2d.element.Annotation

getParent, isMovable, setMovable

Methods inherited from interface org.jplot2d.element.MovableComponent

setLocation, setLocation

Methods inherited from interface org.jplot2d.element.PComponent

getBounds, getColor, getEffectiveFont, getFontName, getFontScale, getFontSize, getFontStyle, getLocation, getPaperTransform, getSelectableBounds, getSize, getZOrder, isCacheable, isSelectable, isVisible, setCacheable, setColor, setFont, setFontName, setFontScale, setFontSize, setFontStyle, setSelectable, setVisible, setZOrder

Methods inherited from interface org.jplot2d.element.Element

getEnvironment, getId

Methods inherited from interface org.jplot2d.element.TextComponent

getHAlign, getText, getVAlign, setHAlign, setText, setVAlign

Method Detail

getSymbolShape

SymbolShape getSymbolShape()

Returns the symbol shape of this annotation

Returns:

the symbol shape of this annotation

setSymbolShape

void setSymbolShape(SymbolShape symbol)

Sets the symbol shape of this annotation

Parameters:

symbol - the symbol shape of this annotation

getSymbolSize

float getSymbolSize()

Returns the symbol size of this annotation

Returns:

the symbol size of this annotation

setSymbolSize

void setSymbolSize(float size)

Sets the symbol shape of this annotation

Parameters:

symbol - the symbol size of this annotation

getSymbolScale

float getSymbolScale()

Returns the scale apply to effective font size to derive symbol size when symbol size is NaN.

Returns:

the font scale.

setSymbolScale

void setSymbolScale(float scale)

Sets the scale apply to effective font size to derive symbol size when symbol size is NaN.

Parameters:

scale - the scale

getAngle

double getAngle()

Returns the rotation angle of the text.

Returns:

the rotation angle value

setAngle

void setAngle(double angle)

Set the rotation angle of the text. The angle start to count from horizontal direction and grow in counter-clock wise direction.

Parameters:

angle - the rotation angle

getTextOffsetFactorX

float getTextOffsetFactorX()

Returns the X offset factor of text. The offset is relative to the base point of this annotation. The factor apply to the half size of symbol.

Returns:

the X offset factor of text

setTextOffsetFactorX

void setTextOffsetFactorX(float offset)

Sets the X offset factor of text. The offset is relative to the base point of this annotation. The factor apply to the half size of symbol.

Parameters:

offset - the X offset factor of text

getTextOffsetFactorY

float getTextOffsetFactorY()

Returns the Y offset of text.The offset is relative to the base point of this annotation. The factor apply to the half size of symbol.

Returns:

the Y offset factor of text

setTextOffsetFactorY

void setTextOffsetFactorY(float offset)

Sets the Y offset of text.The offset is relative to the base point of this annotation. The factor apply to the half size of symbol.

Parameters:

offset - the Y offset factor of text