Package qupath.lib.io

Enum Class PathIO.GeoJsonExportOptions

java.lang.Object

java.lang.Enum<PathIO.GeoJsonExportOptions>

qupath.lib.io.PathIO.GeoJsonExportOptions

All Implemented Interfaces:

Serializable, Comparable<PathIO.GeoJsonExportOptions>, Constable

Enclosing class:

PathIO

public static enum PathIO.GeoJsonExportOptions
extends Enum<PathIO.GeoJsonExportOptions>

Options to customize the export of PathObjects as GeoJSON.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE_MEASUREMENTS	Optionally exclude measurements from objects.
FEATURE_COLLECTION	Request that objects are export as a FeatureCollection.
PRETTY_JSON	Request pretty-printing for the JSON.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRETTY_JSON

public static final PathIO.GeoJsonExportOptions PRETTY_JSON

Request pretty-printing for the JSON. This is more readable, but results in larger files.

EXCLUDE_MEASUREMENTS

public static final PathIO.GeoJsonExportOptions EXCLUDE_MEASUREMENTS

Optionally exclude measurements from objects. This can reduce the file size substantially if measurements are not needed.

FEATURE_COLLECTION

public static final PathIO.GeoJsonExportOptions FEATURE_COLLECTION

Request that objects are export as a FeatureCollection. If this is not specified, individual objects will be export as Features - in an array if necessary.

Method Details

values

public static PathIO.GeoJsonExportOptions[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PathIO.GeoJsonExportOptions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null