CoTrackSymbologyRenderer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.trackinganalyst
Class CoTrackSymbologyRenderer

java.lang.Object
  com.esri.arcgis.trackinganalyst.CoTrackSymbologyRenderer

All Implemented Interfaces:: IDynamicLegendRenderer, IFeatureRenderer, ILegendInfo, ILookupSymbol, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IPropertySupport, ISupportErrorInfo, IHighlightSuppressionRenderer, ILastKnownRenderer, ISimpleTrackingLabelRenderer, ITemporalRenderer, ITemporalRenderer2, ITrackRenderer, ITrackSymbologyRenderer, ITxHideFeatures, ITxHighlightFeatures, ITxHighlightSettings, ITxHighlightTracks, ITxRendererSetup, Externalizable, Serializable

public class CoTrackSymbologyRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackSymbologyRenderer, ITemporalRenderer, IFeatureRenderer, ILegendInfo, IDisplayAdmin, IPropertySupport, ILookupSymbol, ISimpleTrackingLabelRenderer, ILastKnownRenderer, IHighlightSuppressionRenderer, IClone, ISupportErrorInfo, ITemporalRenderer2, ITrackRenderer, ITxRendererSetup, IPersistStream, IPersist, IDocumentVersionSupportGEN, ITxHighlightTracks, ITxHighlightFeatures, ITxHighlightSettings, ITxHideFeatures, IDynamicLegendRenderer, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackSymbologyRenderer, ITemporalRenderer, IFeatureRenderer, ILegendInfo, IDisplayAdmin, IPropertySupport, ILookupSymbol, ISimpleTrackingLabelRenderer, ILastKnownRenderer, IHighlightSuppressionRenderer, IClone, ISupportErrorInfo, ITemporalRenderer2, ITrackRenderer, ITxRendererSetup, IPersistStream, IPersist, IDocumentVersionSupportGEN, ITxHighlightTracks, ITxHighlightFeatures, ITxHighlightSettings, ITxHideFeatures, IDynamicLegendRenderer, Externalizable

Symbolizes temporal based features and tracks in order to identify temporal feature characteristics in relation to the temporal reference.

Description

The Tracks Renderer is the COM object that symbolizes temporal based features in order to identify temporal characteristics about a feature with resepect to a pre-defined temporal reference. The Tracks Renderer also connects the draw symbology with lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:: Serialized Form

Constructor Summary
`CoTrackSymbologyRenderer()` Constructs a CoTrackSymbologyRenderer using ArcGIS Engine.
`CoTrackSymbologyRenderer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `CoTrackSymbologyRenderer theCoTrackSymbologyRenderer = (CoTrackSymbologyRenderer) obj;`

Method Summary
`boolean`	`applies(Object pUnk)` Indicates if the receiver can apply the given object at any given time.
`Object`	`apply(Object newObject)` Applies the given property to the receiver and returns the old object.
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`boolean`	`canApply(Object pUnk)` Indicates if the receiver can apply the given object at that particular moment.
`boolean`	`canRender(IFeatureClass featClass, IDisplay display)` Indicates if the specified feature class can be rendered on the given display.
`void`	`canRenderComponent(IFeatureClass piFeatClass, IDisplay piDisplay, boolean[] pbvarResult, Object piComponent, String bstrComponent)` Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.
`Object`	`convertToSupportedObject(int docVersion)` Convert the object to another object that is supported.
`void`	`draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws features from the specified cursor on the given display.
`boolean`	`equals(Object o)` Compare this object with another
`IClone`	`esri_clone()` Clones the receiver and assigns the result to *clone.
`void`	`finishInstrumentedDraw()` Call after renderer.Draw.
`IActionCollection`	`getActions()` Indicates properties of Highlight or Suppression action to be used by highlight/suppression renderer in drawing events to the map.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`IPropertySet`	`getComponentSets()` Used to contain the properties of all of the various temporal renderers.
`Object`	`getCurrent(Object pUnk)` The object currently being used.
`IFeatureRenderer`	`getEventAdvRenderer()` Provides the event's advanced renderer.
`IFeatureClass`	`getFeatureClass()` The feature class holding data information used by the renderer.
`IColor`	`getHighlightFeatureColor()` The highlight color drawn for highlighted features.
`IColor`	`getHighlightTrackFeatureColor()` The highlight color drawn for features in highlighted tracks.
`IColor`	`getHighlightTrackLineColor()` The highlight color drawn for track-lines in highlighted tracks.
`int`	`getHistory()` Indicates the number of history events composing the track that will be used to represent the track line.
`IUID`	`getID()` Indicates ID value of event for tracking label renderer.
`int`	`getInstrumentedDrawPhases()` Draw phases that affect dynamic legends.
`String`	`getLabelFieldName()` Name of the field whose contents will be used as the tracking label when drawing to the map display.
`ILegendGroup`	`getLegendGroup(int index)` Legend group at the specified index.
`int`	`getLegendGroupCount()` Number of legend groups contained by the object.
`ILegendItem`	`getLegendItem()` Optional.
`IFeatureRenderer`	`getMostCurrentAdvRenderer()` Provides the most current event's advanced renderer.
`IFeatureRenderer`	`getMostCurrentRenderer()` Provides the most current event renderer.
`IFeatureRenderer`	`getObservationRenderer()` Renders observation symbology using functionality of standard Esri symbology system.
`double`	`getOffsetAngle()` Indicates angle of offset for labels to display from the event on the map display.
`short`	`getPixelOffset()` Indicates amount of offset for the label renderer to draw labels next to events in the map display.
`IUID`	`getPropPageEventRenderer()` Provides the Class ID of the property page associated with the event renderer.
`IUID`	`getPropPageEventsAdvancedRenderer()` Provides the Class ID of the property page associated with the advanced renderer of the events.
`IUID`	`getPropPageMCAdvancedRenderer()` Provides the Class ID of the property page associated with the advanced renderer of the most current events.
`IUID`	`getPropPageMostCurrentRenderer()` Provides the Class ID of the property page associated with the most current renderer.
`IUID`	`getPropPageTrackRenderer()` Provides the Class ID of the property page associated with the track renderer.
`IUID`	`getPropPageTracksAdvancedRenderer()` Provides the Class ID of the property page associated with the advanced renderer of the tracks.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`ISymbol`	`getSymbolByFeature(IFeature feature)` Symbol used to draw the specified feature.
`String`	`getTemporalFieldName()` Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
`ITemporalLegendGroup`	`getTemporalLegend()` Points to a Temporal Legend class that defines how symbology is rendered temporally.
`String`	`getTemporalObjectColumnName()` Indicates the feature class column that identifies or groups temporal observations with time series.
`Object`	`getTemporalPerspective()` A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
`ITextSymbol`	`getTextSymbol()` Indicates settings for the text symbol appearance used to label temporal events.
`int`	`getTimeSymbologyMethod()` Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.
`IFeatureRenderer`	`getTrackSymbologyRenderer()` Controls the temporal track symbology drawn on the map.
`int`	`hashCode()` the hashcode for this object
`void`	`hideAllTracks(boolean hide)` Specifies whether all tracks should be hidden.
`void`	`hideTrack(String trackId, boolean hide)` Specifies whether the given track should be hidden.
`void`	`highlightAllFeatures(boolean highlight)` Specifies that all features should be highlighted or unhighlighted.
`void`	`highlightAllTracks(boolean highlight)` Specifies that all tracks should be highlighted or unhighlighted.
`void`	`highlightFeatures(IFIDSet features, boolean highlight)` Specifies that the given features should be highlighted or unhighlighted.
`void`	`highlightTracks(String[] trackIds, boolean highlight)` Specifies that the given tracks should be highlighted or unhighlighted.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`void`	`isDirty()` isDirty
`boolean`	`isDisplayFutureEvents()` Indicates whether or not future events are drawn on the map in real-time mode.
`boolean`	`isDisplayOnlyLastKnownFeatures()` Indicates whether only the last known or all features will be drawn to the map display.
`boolean`	`isEqual(IClone other)` Indicates if the receiver and other have the same properties.
`boolean`	`isEventAdvRendererEnabled()` Indicates whether the events are also rendered by the event advanced renderer.
`boolean`	`isEventsRendererEnabled()` Indicates whether the events are rendered by the event renderer.
`boolean`	`isHasFeatureHighlights()` Specifies that features are set to be highlighted.
`boolean`	`isHasTrackHighlights()` Specifies that tracks are set to be highlighted.
`boolean`	`isHighlightFeature(int oid)` Specifies that the feature with the given OID should be highlighted or unhighlighted.
`boolean`	`isHighlightTrack(String trackId)` Specifies that the given track should be highlighted or unhighlighted.
`boolean`	`isIdentical(IClone other)` Indicates if the receiver and other are the same object.
`boolean`	`isLabelFeatures()` Indicates whether or not labeling for features is turned on.
`boolean`	`isMostCurrentAdvRendererEnabled()` Indicates whether the most current track events are also rendered by the most current advanced renderer.
`boolean`	`isMostCurrentRendererEnabled()` Indicates whether the most current track events are rendered by the most current renderer, instead of the event renderer.
`boolean`	`isNeedsMostCurrentEvents()` Indicates whether a list of the most current events is needed so they might be rendered differently than the older events.
`boolean`	`isRenderPhase(int drawPhase)` Indicates if renderer uses the specified draw phase.
`boolean`	`isShowObservationLegendGroup()` Controls whether or not the observation legend is drawn in the table of contents.
`boolean`	`isShowTimeLegendGroup()` Controls access to the time legend group.
`boolean`	`isShowTrackSymbologyLegendGroup()` Indicates whether or not track symbology displays when drawing temporal events on the map.
`boolean`	`isSmoothTracks()` Indicates if the track symbology is smooth or not.
`boolean`	`isSupportedAtVersion(int docVersion)` Is this object valid at the given document version.
`boolean`	`isSupportsCounts()` Indicates that the renderer supports counts on its legend.
`boolean`	`isSymbolsAreGraduated()` Indicates if symbols are graduated.
`boolean`	`isTrackAdvRendererEnabled()` Indicates whether the tracks are rendered by the track advanced renderer.
`boolean`	`isTrackRendererEnabled()` Indicates whether the track events are rendered by the track line renderer.
`boolean`	`isUsesFilter()` Indicates if the current object draws using a filter.
`void`	`load(IStream pstm)` load
`ISymbol`	`lookupSymbol(boolean firstPass, IFeature feature)` Returns a reference to the renderer's symbol for the input feature.
`void`	`prepareFilter(IFeatureClass fc, IQueryFilter queryFilter)` Prepares the query filter for the rendering process.
`void`	`prepareRenderer(ILayer layer)` Prepares the renderer with layer information.
`void`	`readExternal(ObjectInput in)`
`void`	`resetLookupSymbol(ISymbol symbol)` Resets temporary options on the symbol (e.g.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`setActionsByRef(IActionCollection piActions)` Indicates properties of Highlight or Suppression action to be used by highlight/suppression renderer in drawing events to the map.
`void`	`setComponentSets(IPropertySet pVal)` Used to contain the properties of all of the various temporal renderers.
`void`	`setDisplayFutureEvents(boolean pVal)` Indicates whether or not future events are drawn on the map in real-time mode.
`void`	`setDisplayOnlyLastKnownFeatures(boolean pbvarDisplayOnlyLastKnownFeatures)` Indicates whether only the last known or all features will be drawn to the map display.
`void`	`setEventAdvRendererByRef(IFeatureRenderer ppiFeatureRenderer)` Provides the event's advanced renderer.
`void`	`setEventAdvRendererEnabled(boolean pvbEnabled)` Indicates whether the events are also rendered by the event advanced renderer.
`void`	`setEventsRendererEnabled(boolean pvbIsPastEnabled)` Indicates whether the events are rendered by the event renderer.
`void`	`setExclusionSetByRef(IFeatureIDSet rhs1)` An object reference to a temporary drawing exclusion set.
`void`	`setFeatureClassByRef(IFeatureClass featureClass)` The feature class holding data information used by the renderer.
`void`	`setFromPropertyPages(boolean rhs1)` Indicates who is making the request for the legend: the property pages.
`void`	`setHighlightFeature(int oid, boolean highlight)` Specifies that the feature with the given OID should be highlighted or unhighlighted.
`void`	`setHighlightFeatureColor(IColor color)` The highlight color drawn for highlighted features.
`void`	`setHighlightTrack(String trackId, boolean highlight)` Specifies that the given track should be highlighted or unhighlighted.
`void`	`setHighlightTrackFeatureColor(IColor color)` The highlight color drawn for features in highlighted tracks.
`void`	`setHighlightTrackLineColor(IColor color)` The highlight color drawn for track-lines in highlighted tracks.
`void`	`setHistory(int pNumEvents)` Indicates the number of history events composing the track that will be used to represent the track line.
`void`	`setLabelFeatures(boolean pbvarLabelFeatures)` Indicates whether or not labeling for features is turned on.
`void`	`setLabelFieldName(String pbstrFieldName)` Name of the field whose contents will be used as the tracking label when drawing to the map display.
`void`	`setLastKnownFIDsByRef(IFeatureIDSet rhs1)` Indicates whether or not last known feature IDs will be drawn to the map display.
`void`	`setMostCurrentAdvRendererByRef(IFeatureRenderer ppiFeatureRenderer)` Provides the most current event's advanced renderer.
`void`	`setMostCurrentAdvRendererEnabled(boolean pvbEnabled)` Indicates whether the most current track events are also rendered by the most current advanced renderer.
`void`	`setMostCurrentFIDs(IFeatureIDSet piFIDSet)` Method SetMostCurrentFIDs.
`void`	`setMostCurrentRendererByRef(IFeatureRenderer ppiFeatureRenderer)` Provides the most current event renderer.
`void`	`setMostCurrentRendererEnabled(boolean pvbIsMCEnabled)` Indicates whether the most current track events are rendered by the most current renderer, instead of the event renderer.
`void`	`setObservationRendererByRef(IFeatureRenderer ppiRenderer)` Renders observation symbology using functionality of standard Esri symbology system.
`void`	`setOffsetAngle(double pdOffsetAngle)` Indicates angle of offset for labels to display from the event on the map display.
`void`	`setPixelOffset(short pnPixelOffset)` Indicates amount of offset for the label renderer to draw labels next to events in the map display.
`void`	`setPropPageEventRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the event renderer.
`void`	`setPropPageEventsAdvancedRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the advanced renderer of the events.
`void`	`setPropPageMCAdvancedRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the advanced renderer of the most current events.
`void`	`setPropPageMostCurrentRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the most current renderer.
`void`	`setPropPageTrackRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the track renderer.
`void`	`setPropPageTracksAdvancedRenderer(IUID ppiPPClassID)` Provides the Class ID of the property page associated with the advanced renderer of the tracks.
`void`	`setShowObservationLegendGroup(boolean pbShowObservations)` Controls whether or not the observation legend is drawn in the table of contents.
`void`	`setShowTimeLegendGroup(boolean pbShowTimeLegends)` Controls access to the time legend group.
`void`	`setShowTrackSymbologyLegendGroup(boolean pbShowTimeLegends)` Indicates whether or not track symbology displays when drawing temporal events on the map.
`void`	`setSmoothTracks(boolean pvbSmooth)` Indicates if the track symbology is smooth or not.
`void`	`setSymbolsAreGraduated(boolean symbolsAreGraduated)` Indicates if symbols are graduated.
`void`	`setTemporalFieldName(String pbstrTemporalFieldName)` Identifies the temporal field, which must be a field type whoe data can be converted to a date value.
`void`	`setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend)` Points to a Temporal Legend class that defines how symbology is rendered temporally.
`void`	`setTemporalObjectColumnName(String pVal)` Indicates the feature class column that identifies or groups temporal observations with time series.
`void`	`setTemporalPerspective(Object pVal)` A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.
`void`	`setTextSymbolByRef(ITextSymbol ppiTextSymbol)` Indicates settings for the text symbol appearance used to label temporal events.
`void`	`setTimeSymbologyMethod(int penumSymbolizationMethod)` Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.
`void`	`setTrackAdvRendererEnabled(boolean pvbEnabled)` Indicates whether the tracks are rendered by the track advanced renderer.
`void`	`setTrackRendererEnabled(boolean pvbIsTrackEnabled)` Indicates whether the track events are rendered by the track line renderer.
`void`	`setTrackSymbologyRendererByRef(IFeatureRenderer ppiRenderer)` Controls the temporal track symbology drawn on the map.
`void`	`startInstrumentedDraw(int type, IDisplay mapDisplay, IGeometry visibleArea)` Call before renderer.Draw so that legend info can be sampled.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

CoTrackSymbologyRenderer

public CoTrackSymbologyRenderer()
                         throws IOException,
                                UnknownHostException

Constructs a CoTrackSymbologyRenderer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

CoTrackSymbologyRenderer

public CoTrackSymbologyRenderer(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CoTrackSymbologyRenderer theCoTrackSymbologyRenderer = (CoTrackSymbologyRenderer) obj;

Construct a CoTrackSymbologyRenderer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CoTrackSymbologyRenderer.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

canRender

public boolean canRender(IFeatureClass featClass,
                         IDisplay display)
                  throws IOException,
                         AutomationException

Indicates if the specified feature class can be rendered on the given display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: canRender in interface IFeatureRenderer
Specified by:: canRender in interface ITemporalRenderer
Specified by:: canRender in interface ITrackSymbologyRenderer

Parameters:: featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in); display - A reference to a com.esri.arcgis.display.IDisplay (in)
Returns:: The result
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareFilter

public void prepareFilter(IFeatureClass fc,
                          IQueryFilter queryFilter)
                   throws IOException,
                          AutomationException

Prepares the query filter for the rendering process.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: prepareFilter in interface IFeatureRenderer
Specified by:: prepareFilter in interface ITemporalRenderer
Specified by:: prepareFilter in interface ITrackSymbologyRenderer

Parameters:: fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in); queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IFeatureCursor cursor,
                 int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws features from the specified cursor on the given display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: draw in interface IFeatureRenderer
Specified by:: draw in interface ITemporalRenderer
Specified by:: draw in interface ITrackSymbologyRenderer

Parameters:: cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in); drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSymbolByFeature

public ISymbol getSymbolByFeature(IFeature feature)
                           throws IOException,
                                  AutomationException

Symbol used to draw the specified feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getSymbolByFeature in interface IFeatureRenderer
Specified by:: getSymbolByFeature in interface ITemporalRenderer
Specified by:: getSymbolByFeature in interface ITrackSymbologyRenderer

Parameters:: feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:: A reference to a com.esri.arcgis.display.ISymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isRenderPhase in interface IFeatureRenderer
Specified by:: isRenderPhase in interface ITemporalRenderer
Specified by:: isRenderPhase in interface ITrackSymbologyRenderer

Parameters:: drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
Returns:: The result
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws IOException,
                                 AutomationException

An object reference to a temporary drawing exclusion set.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setExclusionSetByRef in interface IFeatureRenderer
Specified by:: setExclusionSetByRef in interface ITemporalRenderer
Specified by:: setExclusionSetByRef in interface ITrackSymbologyRenderer

Parameters:: rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowTrackSymbologyLegendGroup

public boolean isShowTrackSymbologyLegendGroup()
                                        throws IOException,
                                               AutomationException

Indicates whether or not track symbology displays when drawing temporal events on the map.

Description

This property controls the access to the track symbology legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isShowTrackSymbologyLegendGroup in interface ITrackSymbologyRenderer

Returns:: The pbShowTimeLegends
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowTrackSymbologyLegendGroup

public void setShowTrackSymbologyLegendGroup(boolean pbShowTimeLegends)
                                      throws IOException,
                                             AutomationException

Indicates whether or not track symbology displays when drawing temporal events on the map.

Description

This property controls the access to the track symbology legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setShowTrackSymbologyLegendGroup in interface ITrackSymbologyRenderer

Parameters:: pbShowTimeLegends - The pbShowTimeLegends (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTrackSymbologyRenderer

public IFeatureRenderer getTrackSymbologyRenderer()
                                           throws IOException,
                                                  AutomationException

Controls the temporal track symbology drawn on the map.

Description

This property identifies the feature renderer to be used for the track symbology renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTrackSymbologyRenderer in interface ITrackSymbologyRenderer

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTrackSymbologyRendererByRef

public void setTrackSymbologyRendererByRef(IFeatureRenderer ppiRenderer)
                                    throws IOException,
                                           AutomationException

Controls the temporal track symbology drawn on the map.

Description

This property identifies the feature renderer to be used for the track symbology renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTrackSymbologyRendererByRef in interface ITrackSymbologyRenderer

Parameters:: ppiRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getObservationRenderer

public IFeatureRenderer getObservationRenderer()
                                        throws IOException,
                                               AutomationException

Renders observation symbology using functionality of standard Esri symbology system.

Description

The FeatureRenderer is the standard Renderer used for rendering Observation symbology. This renderer is used as a slave in order to take advantage of the functionality of the standard ESRI symbology system.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getObservationRenderer in interface ITemporalRenderer

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setObservationRendererByRef

public void setObservationRendererByRef(IFeatureRenderer ppiRenderer)
                                 throws IOException,
                                        AutomationException

Renders observation symbology using functionality of standard Esri symbology system.

Description

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setObservationRendererByRef in interface ITemporalRenderer

Parameters:: ppiRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

public String getTemporalFieldName()
                            throws IOException,
                                   AutomationException

Identifies the temporal field, which must be a field type whoe data can be converted to a date value.

Description

The Temporal Fieldname property identifies the temporal field. This field must be a field type with data that can be converted to a date value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTemporalFieldName in interface ITemporalRenderer

Returns:: The pbstrTemporalFieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporalFieldName

public void setTemporalFieldName(String pbstrTemporalFieldName)
                          throws IOException,
                                 AutomationException

Identifies the temporal field, which must be a field type whoe data can be converted to a date value.

Description

The Temporal Fieldname property identifies the temporal field. This field must be a field type with data that can be converted to a date value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTemporalFieldName in interface ITemporalRenderer

Parameters:: pbstrTemporalFieldName - The pbstrTemporalFieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowObservationLegendGroup

public boolean isShowObservationLegendGroup()
                                     throws IOException,
                                            AutomationException

Controls whether or not the observation legend is drawn in the table of contents.

Description

This property controls whether or not the Observation legend is drawn in the table of contents view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isShowObservationLegendGroup in interface ITemporalRenderer

Returns:: The pbShowObservations
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowObservationLegendGroup

public void setShowObservationLegendGroup(boolean pbShowObservations)
                                   throws IOException,
                                          AutomationException

Controls whether or not the observation legend is drawn in the table of contents.

Description

This property controls whether or not the Observation legend is drawn in the table of contents view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setShowObservationLegendGroup in interface ITemporalRenderer

Parameters:: pbShowObservations - The pbShowObservations (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isShowTimeLegendGroup

public boolean isShowTimeLegendGroup()
                              throws IOException,
                                     AutomationException

Controls access to the time legend group.

Description

This property controls the access to the time legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isShowTimeLegendGroup in interface ITemporalRenderer

Returns:: The pbShowTimeLegends
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setShowTimeLegendGroup

public void setShowTimeLegendGroup(boolean pbShowTimeLegends)
                            throws IOException,
                                   AutomationException

Controls access to the time legend group.

Description

This property controls the access to the time legend group.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setShowTimeLegendGroup in interface ITemporalRenderer

Parameters:: pbShowTimeLegends - The pbShowTimeLegends (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTemporalLegend

public ITemporalLegendGroup getTemporalLegend()
                                       throws IOException,
                                              AutomationException

Points to a Temporal Legend class that defines how symbology is rendered temporally.

Description

This property points to a Temporal Legend class that defines how symbology is rendered temporally.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTemporalLegend in interface ITemporalRenderer

Returns:: A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporalLegendByRef

public void setTemporalLegendByRef(ITemporalLegendGroup ppiTemporalLegend)
                            throws IOException,
                                   AutomationException

Points to a Temporal Legend class that defines how symbology is rendered temporally.

Description

This property points to a Temporal Legend class that defines how symbology is rendered temporally.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTemporalLegendByRef in interface ITemporalRenderer

Parameters:: ppiTemporalLegend - A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFromPropertyPages

public void setFromPropertyPages(boolean rhs1)
                          throws IOException,
                                 AutomationException

Indicates who is making the request for the legend: the property pages.

Description

This Property will tell the get_TemporalLegend who's making the request for the legend: the PropertyPages not someone else.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setFromPropertyPages in interface ITemporalRenderer

Parameters:: rhs1 - The rhs1 (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeSymbologyMethod

public int getTimeSymbologyMethod()
                           throws IOException,
                                  AutomationException

Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Description

This property controls how temporal characteristics are to be symbolized.This property has 5 potential values:

1) None
2) Color
3) Transparency
4) Shape
5) Size

None disables any modifications to the observers feature renderer symbology. This effectively disables temporal symbology and the temporal renderer only limits the data to be displayed.

Color modifies the color of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Transparency modifies the transparency of the symbology obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Shape and Size are only applicable to point feature classes.

Shape set the marker symbol and then obtains the color and size information from the observers feature renderer. This symbol is then rendered to the screen.

Size modifies the size of the marker symbol obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTimeSymbologyMethod in interface ITemporalRenderer

Returns:: A com.esri.arcgis.trackinganalyst.enumTemporalSymbolizationMethod constant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTimeSymbologyMethod

public void setTimeSymbologyMethod(int penumSymbolizationMethod)
                            throws IOException,
                                   AutomationException

Controls how temporal characteristics are symbolized: by none, color, transparency, shape, or size.

Description

This property controls how temporal characteristics are to be symbolized.This property has 5 potential values:

1) None
2) Color
3) Transparency
4) Shape
5) Size

Shape set the marker symbol and then obtains the color and size information from the observers feature renderer. This symbol is then rendered to the screen.

Size modifies the size of the marker symbol obtained from the observers feature renderer with that of the temporal range that the feature intersects with.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTimeSymbologyMethod in interface ITemporalRenderer

Parameters:: penumSymbolizationMethod - A com.esri.arcgis.trackinganalyst.enumTemporalSymbolizationMethod constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTemporalObjectColumnName

public String getTemporalObjectColumnName()
                                   throws IOException,
                                          AutomationException

Indicates the feature class column that identifies or groups temporal observations with time series.

Description

This property identifies the feature classes column that identifies or groups temporal observations with time series. This is usually refered to as the event column name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTemporalObjectColumnName in interface ITemporalRenderer

Returns:: The pVal
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporalObjectColumnName

public void setTemporalObjectColumnName(String pVal)
                                 throws IOException,
                                        AutomationException

Indicates the feature class column that identifies or groups temporal observations with time series.

Description

This property identifies the feature classes column that identifies or groups temporal observations with time series. This is usually refered to as the event column name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTemporalObjectColumnName in interface ITemporalRenderer

Parameters:: pVal - The pVal (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTemporalPerspective

public Object getTemporalPerspective()
                              throws IOException,
                                     AutomationException

A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Description

The Temporal Perspective is the point in time that the temporal renderer uses to compare its time ranges stored in the temporal legends temporal classes. These ranges define the correct symbology to apply to the observation renderers symbology for the time difference from the features time to the temporal perspective. This value is returned as an internal format and can be set using a string, date, or internal format. This internal format can be converted using a temporalreference object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTemporalPerspective in interface ITemporalRenderer

Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTemporalPerspective

public void setTemporalPerspective(Object pVal)
                            throws IOException,
                                   AutomationException

A timestamp that the temporal renderer uses to compare its time ranges stored in the temporal legend's temporal classes.

Description

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTemporalPerspective in interface ITemporalRenderer

Parameters:: pVal - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getComponentSets

public IPropertySet getComponentSets()
                              throws IOException,
                                     AutomationException

Used to contain the properties of all of the various temporal renderers.

Description

This property is used to hold the properties that control how the various Child Renderers behave. These properties are presented in a hiearchy of parent children. The top level contains a label identifier, and the top level renderers that the implementation of this interfaces exposes. Each level or child is implemented as a property set object with the following minimum properties.

Minimum Properties:

Property	Type	Description
Label	Read
CanLabel	Read
CanDisable	Read
Enabled	Read/Write	Enables this feature or renderer.
CategoryID	Read/Write	Category ID to
Object	Read/Write	Child object or child renderer
DefaultSymbol	Read/Write
PageID	Read/Write	Class ID of the property page used to edit this function

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getComponentSets in interface ITemporalRenderer

Returns:: A reference to a com.esri.arcgis.system.IPropertySet
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setComponentSets

public void setComponentSets(IPropertySet pVal)
                      throws IOException,
                             AutomationException

Used to contain the properties of all of the various temporal renderers.

Description

Minimum Properties:

Property	Type	Description
Label	Read
CanLabel	Read
CanDisable	Read
Enabled	Read/Write	Enables this feature or renderer.
CategoryID	Read/Write	Category ID to
Object	Read/Write	Child object or child renderer
DefaultSymbol	Read/Write
PageID	Read/Write	Class ID of the property page used to edit this function

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setComponentSets in interface ITemporalRenderer

Parameters:: pVal - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canRenderComponent

public void canRenderComponent(IFeatureClass piFeatClass,
                               IDisplay piDisplay,
                               boolean[] pbvarResult,
                               Object piComponent,
                               String bstrComponent)
                        throws IOException,
                               AutomationException

Uses the renderer from component tree in symbology dialog to determine if this renderer can be used with this component.

Description

This method is an override of the ILegendInfo->CanRender. It uses the component (Renderer from component Tree in symbology dialog) to determine if this renderer can be used with this component.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: canRenderComponent in interface ITemporalRenderer

Parameters:: piFeatClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in); piDisplay - A reference to a com.esri.arcgis.display.IDisplay (in); pbvarResult - The pbvarResult (in/out: use single element array); piComponent - A reference to another Object (IUnknown) (in); bstrComponent - The bstrComponent (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMostCurrentFIDs

public void setMostCurrentFIDs(IFeatureIDSet piFIDSet)
                        throws IOException,
                               AutomationException

Method SetMostCurrentFIDs.

Description

This method sets most current feature IDs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setMostCurrentFIDs in interface ITemporalRenderer

Parameters:: piFIDSet - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDisplayFutureEvents

public boolean isDisplayFutureEvents()
                              throws IOException,
                                     AutomationException

Indicates whether or not future events are drawn on the map in real-time mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isDisplayFutureEvents in interface ITemporalRenderer

Returns:: The pVal
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayFutureEvents

public void setDisplayFutureEvents(boolean pVal)
                            throws IOException,
                                   AutomationException

Indicates whether or not future events are drawn on the map in real-time mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setDisplayFutureEvents in interface ITemporalRenderer

Parameters:: pVal - The pVal (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLegendGroupCount in interface ILegendInfo

Returns:: The count
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getLegendGroup in interface ILegendInfo

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.ILegendGroup
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLegendItem in interface ILegendInfo

Returns:: A reference to a com.esri.arcgis.carto.ILegendItem
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSymbolsAreGraduated in interface ILegendInfo

Returns:: The symbolsAreGraduated
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSymbolsAreGraduated in interface ILegendInfo

Parameters:: symbolsAreGraduated - The symbolsAreGraduated (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUsesFilter in interface IDisplayAdmin

Returns:: The usesFilter
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: applies in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The applies
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: canApply in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: The canApply
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getCurrent in interface IPropertySupport

Parameters:: pUnk - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: apply in interface IPropertySupport

Parameters:: newObject - A reference to another Object (IUnknown) (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

lookupSymbol

public ISymbol lookupSymbol(boolean firstPass,
                            IFeature feature)
                     throws IOException,
                            AutomationException

Returns a reference to the renderer's symbol for the input feature.

Remarks

This method hands out a reference to the symbol for a specific feature. The firstPass parameter is passed in as True on the first call of this method. This allows the renderer to internally cache the symbols for succesive calls.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: lookupSymbol in interface ILookupSymbol

Parameters:: firstPass - The firstPass (in); feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:: A reference to a com.esri.arcgis.display.ISymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

resetLookupSymbol

public void resetLookupSymbol(ISymbol symbol)
                       throws IOException,
                              AutomationException

Resets temporary options on the symbol (e.g. Rotation).

Remarks

This method resets modifications to marker symbol angles that may be set on the symbol reference handed to the label engine. When implementing this interface it is important to reset any marker symbol rotation changes in this method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: resetLookupSymbol in interface ILookupSymbol

Parameters:: symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setDisplayOnlyLastKnownFeatures

public void setDisplayOnlyLastKnownFeatures(boolean pbvarDisplayOnlyLastKnownFeatures)
                                     throws IOException,
                                            AutomationException

Indicates whether only the last known or all features will be drawn to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setDisplayOnlyLastKnownFeatures in interface ILastKnownRenderer
Specified by:: setDisplayOnlyLastKnownFeatures in interface ISimpleTrackingLabelRenderer

Parameters:: pbvarDisplayOnlyLastKnownFeatures - The pbvarDisplayOnlyLastKnownFeatures (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDisplayOnlyLastKnownFeatures

public boolean isDisplayOnlyLastKnownFeatures()
                                       throws IOException,
                                              AutomationException

Indicates whether only the last known or all features will be drawn to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isDisplayOnlyLastKnownFeatures in interface ILastKnownRenderer
Specified by:: isDisplayOnlyLastKnownFeatures in interface ISimpleTrackingLabelRenderer

Returns:: The pbvarDisplayOnlyLastKnownFeatures
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLastKnownFIDsByRef

public void setLastKnownFIDsByRef(IFeatureIDSet rhs1)
                           throws IOException,
                                  AutomationException

Indicates whether or not last known feature IDs will be drawn to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setLastKnownFIDsByRef in interface ILastKnownRenderer
Specified by:: setLastKnownFIDsByRef in interface ISimpleTrackingLabelRenderer

Parameters:: rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLabelFieldName

public void setLabelFieldName(String pbstrFieldName)
                       throws IOException,
                              AutomationException

Name of the field whose contents will be used as the tracking label when drawing to the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setLabelFieldName in interface ISimpleTrackingLabelRenderer

Parameters:: pbstrFieldName - The pbstrFieldName (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

public String getLabelFieldName()
                         throws IOException,
                                AutomationException

Name of the field whose contents will be used as the tracking label when drawing to the map display.

Remarks

CoTemporalFeatureLayer�s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getLabelFieldName in interface ISimpleTrackingLabelRenderer

Returns:: The pbstrFieldName
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setLabelFeatures

public void setLabelFeatures(boolean pbvarLabelFeatures)
                      throws IOException,
                             AutomationException

Indicates whether or not labeling for features is turned on.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setLabelFeatures in interface ISimpleTrackingLabelRenderer

Parameters:: pbvarLabelFeatures - The pbvarLabelFeatures (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isLabelFeatures

public boolean isLabelFeatures()
                        throws IOException,
                               AutomationException

Indicates whether or not labeling for features is turned on.

Remarks

CoTemporalFeatureLayer�s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isLabelFeatures in interface ISimpleTrackingLabelRenderer

Returns:: The pbvarLabelFeatures
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPixelOffset

public short getPixelOffset()
                     throws IOException,
                            AutomationException

Indicates amount of offset for the label renderer to draw labels next to events in the map display.

Remarks

CoTemporalFeatureLayer�s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPixelOffset in interface ISimpleTrackingLabelRenderer

Returns:: The pnPixelOffset
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPixelOffset

public void setPixelOffset(short pnPixelOffset)
                    throws IOException,
                           AutomationException

Indicates amount of offset for the label renderer to draw labels next to events in the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPixelOffset in interface ISimpleTrackingLabelRenderer

Parameters:: pnPixelOffset - The pnPixelOffset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getID

public IUID getID()
           throws IOException,
                  AutomationException

Indicates ID value of event for tracking label renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getID in interface ISimpleTrackingLabelRenderer

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

public double getOffsetAngle()
                      throws IOException,
                             AutomationException

Indicates angle of offset for labels to display from the event on the map display.

Remarks

CoTemporalFeatureLayer�s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getOffsetAngle in interface ISimpleTrackingLabelRenderer

Returns:: The pdOffsetAngle
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

public void setOffsetAngle(double pdOffsetAngle)
                    throws IOException,
                           AutomationException

Indicates angle of offset for labels to display from the event on the map display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setOffsetAngle in interface ISimpleTrackingLabelRenderer

Parameters:: pdOffsetAngle - The pdOffsetAngle (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Indicates settings for the text symbol appearance used to label temporal events.

Remarks

CoTemporalFeatureLayer�s ITrackingLayerLabels controls/sets the property under this interface in Tracking Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getTextSymbol in interface ISimpleTrackingLabelRenderer

Returns:: A reference to a com.esri.arcgis.display.ITextSymbol
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol ppiTextSymbol)
                        throws IOException,
                               AutomationException

Indicates settings for the text symbol appearance used to label temporal events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTextSymbolByRef in interface ISimpleTrackingLabelRenderer

Parameters:: ppiTextSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getActions

public IActionCollection getActions()
                             throws IOException,
                                    AutomationException

Indicates properties of Highlight or Suppression action to be used by highlight/suppression renderer in drawing events to the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getActions in interface IHighlightSuppressionRenderer

Returns:: A reference to a com.esri.arcgis.carto.IActionCollection
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setActionsByRef

public void setActionsByRef(IActionCollection piActions)
                     throws IOException,
                            AutomationException

Indicates properties of Highlight or Suppression action to be used by highlight/suppression renderer in drawing events to the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setActionsByRef in interface IHighlightSuppressionRenderer

Parameters:: piActions - A reference to a com.esri.arcgis.carto.IActionCollection (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: esri_clone in interface IClone

Returns:: A reference to a com.esri.arcgis.system.IClone
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: assign in interface IClone

Parameters:: src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEqual in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The equal
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isIdentical in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The identical
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSmoothTracks

public boolean isSmoothTracks()
                       throws IOException,
                              AutomationException

Indicates if the track symbology is smooth or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isSmoothTracks in interface ITemporalRenderer2
Specified by:: isSmoothTracks in interface ITrackRenderer

Returns:: The pvbSmooth
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: ITrackRenderer

setSmoothTracks

public void setSmoothTracks(boolean pvbSmooth)
                     throws IOException,
                            AutomationException

Indicates if the track symbology is smooth or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setSmoothTracks in interface ITemporalRenderer2
Specified by:: setSmoothTracks in interface ITrackRenderer

Parameters:: pvbSmooth - The pvbSmooth (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isNeedsMostCurrentEvents

public boolean isNeedsMostCurrentEvents()
                                 throws IOException,
                                        AutomationException

Indicates whether a list of the most current events is needed so they might be rendered differently than the older events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isNeedsMostCurrentEvents in interface ITemporalRenderer2
Specified by:: isNeedsMostCurrentEvents in interface ITrackRenderer

Returns:: The pvbNeedsMostCurrent
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMostCurrentRendererEnabled

public boolean isMostCurrentRendererEnabled()
                                     throws IOException,
                                            AutomationException

Indicates whether the most current track events are rendered by the most current renderer, instead of the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isMostCurrentRendererEnabled in interface ITemporalRenderer2

Returns:: The pvbIsMCEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMostCurrentRendererEnabled

public void setMostCurrentRendererEnabled(boolean pvbIsMCEnabled)
                                   throws IOException,
                                          AutomationException

Indicates whether the most current track events are rendered by the most current renderer, instead of the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setMostCurrentRendererEnabled in interface ITemporalRenderer2

Parameters:: pvbIsMCEnabled - The pvbIsMCEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTrackRendererEnabled

public boolean isTrackRendererEnabled()
                               throws IOException,
                                      AutomationException

Indicates whether the track events are rendered by the track line renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isTrackRendererEnabled in interface ITemporalRenderer2
Specified by:: isTrackRendererEnabled in interface ITrackRenderer

Returns:: The pvbIsTrackEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setTrackRendererEnabled

public void setTrackRendererEnabled(boolean pvbIsTrackEnabled)
                             throws IOException,
                                    AutomationException

Indicates whether the track events are rendered by the track line renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTrackRendererEnabled in interface ITemporalRenderer2
Specified by:: setTrackRendererEnabled in interface ITrackRenderer

Parameters:: pvbIsTrackEnabled - The pvbIsTrackEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isEventsRendererEnabled

public boolean isEventsRendererEnabled()
                                throws IOException,
                                       AutomationException

Indicates whether the events are rendered by the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isEventsRendererEnabled in interface ITemporalRenderer2

Returns:: The pvbIsPastEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEventsRendererEnabled

public void setEventsRendererEnabled(boolean pvbIsPastEnabled)
                              throws IOException,
                                     AutomationException

Indicates whether the events are rendered by the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setEventsRendererEnabled in interface ITemporalRenderer2

Parameters:: pvbIsPastEnabled - The pvbIsPastEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageMostCurrentRenderer

public IUID getPropPageMostCurrentRenderer()
                                    throws IOException,
                                           AutomationException

Provides the Class ID of the property page associated with the most current renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageMostCurrentRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageMostCurrentRenderer

public void setPropPageMostCurrentRenderer(IUID ppiPPClassID)
                                    throws IOException,
                                           AutomationException

Provides the Class ID of the property page associated with the most current renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageMostCurrentRenderer in interface ITemporalRenderer2

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageTrackRenderer

public IUID getPropPageTrackRenderer()
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the track renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageTrackRenderer in interface ITemporalRenderer2
Specified by:: getPropPageTrackRenderer in interface ITrackRenderer

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageTrackRenderer

public void setPropPageTrackRenderer(IUID ppiPPClassID)
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the track renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageTrackRenderer in interface ITemporalRenderer2
Specified by:: setPropPageTrackRenderer in interface ITrackRenderer

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageEventRenderer

public IUID getPropPageEventRenderer()
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageEventRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageEventRenderer

public void setPropPageEventRenderer(IUID ppiPPClassID)
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageEventRenderer in interface ITemporalRenderer2

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageEventsAdvancedRenderer

public IUID getPropPageEventsAdvancedRenderer()
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageEventsAdvancedRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageEventsAdvancedRenderer

public void setPropPageEventsAdvancedRenderer(IUID ppiPPClassID)
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageEventsAdvancedRenderer in interface ITemporalRenderer2

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageTracksAdvancedRenderer

public IUID getPropPageTracksAdvancedRenderer()
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageTracksAdvancedRenderer in interface ITemporalRenderer2
Specified by:: getPropPageTracksAdvancedRenderer in interface ITrackRenderer

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageTracksAdvancedRenderer

public void setPropPageTracksAdvancedRenderer(IUID ppiPPClassID)
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageTracksAdvancedRenderer in interface ITemporalRenderer2
Specified by:: setPropPageTracksAdvancedRenderer in interface ITrackRenderer

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getPropPageMCAdvancedRenderer

public IUID getPropPageMCAdvancedRenderer()
                                   throws IOException,
                                          AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the most current events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getPropPageMCAdvancedRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setPropPageMCAdvancedRenderer

public void setPropPageMCAdvancedRenderer(IUID ppiPPClassID)
                                   throws IOException,
                                          AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the most current events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setPropPageMCAdvancedRenderer in interface ITemporalRenderer2

Parameters:: ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMostCurrentRendererByRef

public void setMostCurrentRendererByRef(IFeatureRenderer ppiFeatureRenderer)
                                 throws IOException,
                                        AutomationException

Provides the most current event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setMostCurrentRendererByRef in interface ITemporalRenderer2

Parameters:: ppiFeatureRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMostCurrentRenderer

public IFeatureRenderer getMostCurrentRenderer()
                                        throws IOException,
                                               AutomationException

Provides the most current event renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getMostCurrentRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMostCurrentAdvRendererByRef

public void setMostCurrentAdvRendererByRef(IFeatureRenderer ppiFeatureRenderer)
                                    throws IOException,
                                           AutomationException

Provides the most current event's advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setMostCurrentAdvRendererByRef in interface ITemporalRenderer2

Parameters:: ppiFeatureRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMostCurrentAdvRenderer

public IFeatureRenderer getMostCurrentAdvRenderer()
                                           throws IOException,
                                                  AutomationException

Provides the most current event's advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getMostCurrentAdvRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEventAdvRendererByRef

public void setEventAdvRendererByRef(IFeatureRenderer ppiFeatureRenderer)
                              throws IOException,
                                     AutomationException

Provides the event's advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setEventAdvRendererByRef in interface ITemporalRenderer2

Parameters:: ppiFeatureRenderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getEventAdvRenderer

public IFeatureRenderer getEventAdvRenderer()
                                     throws IOException,
                                            AutomationException

Provides the event's advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getEventAdvRenderer in interface ITemporalRenderer2

Returns:: A reference to a com.esri.arcgis.carto.IFeatureRenderer
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isEventAdvRendererEnabled

public boolean isEventAdvRendererEnabled()
                                  throws IOException,
                                         AutomationException

Indicates whether the events are also rendered by the event advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isEventAdvRendererEnabled in interface ITemporalRenderer2

Returns:: The pvbEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEventAdvRendererEnabled

public void setEventAdvRendererEnabled(boolean pvbEnabled)
                                throws IOException,
                                       AutomationException

Indicates whether the events are also rendered by the event advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setEventAdvRendererEnabled in interface ITemporalRenderer2

Parameters:: pvbEnabled - The pvbEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMostCurrentAdvRendererEnabled

public boolean isMostCurrentAdvRendererEnabled()
                                        throws IOException,
                                               AutomationException

Indicates whether the most current track events are also rendered by the most current advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isMostCurrentAdvRendererEnabled in interface ITemporalRenderer2

Returns:: The pvbEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMostCurrentAdvRendererEnabled

public void setMostCurrentAdvRendererEnabled(boolean pvbEnabled)
                                      throws IOException,
                                             AutomationException

Indicates whether the most current track events are also rendered by the most current advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setMostCurrentAdvRendererEnabled in interface ITemporalRenderer2

Parameters:: pvbEnabled - The pvbEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isTrackAdvRendererEnabled

public boolean isTrackAdvRendererEnabled()
                                  throws IOException,
                                         AutomationException

Indicates whether the tracks are rendered by the track advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isTrackAdvRendererEnabled in interface ITemporalRenderer2
Specified by:: isTrackAdvRendererEnabled in interface ITrackRenderer

Returns:: The pvbEnabled
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: ITrackRenderer

setTrackAdvRendererEnabled

public void setTrackAdvRendererEnabled(boolean pvbEnabled)
                                throws IOException,
                                       AutomationException

Indicates whether the tracks are rendered by the track advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setTrackAdvRendererEnabled in interface ITemporalRenderer2
Specified by:: setTrackAdvRendererEnabled in interface ITrackRenderer

Parameters:: pvbEnabled - The pvbEnabled (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHistory

public int getHistory()
               throws IOException,
                      AutomationException

Indicates the number of history events composing the track that will be used to represent the track line.

Description

The History property trims the length of the track line displayed when tracks are enabled in the renderer.

Remarks

Setting the History to zero will draw the entire track.

Setting the history for a track does not effect the rendering of its events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getHistory in interface ITrackRenderer

Returns:: The pNumEvents
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHistory

public void setHistory(int pNumEvents)
                throws IOException,
                       AutomationException

Indicates the number of history events composing the track that will be used to represent the track line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHistory in interface ITrackRenderer

Parameters:: pNumEvents - The pNumEvents (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

prepareRenderer

public void prepareRenderer(ILayer layer)
                     throws IOException,
                            AutomationException

Prepares the renderer with layer information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: prepareRenderer in interface ITxRendererSetup

Parameters:: layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException

The feature class holding data information used by the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getFeatureClass in interface ITxRendererSetup

Returns:: A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass featureClass)
                          throws IOException,
                                 AutomationException

The feature class holding data information used by the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setFeatureClassByRef in interface ITxRendererSetup

Parameters:: featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:: docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:: The supported
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:: docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHighlightTrack

public boolean isHighlightTrack(String trackId)
                         throws IOException,
                                AutomationException

Specifies that the given track should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isHighlightTrack in interface ITxHighlightTracks

Parameters:: trackId - The trackId (in)
Returns:: The highlight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighlightTrack

public void setHighlightTrack(String trackId,
                              boolean highlight)
                       throws IOException,
                              AutomationException

Specifies that the given track should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHighlightTrack in interface ITxHighlightTracks

Parameters:: trackId - The trackId (in); highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

highlightTracks

public void highlightTracks(String[] trackIds,
                            boolean highlight)
                     throws IOException,
                            AutomationException

Specifies that the given tracks should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: highlightTracks in interface ITxHighlightTracks

Parameters:: trackIds - The trackIds (in); highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

highlightAllTracks

public void highlightAllTracks(boolean highlight)
                        throws IOException,
                               AutomationException

Specifies that all tracks should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: highlightAllTracks in interface ITxHighlightTracks

Parameters:: highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasTrackHighlights

public boolean isHasTrackHighlights()
                             throws IOException,
                                    AutomationException

Specifies that tracks are set to be highlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isHasTrackHighlights in interface ITxHighlightTracks

Returns:: The hasHighlights
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHighlightFeature

public boolean isHighlightFeature(int oid)
                           throws IOException,
                                  AutomationException

Specifies that the feature with the given OID should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isHighlightFeature in interface ITxHighlightFeatures

Parameters:: oid - The oid (in)
Returns:: The highlight
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighlightFeature

public void setHighlightFeature(int oid,
                                boolean highlight)
                         throws IOException,
                                AutomationException

Specifies that the feature with the given OID should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHighlightFeature in interface ITxHighlightFeatures

Parameters:: oid - The oid (in); highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

highlightFeatures

public void highlightFeatures(IFIDSet features,
                              boolean highlight)
                       throws IOException,
                              AutomationException

Specifies that the given features should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: highlightFeatures in interface ITxHighlightFeatures

Parameters:: features - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in); highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

highlightAllFeatures

public void highlightAllFeatures(boolean highlight)
                          throws IOException,
                                 AutomationException

Specifies that all features should be highlighted or unhighlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: highlightAllFeatures in interface ITxHighlightFeatures

Parameters:: highlight - The highlight (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHasFeatureHighlights

public boolean isHasFeatureHighlights()
                               throws IOException,
                                      AutomationException

Specifies that features are set to be highlighted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: isHasFeatureHighlights in interface ITxHighlightFeatures

Returns:: The hasHighlights
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighlightTrackFeatureColor

public void setHighlightTrackFeatureColor(IColor color)
                                   throws IOException,
                                          AutomationException

The highlight color drawn for features in highlighted tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHighlightTrackFeatureColor in interface ITxHighlightSettings

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighlightTrackFeatureColor

public IColor getHighlightTrackFeatureColor()
                                     throws IOException,
                                            AutomationException

The highlight color drawn for features in highlighted tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getHighlightTrackFeatureColor in interface ITxHighlightSettings

Returns:: A reference to a com.esri.arcgis.display.IColor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighlightTrackLineColor

public void setHighlightTrackLineColor(IColor color)
                                throws IOException,
                                       AutomationException

The highlight color drawn for track-lines in highlighted tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHighlightTrackLineColor in interface ITxHighlightSettings

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighlightTrackLineColor

public IColor getHighlightTrackLineColor()
                                  throws IOException,
                                         AutomationException

The highlight color drawn for track-lines in highlighted tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getHighlightTrackLineColor in interface ITxHighlightSettings

Returns:: A reference to a com.esri.arcgis.display.IColor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setHighlightFeatureColor

public void setHighlightFeatureColor(IColor color)
                              throws IOException,
                                     AutomationException

The highlight color drawn for highlighted features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: setHighlightFeatureColor in interface ITxHighlightSettings

Parameters:: color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getHighlightFeatureColor

public IColor getHighlightFeatureColor()
                                throws IOException,
                                       AutomationException

The highlight color drawn for highlighted features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: getHighlightFeatureColor in interface ITxHighlightSettings

Returns:: A reference to a com.esri.arcgis.display.IColor
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hideTrack

public void hideTrack(String trackId,
                      boolean hide)
               throws IOException,
                      AutomationException

Specifies whether the given track should be hidden.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: hideTrack in interface ITxHideFeatures

Parameters:: trackId - The trackId (in); hide - The hide (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hideAllTracks

public void hideAllTracks(boolean hide)
                   throws IOException,
                          AutomationException

Specifies whether all tracks should be hidden.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:: hideAllTracks in interface ITxHideFeatures

Parameters:: hide - The hide (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsCounts

public boolean isSupportsCounts()
                         throws IOException,
                                AutomationException

Indicates that the renderer supports counts on its legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: isSupportsCounts in interface IDynamicLegendRenderer

Returns:: The flag
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getInstrumentedDrawPhases

public int getInstrumentedDrawPhases()
                              throws IOException,
                                     AutomationException

Draw phases that affect dynamic legends.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: getInstrumentedDrawPhases in interface IDynamicLegendRenderer

Returns:: The drawPhases
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

startInstrumentedDraw

public void startInstrumentedDraw(int type,
                                  IDisplay mapDisplay,
                                  IGeometry visibleArea)
                           throws IOException,
                                  AutomationException

Call before renderer.Draw so that legend info can be sampled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: startInstrumentedDraw in interface IDynamicLegendRenderer

Parameters:: type - A com.esri.arcgis.carto.esriDynamicLegendType constant (in); mapDisplay - A reference to a com.esri.arcgis.display.IDisplay (in); visibleArea - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

finishInstrumentedDraw

public void finishInstrumentedDraw()
                            throws IOException,
                                   AutomationException

Call after renderer.Draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:: finishInstrumentedDraw in interface IDynamicLegendRenderer

Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.trackinganalyst Class CoTrackSymbologyRenderer

Description

Product Availability

CoTrackSymbologyRenderer

CoTrackSymbologyRenderer

getClsid

equals

hashCode

canRender

Product Availability

prepareFilter

Product Availability

draw

Product Availability

getSymbolByFeature

Product Availability

isRenderPhase

Product Availability

setExclusionSetByRef

Product Availability

isShowTrackSymbologyLegendGroup

Description

Product Availability

setShowTrackSymbologyLegendGroup

Description

Product Availability

getTrackSymbologyRenderer

Description

Product Availability

setTrackSymbologyRendererByRef

Description

Product Availability

getObservationRenderer

Description

Product Availability

setObservationRendererByRef

Description

Product Availability

getTemporalFieldName

Description

Product Availability

setTemporalFieldName

Description

Product Availability

isShowObservationLegendGroup

Description

Product Availability

setShowObservationLegendGroup

Description

Product Availability

isShowTimeLegendGroup

Description

Product Availability

setShowTimeLegendGroup

Description

Product Availability

getTemporalLegend

Description

Product Availability

setTemporalLegendByRef

Description

Product Availability

setFromPropertyPages

Description

Product Availability

getTimeSymbologyMethod

Description

Product Availability

setTimeSymbologyMethod

Description

Product Availability

getTemporalObjectColumnName

Description

Product Availability

setTemporalObjectColumnName

Description

Product Availability

getTemporalPerspective

Description

Product Availability

com.esri.arcgis.trackinganalyst
Class CoTrackSymbologyRenderer