com.esri.arcgis.display
Interface IDynamicCompoundMarker

All Superinterfaces:

Serializable

All Known Subinterfaces:

IDynamicCompoundMarker2

All Known Implementing Classes:

DynamicDisplay, IDynamicCompoundMarker2Proxy, IDynamicCompoundMarkerProxy

public interface IDynamicCompoundMarker
extends Serializable

Provides access to dynamic compound marker.

Superseded By

IDynamicCompoundMarker2

Description

IDynamicCompoundMarker is a helper interface that optimizes the rendering of a marker along with some text labels around it.

Remarks

The drawing methods can only be used in one of the callback draw methods with the following specific context:

1. In the IDynamicLayer.DrawDynamicLayer method.
   It is recommended to use the DynamicGlyphFactory in the esriDynamicDrawPhase.esriDDPImmediate dynamic-draw-phase.
2. IDynamicMapEvents.AfterDynamicDraw method (event handler).
   Only with the dynamic-map-draw-phase esriDynamicMapDrawPhase.esriDMDPDynamicLayers.
3. IDynamicMapEvents.BeforeDynamicDraw method (event handler).
   Only with the dynamic-map-draw-phase esriDynamicMapDrawPhase.esriDMDPDynamicLayers.

Any usage of the DynamicDisplay drawing API (or OpenGL API) in any other context will result in an unknown behavior.

The DrawCompondMarkerN methods are drawing a Marker with a combination of 1, 2, 4, 8, or 10 text strings around it.

These methods are using a location in Map Coordinates.

The following diagram shows the layout of the DrawCompoundMarker10 method:

Product Availability

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

Method Summary

void	drawCompoundMarker1(IPoint point, String textTop) Draws specified point on the dynamic display with one string above it.
void	drawCompoundMarker10(IPoint point, String textTop, String textBottom, String textLeft1, String textLeft2, String textLeft3, String textLeft4, String textRight1, String textRight2, String textRight3, String textRight4) Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and four strings on each side of the marker (left and right).
void	drawCompoundMarker2(IPoint point, String textTop, String textBottom) Draws specified point on the dynamic display with a string above and below.
void	drawCompoundMarker4(IPoint point, String textTop, String textBottom, String textLeft, String textRight) Draws specified point on the dynamic display with a text string on each side of the marker (top, bottom, left and right).
void	drawCompoundMarker6(IPoint point, String textTop, String textBottom, String textLeft1, String textLeft2, String textRight1, String textRight2) Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and two strings on each side of the marker (left and right).
void	drawCompoundMarker8(IPoint point, String textTop, String textBottom, String textLeft1, String textLeft2, String textLeft3, String textRight1, String textRight2, String textRight3) Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and three strings on each side of the marker (left and right).
void	getMarkerToTextOffset(float[] xOffset, float[] yOffset) The offset of the text from the marker in pixels.
void	setMarkerToTextOffset(float xOffset, float yOffset) The offset of the text from the marker in pixels.

Method Detail

getMarkerToTextOffset

void getMarkerToTextOffset(float[] xOffset,
                           float[] yOffset)
                           throws IOException,
                                  AutomationException

The offset of the text from the marker in pixels.

Remarks

Offset is the distance between the marker and the text labels.
X refers to the left and right offsets. Y refers to the top and bottom offsets.

Product Availability

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

Parameters:

xOffset - The xOffset (in/out: use single element array)

yOffset - The yOffset (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerToTextOffset

void setMarkerToTextOffset(float xOffset,
                           float yOffset)
                           throws IOException,
                                  AutomationException

The offset of the text from the marker in pixels.

Remarks

Offset is the distance between the marker and the text labels.
X refers to the left and right offsets. Y refers to the top and bottom offsets.

Product Availability

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

Parameters:

xOffset - The xOffset (in)

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker1

void drawCompoundMarker1(IPoint point,
                         String textTop)
                         throws IOException,
                                AutomationException

Draws specified point on the dynamic display with one string above it.

Remarks

Draws a marker with a text label on top

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker2

void drawCompoundMarker2(IPoint point,
                         String textTop,
                         String textBottom)
                         throws IOException,
                                AutomationException

Draws specified point on the dynamic display with a string above and below.

Remarks

Draws a marker with 2 text labels: 1-top and 1-bottom

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

textBottom - The textBottom (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker4

void drawCompoundMarker4(IPoint point,
                         String textTop,
                         String textBottom,
                         String textLeft,
                         String textRight)
                         throws IOException,
                                AutomationException

Draws specified point on the dynamic display with a text string on each side of the marker (top, bottom, left and right).

Remarks

Draws a marker with 4 text labels: 1-top, 1-bottom, 1-left, 1-right

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

textBottom - The textBottom (in)

textLeft - The textLeft (in)

textRight - The textRight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker6

void drawCompoundMarker6(IPoint point,
                         String textTop,
                         String textBottom,
                         String textLeft1,
                         String textLeft2,
                         String textRight1,
                         String textRight2)
                         throws IOException,
                                AutomationException

Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and two strings on each side of the marker (left and right).

Remarks

Draws a marker with 6 text labels: 1-top, 1-bottom, 2-left, 2-right

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

textBottom - The textBottom (in)

textLeft1 - The textLeft1 (in)

textLeft2 - The textLeft2 (in)

textRight1 - The textRight1 (in)

textRight2 - The textRight2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker8

void drawCompoundMarker8(IPoint point,
                         String textTop,
                         String textBottom,
                         String textLeft1,
                         String textLeft2,
                         String textLeft3,
                         String textRight1,
                         String textRight2,
                         String textRight3)
                         throws IOException,
                                AutomationException

Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and three strings on each side of the marker (left and right).

Remarks

Draws a marker with 8 text labels: 1-top, 1-bottom, 3-left, 3-right

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

textBottom - The textBottom (in)

textLeft1 - The textLeft1 (in)

textLeft2 - The textLeft2 (in)

textLeft3 - The textLeft3 (in)

textRight1 - The textRight1 (in)

textRight2 - The textRight2 (in)

textRight3 - The textRight3 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawCompoundMarker10

void drawCompoundMarker10(IPoint point,
                          String textTop,
                          String textBottom,
                          String textLeft1,
                          String textLeft2,
                          String textLeft3,
                          String textLeft4,
                          String textRight1,
                          String textRight2,
                          String textRight3,
                          String textRight4)
                          throws IOException,
                                 AutomationException

Draws specified point on the dynamic display with one string on the top of the marker, one string on the bottom and four strings on each side of the marker (left and right).

Remarks

Draws a marker with 10 text labels: 1-top, 1-bottom, 4-left, 4-right

Product Availability

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

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

textTop - The textTop (in)

textBottom - The textBottom (in)

textLeft1 - The textLeft1 (in)

textLeft2 - The textLeft2 (in)

textLeft3 - The textLeft3 (in)

textLeft4 - The textLeft4 (in)

textRight1 - The textRight1 (in)

textRight2 - The textRight2 (in)

textRight3 - The textRight3 (in)

textRight4 - The textRight4 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.