Package com.esri.arcgisruntime.ogc.kml

Enum KmlUnitsType

java.lang.Object

java.lang.Enum<KmlUnitsType>

com.esri.arcgisruntime.ogc.kml.KmlUnitsType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KmlUnitsType>

public enum KmlUnitsType
extends java.lang.Enum<KmlUnitsType>

A KML units type.

Use the KmlUnitsType enumeration (either via KmlImageCoordinate.getXUnits() and KmlImageCoordinate.getYUnits() or via the KmlImageCoordinate(double, double, KmlUnitsType, KmlUnitsType) onstructor) to establish the KML image coordinate system. Values of type fraction must be between 0.0 and 1.0. Values below 0.0 will be set to 0.0, and values above 1.0 will be set to 1.0. If a non-integral number is specified with a unit type of device-independent pixels PIXELS or INSET_PIXELS, it will be rounded down to a whole number (e.g. 2.243 will be rounded to 2.0).

Since:

100.6.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
FRACTION	Treat the x/y value as a fraction of the width/height.
INSET_PIXELS	Treat the x/y value as an integral number of device-independent pixels (dips) from the top right cvorner.
PIXELS	Treat the x/y value as an integral number of device-independent pixels (dips).

Method Summary

Modifier and Type	Method	Description
static KmlUnitsType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static KmlUnitsType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FRACTION

public static final KmlUnitsType FRACTION

Treat the x/y value as a fraction of the width/height. This is the default value.

Since:

100.6.0

PIXELS

public static final KmlUnitsType PIXELS

Treat the x/y value as an integral number of device-independent pixels (dips).

Since:

100.6.0

INSET_PIXELS

public static final KmlUnitsType INSET_PIXELS

Treat the x/y value as an integral number of device-independent pixels (dips) from the top right cvorner.

Since:

100.6.0

Method Detail

values

public static KmlUnitsType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KmlUnitsType c : KmlUnitsType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KmlUnitsType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null