com.esri.arcgis.trackinganalyst
Interface ITemporalLegendClass

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITemporalLegendClass2

All Known Implementing Classes:

ITemporalLegendClass2Proxy, ITemporalLegendClassProxy, TemporalLegendClass

public interface ITemporalLegendClass
extends java.io.Serializable

COM Interface 'ITemporalLegendClass'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties to manage temporal ranges.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDb75d6fb8_1333_11d5_b7c9_00010265adc5
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getDescription() Legend class description.
ILegendClassFormat	getFormat() Optional.
java.lang.String	getLabel() Legend class label.
double	getPeriod() Indicates period setting for temporal data layer.
double	getStartingOffset() Indicates initial offset setting for temporal data.
ISymbol	getSymbol() Legend class symbol.
IColor	getSymbolColor() Indicates symbol size setting for temporal events as they display on the map.
double	getSymbolSize() Indicates symbol size setting for temporal events as they display on the map.
int	getTimeUnits() Indicates unit of time used to define period of time window.
int	getType() Identifies special drawing properties of a temporal legend class.
boolean	intersects(java.lang.Object vTimeValue) Determines whether or not the Time Value intersects the Reference and TimeValue parameters.
void	setDescription(java.lang.String label) Legend class description.
void	setFormat(ILegendClassFormat format) Optional.
void	setLabel(java.lang.String label) Legend class label.
void	setPeriod(double pVal) Indicates period setting for temporal data layer.
void	setReference(java.lang.Object varReference) Sets the temporal reference properties for the temporal legend class.
void	setStartingOffset(double pVal) Indicates initial offset setting for temporal data.
void	setSymbolByRef(ISymbol symbol) Legend class symbol.
void	setTimeUnits(int pVal) Indicates unit of time used to define period of time window.
void	setType(int penumTemporalLegendType) Identifies special drawing properties of a temporal legend class.

Field Detail

IIDb75d6fb8_1333_11d5_b7c9_00010265adc5

static final int IIDb75d6fb8_1333_11d5_b7c9_00010265adc5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getSymbol

ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Legend class symbol.

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Legend class symbol.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel()
                          throws java.io.IOException,
                                 AutomationException

Legend class label.

Returns:

The label

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Legend class label.

Parameters:

label - The label (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Legend class description.

Returns:

The label

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String label)
                    throws java.io.IOException,
                           AutomationException

Legend class description.

Parameters:

label - The label (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormat

ILegendClassFormat getFormat()
                             throws java.io.IOException,
                                    AutomationException

Optional. If non-null, then layer specifies class formatting information.

Returns:

A reference to a com.esri.arcgis.carto.ILegendClassFormat

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormat

void setFormat(ILegendClassFormat format)
               throws java.io.IOException,
                      AutomationException

Optional. If non-null, then layer specifies class formatting information.

Parameters:

format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartingOffset

double getStartingOffset()
                         throws java.io.IOException,
                                AutomationException

Indicates initial offset setting for temporal data.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingOffset

void setStartingOffset(double pVal)
                       throws java.io.IOException,
                              AutomationException

Indicates initial offset setting for temporal data.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPeriod

double getPeriod()
                 throws java.io.IOException,
                        AutomationException

Indicates period setting for temporal data layer.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPeriod

void setPeriod(double pVal)
               throws java.io.IOException,
                      AutomationException

Indicates period setting for temporal data layer.

Parameters:

pVal - The pVal (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeUnits

int getTimeUnits()
                 throws java.io.IOException,
                        AutomationException

Indicates unit of time used to define period of time window.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeUnits

void setTimeUnits(int pVal)
                  throws java.io.IOException,
                         AutomationException

Indicates unit of time used to define period of time window.

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumTemporalUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws java.io.IOException,
                   AutomationException

Identifies special drawing properties of a temporal legend class.

Returns:

A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(int penumTemporalLegendType)
             throws java.io.IOException,
                    AutomationException

Identifies special drawing properties of a temporal legend class.

Parameters:

penumTemporalLegendType - A com.esri.arcgis.trackinganalyst.enumTemporalLegendType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersects

boolean intersects(java.lang.Object vTimeValue)
                   throws java.io.IOException,
                          AutomationException

Determines whether or not the Time Value intersects the Reference and TimeValue parameters.

Parameters:

vTimeValue - A Variant (in)

Returns:

The pbInersects

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReference

void setReference(java.lang.Object varReference)
                  throws java.io.IOException,
                         AutomationException

Sets the temporal reference properties for the temporal legend class.

Parameters:

varReference - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolSize

double getSymbolSize()
                     throws java.io.IOException,
                            AutomationException

Indicates symbol size setting for temporal events as they display on the map.

Returns:

The pdSize

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbolColor

IColor getSymbolColor()
                      throws java.io.IOException,
                             AutomationException

Indicates symbol size setting for temporal events as they display on the map.

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.