Package com.esri.arcgisruntime.mapping.labeling

Class LabelExpression

java.lang.Object

com.esri.arcgisruntime.mapping.labeling.LabelExpression

Direct Known Subclasses:

ArcadeLabelExpression, SimpleLabelExpression, WebmapLabelExpression

public abstract class LabelExpression
extends java.lang.Object

Abstract base class for the different types of expressions that can be used to create label text.

Users can read the expression script using the getExpression() property. To specify an expression script, users create an object of type ArcadeLabelExpression, SimpleLabelExpression or WebmapLabelExpression with the required expression script and assign it to the label expression object.

Since:

100.11.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LabelExpression(com.esri.arcgisruntime.internal.jni.CoreLabelExpression coreLabelExpression)	Creates a LabelExpression from a CoreLabelExpression instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExpression()	Gets the label expression script string.
void	setExpression(java.lang.String expression)	Sets the label expression script string.

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelExpression

protected LabelExpression(com.esri.arcgisruntime.internal.jni.CoreLabelExpression coreLabelExpression)

Creates a LabelExpression from a CoreLabelExpression instance.

Since:

100.11.0

Method Detail

getExpression

public java.lang.String getExpression()

Gets the label expression script string.

The expression is expected to be a complete, self-contained label expression in the language specified by the label expression subclass object.

Returns:

the label expression script string

Since:

100.11.0

setExpression

public void setExpression(java.lang.String expression)

Sets the label expression script string.

The expression is expected to be a complete, self-contained label expression in the language specified by the label expression subclass object.

Parameters:

expression - the label expression script string

Throws:

java.lang.IllegalArgumentException - if expression is null

Since:

100.11.0