Package com.storedobject.chart

Class PointSymbol

java.lang.Object

com.storedobject.chart.PointSymbol

All Implemented Interfaces:

ComponentProperty, VisibleProperty

Direct Known Subclasses:

GraphData.Category

public class PointSymbol
extends Object
implements ComponentProperty, VisibleProperty

Represents the symbol used to draw a point on the chart. (Example usage is in LineChart).

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
PointSymbol()	Default constructor for the PointSymbol class.
PointSymbol(PointSymbolType type)	Constructs a PointSymbol with the specified PointSymbolType.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
Offset	getOffset(boolean createIfNotExists)	Retrieves the offset for the point symbol.
final PointSymbolType	getType()	Retrieves the current type of the point symbol.
boolean	isVisible()	Checks if this property is currently visible.
PointSymbol	offset(Offset offset)	Sets the offset for the PointSymbol and returns the updated instance.
void	setHoverAnimation(boolean hoverAnimation)	Sets the hover animation property for the symbol.
void	setOffset(Offset offset)	Sets the offset for the point symbol.
void	setSize(int size)	Sets the size of the point symbol based on the given value.
void	setSize(int width, int height)	Sets the size of the symbol using specified width and height values.
void	setType(PointSymbolType pointSymbolType)	Sets the type of the point symbol.
void	setURL(String url)	Sets the URL for the point symbol.
void	setVisible(boolean visible)	Sets the visibility of this property.
PointSymbol	size(int size)	Sets the size of the point symbol and returns the updated PointSymbol instance.
PointSymbol	size(int width, int height)	Updates the size of the point symbol using the specified width and height values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

PointSymbol

public PointSymbol()

Default constructor for the PointSymbol class. Creates a PointSymbol with the default symbol type PointSymbolType.CIRCLE.

PointSymbol

public PointSymbol(PointSymbolType type)

Constructs a PointSymbol with the specified PointSymbolType.

Parameters:

type - The type of the point symbol to be used.

Method Details

setURL

public void setURL(String url)

Sets the URL for the point symbol. The URL should start with either "image://" or "path://". If it starts with "image://", then the URL should be a valid URL pointing to an image, and if it starts with "path://", then it should be valid SVG code. If the provided URL is null, empty, or does not start with valid prefixes, the URL is set to null. Additionally, the point symbol type is ignored when a valid URL is provided.

Parameters:

url - The URL to be set for the point symbol. Valid URLs should start with either "image://" or "path://".

setVisible

public void setVisible(boolean visible)

Description copied from interface: VisibleProperty

Sets the visibility of this property.

Specified by:

setVisible in interface VisibleProperty

Parameters:

visible - A boolean indicating whether this property should be visible (true) or hidden (false).

isVisible

public boolean isVisible()

Description copied from interface: VisibleProperty

Checks if this property is currently visible.

Specified by:

isVisible in interface VisibleProperty

Returns:

true if the property is visible, false otherwise.

setType

public void setType(PointSymbolType pointSymbolType)

Sets the type of the point symbol.

Parameters:

pointSymbolType - The type of the point symbol to assign.

getType

public final PointSymbolType getType()

Retrieves the current type of the point symbol.

Returns:

The current PointSymbolType of the point symbol.

setSize

public void setSize(int size)

Sets the size of the point symbol based on the given value. If the input size is less than or equal to zero, the size will be set to null. Otherwise, the size is set to the string representation of the given value.

Parameters:

size - The size of the point symbol to set. A positive value sets the size, while a non-positive value resets it to null.

size

public PointSymbol size(int size)

Sets the size of the point symbol and returns the updated PointSymbol instance. The size determines the visual dimensions of the point symbol.

Parameters:

size - The size of the point symbol to set. A positive value assigns the size, while a non-positive value resets the size to null.

Returns:

The updated PointSymbol instance with the specified size applied.

setSize

public void setSize(int width,
 int height)

Sets the size of the symbol using specified width and height values.

Parameters:

width - The width of the symbol. Should be a positive value.

height - The height of the symbol. Should be a positive value. If both width and height are not positive, the size will be set to null. If only one of width or height is positive, the size will be adjusted accordingly by reusing other overloads of this method.

size

public PointSymbol size(int width,
 int height)

Updates the size of the point symbol using the specified width and height values. The size defines the visual dimensions of the point symbol and influences its rendering within the chart.

Parameters:

width - The width of the point symbol. Should be a positive value. If width is non-positive, the size may be reset depending on height value.

height - The height of the point symbol. Should be a positive value. If height is non-positive, the size may be reset depending on width value.

Returns:

The updated PointSymbol instance with the specified size applied.

setHoverAnimation

public void setHoverAnimation(boolean hoverAnimation)

Sets the hover animation property for the symbol. When enabled, the symbol will display animations on hover, typically enhancing the visual interaction for users.

Parameters:

hoverAnimation - Specifies whether the hover animation should be enabled or disabled. A value of true enables the animation, while false disables it.

setOffset

public void setOffset(Offset offset)

Sets the offset for the point symbol. The offset determines the horizontal (x-axis) and vertical (y-axis) displacement of the symbol.

Parameters:

offset - The offset to be set for the point symbol. It specifies the x and y offsets in relation to the default position.

offset

public PointSymbol offset(Offset offset)

Sets the offset for the PointSymbol and returns the updated instance.

Parameters:

offset - The Offset to be applied to the PointSymbol.

Returns:

The updated PointSymbol instance with the specified offset applied.

getOffset

public Offset getOffset(boolean createIfNotExists)

Retrieves the offset for the point symbol. If the offset does not already exist and the createIfNotExists parameter is true, a new Offset instance will be created.

Parameters:

createIfNotExists - A boolean flag indicating whether to create a new Offset instance if none exists. If true, a new offset will be created when it does not exist; otherwise, null will be returned if it does not already exist.

Returns:

The Offset instance associated with the point symbol. May return null if no offset exists and createIfNotExists is false.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Parameters:

sb - Encoded JSON string to be appended to this.