Package qupath.lib.extension.svg

Enum Class SvgTools.SvgBuilder.ImageIncludeType

java.lang.Object

java.lang.Enum<SvgTools.SvgBuilder.ImageIncludeType>

qupath.lib.extension.svg.SvgTools.SvgBuilder.ImageIncludeType

All Implemented Interfaces:

Serializable, Comparable<SvgTools.SvgBuilder.ImageIncludeType>, Constable

Enclosing class:

SvgTools.SvgBuilder

public static enum SvgTools.SvgBuilder.ImageIncludeType
extends Enum<SvgTools.SvgBuilder.ImageIncludeType>

Enum defining ways in which raster images may be included in the SVG file.

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
EMBED	Embed the image (as Base64-encoded PNG).
LINK	Link the image (to a separate PNG).
NONE	Do not include images.

Method Summary

Modifier and Type	Method	Description
String	toString()
static SvgTools.SvgBuilder.ImageIncludeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SvgTools.SvgBuilder.ImageIncludeType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SvgTools.SvgBuilder.ImageIncludeType NONE

Do not include images.

EMBED

public static final SvgTools.SvgBuilder.ImageIncludeType EMBED

Embed the image (as Base64-encoded PNG).

LINK

public static final SvgTools.SvgBuilder.ImageIncludeType LINK

Link the image (to a separate PNG).

Method Details

values

public static SvgTools.SvgBuilder.ImageIncludeType[] 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 SvgTools.SvgBuilder.ImageIncludeType 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

toString

public String toString()

Overrides:

toString in class Enum<SvgTools.SvgBuilder.ImageIncludeType>