|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITemporalLayer
Provides access to properties and methods needed to manage temporal layer functionality.
The temporal layer interface controls property content that enables a layer to be rendered or exploited temporally. This interface provides properties and methods to control how the events are displayed (e.g. displaying future events, last known events), whether and how to cache features, and temporal and spatial attributes. This interface also provides property and methods to access action collection and process actions.
Method Summary | |
---|---|
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
IActionCollection |
getActionCollection()
The collection of action objects for this temporal layer. |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
String |
getEventIDFieldName()
Indicates the field containing the EventID information for the data. |
int |
getFeatureCacheWindow()
Determines the number of features to cache if the CacheFeatures property is true. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
int |
getRelativeTimeColor()
Indicates a relative color differential based on temporal class characteristics. |
ITemporalOperator |
getRelativeTimeOperator()
The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer. |
IFeatureRenderer |
getRenderer()
Controls the temporal renderer for the layer. |
int |
getSupportedDrawPhases()
Supported draw phases. |
String |
getTemporalFieldName()
Identifies the temporal field, which must be a field type with data that can be converted to a date value. |
ITemporalLegendGroup |
getTemporalLegendGroup()
Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer. |
ITemporalReference |
getTemporalReference()
Defines the reference in time used to draw, identify, or perform other layer-based activities. |
String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isCacheFeatures()
Controls whether Features are cached in the renderer's feature memory or are read from the feature class. |
boolean |
isDisplayFutureEvents()
Indicates whether or not to display future events for a real-time data layer. |
boolean |
isDisplayOnlyLastKnownEvent()
Indicates whether to display only the last known temporal event or all events in a layer. |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
void |
processActions(boolean bvarResetActions)
Apply the actions, contained in the action collection, to this temporal layer. |
void |
queryTemporalExtent(Object[] pvarStartTime,
Object[] pvarEndTime)
Obtain the start and end temporal values of the temporal layer's features. |
void |
setActionCollectionByRef(IActionCollection pVal)
The collection of action objects for this temporal layer. |
void |
setCached(boolean cached)
Indicates if the layer needs its own display cache. |
void |
setCacheFeatures(boolean pbAreFeaturesCached)
Controls whether Features are cached in the renderer's feature memory or are read from the feature class. |
void |
setDisplayFutureEvents(boolean pbvarFutureEvents)
Indicates whether or not to display future events for a real-time data layer. |
void |
setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent)
Indicates whether to display only the last known temporal event or all events in a layer. |
void |
setFeatureCacheWindow(int pnPercent)
Determines the number of features to cache if the CacheFeatures property is true. |
void |
setMaximumScale(double maxScale)
Maximum scale (representative fraction) at which the layer will display. |
void |
setMinimumScale(double minScale)
Minimum scale (representative fraction) at which the layer will display. |
void |
setName(String name)
Layer name. |
void |
setRelativeTimeColor(int pVal)
Indicates a relative color differential based on temporal class characteristics. |
void |
setRelativeTimeOperator(ITemporalOperator pVal)
The relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer. |
void |
setRendererByRef(IFeatureRenderer renderer)
Controls the temporal renderer for the layer. |
void |
setShowTips(boolean show)
Indicates if the layer shows map tips. |
void |
setSpatialReferenceByRef(ISpatialReference rhs1)
Spatial reference for the layer. |
void |
setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup)
Group of temporal legend classes that define the temporal intervals and symbology used by the temporal renderer. |
void |
setTemporalReferenceByRef(ITemporalReference ppiTemporalReference)
Defines the reference in time used to draw, identify, or perform other layer-based activities. |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
void |
suspendIndexing(boolean bvarSuspend)
This method suspends or resumes indexing on a temporal layer. |
Method Detail |
---|
String getName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setName(String name) throws IOException, AutomationException
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isValid() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope getAreaOfInterest() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getMinimumScale() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setMinimumScale(double minScale) throws IOException, AutomationException
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getMaximumScale() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setMaximumScale(double maxScale) throws IOException, AutomationException
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isVisible() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setVisible(boolean visible) throws IOException, AutomationException
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isShowTips() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setShowTips(boolean show) throws IOException, AutomationException
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getTipText(double x, double y, double tolerance) throws IOException, AutomationException
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isCached() throws IOException, AutomationException
Temporal layers are always cached. Therefore this property is not re-configurable.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCached(boolean cached) throws IOException, AutomationException
cached
- The cached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getSupportedDrawPhases() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setSpatialReferenceByRef(ISpatialReference rhs1) throws IOException, AutomationException
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITemporalReference getTemporalReference() throws IOException, AutomationException
The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTemporalReferenceByRef(ITemporalReference ppiTemporalReference) throws IOException, AutomationException
The Temporal Reference Property is a Temporal Reference Object that defines the reference in time that is used to draw, identify, or perform other layer activities on this layer.
ppiTemporalReference
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITemporalLegendGroup getTemporalLegendGroup() throws IOException, AutomationException
This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTemporalLegendGroupByRef(ITemporalLegendGroup ppiTemporalLegendGroup) throws IOException, AutomationException
This property is a group of temporal legend classes that define the temporal intervals and symbology that the temporal renderer uses. This legend group collectively defines the temporal period that is used to draw features.
ppiTemporalLegendGroup
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendGroup (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCacheFeatures(boolean pbAreFeaturesCached) throws IOException, AutomationException
This property controls whether features are cached in the renderer's feature memory or are read from the feature class.
pbAreFeaturesCached
- The pbAreFeaturesCached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isCacheFeatures() throws IOException, AutomationException
This property controls whether features are cached in the renderer's feature memory or are read from the feature class.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getFeatureCacheWindow() throws IOException, AutomationException
Reserved for future use.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setFeatureCacheWindow(int pnPercent) throws IOException, AutomationException
Reserved for future use
pnPercent
- The pnPercent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setRendererByRef(IFeatureRenderer renderer) throws IOException, AutomationException
renderer
- A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeatureRenderer getRenderer() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getTemporalFieldName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isDisplayOnlyLastKnownEvent() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayOnlyLastKnownEvent(boolean pbvarLastKnownEvent) throws IOException, AutomationException
pbvarLastKnownEvent
- The pbvarLastKnownEvent (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isDisplayFutureEvents() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayFutureEvents(boolean pbvarFutureEvents) throws IOException, AutomationException
pbvarFutureEvents
- The pbvarFutureEvents (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IActionCollection getActionCollection() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setActionCollectionByRef(IActionCollection pVal) throws IOException, AutomationException
pVal
- A reference to a com.esri.arcgis.trackinganalyst.IActionCollection (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void processActions(boolean bvarResetActions) throws IOException, AutomationException
If bvarResetActions is true, actions collection will be reset to the default state.
bvarResetActions
- The bvarResetActions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getRelativeTimeColor() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setRelativeTimeColor(int pVal) throws IOException, AutomationException
pVal
- The pVal (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITemporalOperator getRelativeTimeOperator() throws IOException, AutomationException
This property indicates the relative time operator, containing the temporal offset to adjust the temporal values of this temporal layer. The temporal offset can be an interval.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setRelativeTimeOperator(ITemporalOperator pVal) throws IOException, AutomationException
pVal
- A reference to a com.esri.arcgis.trackinganalyst.ITemporalOperator (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime) throws IOException, AutomationException
pvarStartTime
- A Variant (in/out: use single element array)pvarEndTime
- A Variant (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getEventIDFieldName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void suspendIndexing(boolean bvarSuspend) throws IOException, AutomationException
bvarSuspend
- The bvarSuspend (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |