|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITemporalLegendGroup
Provides access to properties and methods needed to manage the temporal legend group of classes.
The Temporal Legend contains rules on how to render symbology with temporal characteristics.
Method Summary | |
---|---|
void |
addClass(ILegendClass legendClass)
Adds a new legend class to the group at the end of list. |
void |
clearClasses()
Removes all classes from the group. |
ILegendClass |
esri_getClass(int index)
Legend class at the specified index. |
int |
getClassCount()
Number of legend classes in the group. |
String |
getColorRampName()
Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors. |
String |
getDescription()
Text description of the temporal legend group. |
String |
getHeading()
String heading. |
ITemporalLegendClass |
getTemporalLegendClass(int nRangeNdx)
Temporal Legend Class at specified index from this group. |
void |
insertClass(int index,
ILegendClass legendClass)
Inserts a new legend class into the group at the specified index. |
int |
intersects(Object pvTimeValue,
ISymbol[] ppiSymbol,
IColor[] ppiSymbolColor,
double[] pdSymbolSize)
Determines whether a given timestamp value is contained within one of the group's temporal classes. |
boolean |
isEditable()
Indicates if the group can be edited. |
boolean |
isSuppress()
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query. |
boolean |
isVisible()
Indicates if the group is displayed. |
void |
moveClass(int nCurrentIndex,
int nDestinationIndex)
Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container. |
void |
removeClass(int index)
Removes the legend class from the group at the specified index. |
void |
setColorRampName(String pbstrColorRampName)
Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors. |
void |
setDescription(String pbstrDescription)
Text description of the temporal legend group. |
void |
setEditable(boolean editable)
Indicates if the group can be edited. |
void |
setHeading(String heading)
String heading. |
void |
setReference(Object varReference)
Sets temporal reference information for the temporal legend group. |
void |
setSuppress(boolean pbSuppress)
Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query. |
void |
setVisible(boolean visible)
Indicates if the group is displayed. |
void |
update()
Updates the temporal legend with new values. |
void |
verify(boolean[] bNoProblems)
Checks ranges within a group to determine if group is ordered properly and has correct offsets. |
Method Detail |
---|
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 isEditable() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEditable(boolean editable) throws IOException, AutomationException
editable
- The editable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getHeading() throws IOException, AutomationException
The property indicates the string heading for the legend group.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHeading(String heading) throws IOException, AutomationException
heading
- The heading (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getClassCount() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILegendClass esri_getClass(int index) throws IOException, AutomationException
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addClass(ILegendClass legendClass) throws IOException, AutomationException
legendClass
- A reference to a com.esri.arcgis.carto.ILegendClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void insertClass(int index, ILegendClass legendClass) throws IOException, AutomationException
index
- The index (in)legendClass
- A reference to a com.esri.arcgis.carto.ILegendClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeClass(int index) throws IOException, AutomationException
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void clearClasses() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getColorRampName() throws IOException, AutomationException
The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setColorRampName(String pbstrColorRampName) throws IOException, AutomationException
The Color Ramp Name property is the name of an ESRI pre-defined color ramp that was last used by the TemporalRenderer property page that updated this object. This value is used to create default temporal legend class symbology colors. This property is the name of an ESRI color ramp obtained from ESRI's pre-defined color ramps. The Temporal Renderer's property page uses this property to obtain the color ramp in order to build default temporal legend classes and symbology for the legend classes' symbols.
pbstrColorRampName
- The pbstrColorRampName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getDescription() throws IOException, AutomationException
The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDescription(String pbstrDescription) throws IOException, AutomationException
The Description property contains a description of this Temporal Group. This is the same property as Heading from ILegendGroup.
pbstrDescription
- The pbstrDescription (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ITemporalLegendClass getTemporalLegendClass(int nRangeNdx) throws IOException, AutomationException
nRangeNdx
- The nRangeNdx (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isSuppress() throws IOException, AutomationException
The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setSuppress(boolean pbSuppress) throws IOException, AutomationException
The Suppress property controls whether or not to use the temporal legend classes during intersect or computation of the time period needed for a temporal query.
pbSuppress
- The pbSuppress (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setReference(Object varReference) throws IOException, AutomationException
varReference
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int intersects(Object pvTimeValue, ISymbol[] ppiSymbol, IColor[] ppiSymbolColor, double[] pdSymbolSize) throws IOException, AutomationException
This method determines if a given absolute time, timestamp, is contained within one of this class's temporal legend classes. If so it returns the index of
the legend class that should be used, and it returns the associated symbol for that temporal legend class.
pvTimeValue
- A Variant (in)ppiSymbol
- A reference to a com.esri.arcgis.display.ISymbol (in/out: use single element array)ppiSymbolColor
- A reference to a com.esri.arcgis.display.IColor (in/out: use single element array)pdSymbolSize
- The pdSymbolSize (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void update() throws IOException, AutomationException
The Update method updates the legend. Each temporal range in this legend calls this method to have the temporal legend update the ranges in order to maintain a sorted range list from future to past/normal and compute the correct offsets.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void moveClass(int nCurrentIndex, int nDestinationIndex) throws IOException, AutomationException
The move Class method moves a Temporal Legend Class from the current position to the destination position within the Temporal Legend Groups Legend Class container.
nCurrentIndex
- The nCurrentIndex (in)nDestinationIndex
- The nDestinationIndex (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void verify(boolean[] bNoProblems) throws IOException, AutomationException
The verify method checks the ranges within a group to determine if the group is ordered properly and has correct offsets. It does not fix any detected problems; it only returns a boolean result.
bNoProblems
- The bNoProblems (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 |