Class CIMCompositeCallout

Namespace
ESRI.ArcGIS.CIM
Assembly
ESRI.Server.CIM.dll

Represents a composite callout. Composite callouts are a filled background along with an optional shadow, which is placed behind text. They may also have a leader line (consisting of one or both of a simple line, and filled dart) connecting the callout to an anchor point. Composite callouts may have additional surrounding text elements. The text representing these parts is specified in the text string using tags. Their relative position properties are specified in the CIMCompositeCallout through their corresponding CIMCompositeTextPartPosition elements specified below, but these properties can also be overridden with tag attributes.

public class CIMCompositeCallout : CIMCallout
Inheritance
CIMCompositeCallout
Inherited Members

Constructors

CIMCompositeCallout()

public CIMCompositeCallout()

Properties

BackgroundSymbol

Gets or sets the symbol used to draw the background.

public CIMPolygonSymbol BackgroundSymbol { get; set; }

Property Value

CIMPolygonSymbol

Bottom

Gets or sets the text part position properties for the bottom part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition Bottom { get; set; }

Property Value

CIMCompositeTextPartPosition

BottomLeft

Gets or sets the text part position properties for the bottom left part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition BottomLeft { get; set; }

Property Value

CIMCompositeTextPartPosition

BottomRight

Gets or sets the text part position properties for the bottom right part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition BottomRight { get; set; }

Property Value

CIMCompositeTextPartPosition

CornerRadius

Gets or sets the callout corner radius in points. 0.0 corresponds to a rectangle corner.

public double CornerRadius { get; set; }

Property Value

double

DartSymbol

Gets or sets a symbol used to draw the dart. This is only used if LeaderLinePercentage is less than 100%.

public CIMPolygonSymbol DartSymbol { get; set; }

Property Value

CIMPolygonSymbol

DartWidth

Gets or sets the dart width.

public double DartWidth { get; set; }

Property Value

double

Floating

Gets or sets the text part position properties for the floating part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not. The floating part is anchored below the bottom text part. If there is no bottom text part it is anchored below the middle text part plus margins.

public CIMCompositeTextPartPosition Floating { get; set; }

Property Value

CIMCompositeTextPartPosition

LeaderLinePercentage

Gets or sets the percentage of the leader line which is drawn as a line as opposed to a solid dart.

public double LeaderLinePercentage { get; set; }

Property Value

double

LeaderLineSymbol

Gets or sets the leader line symbol. This is only used if LeaderLinePercentage is greater than 0%.

public CIMLineSymbol LeaderLineSymbol { get; set; }

Property Value

CIMLineSymbol

Left

Gets or sets the text part position properties for the left part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition Left { get; set; }

Property Value

CIMCompositeTextPartPosition

Margin

Gets or sets the text margin defining the space around the text that is accounted for in balloon creation.

public CIMTextMargin Margin { get; set; }

Property Value

CIMTextMargin

Middle

Gets or sets the text part position properties for the middle part of the callout text. This contains the relative positioning information. Split offset and box will have no effect on this text part, since it is required that the middle part is in the center of the callout.

public CIMCompositeTextPartPosition Middle { get; set; }

Property Value

CIMCompositeTextPartPosition

Right

Gets or sets the text part position properties for the right part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition Right { get; set; }

Property Value

CIMCompositeTextPartPosition

ShadowSymbol

Gets or sets the shadow symbol for the callout.

public CIMPolygonSymbol ShadowSymbol { get; set; }

Property Value

CIMPolygonSymbol

ShadowXOffset

Gets or sets the shadow offset from the callout symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.

public double ShadowXOffset { get; set; }

Property Value

double

ShadowYOffset

Gets or sets the shadow offset from the callout symbol in the vertical direction. If X and Y are zero, no shadow is drawn.

public double ShadowYOffset { get; set; }

Property Value

double

SnapLeaderToCornersOnly

Gets or sets a value indicating whether the leader line should snap only to corners.

public bool SnapLeaderToCornersOnly { get; set; }

Property Value

bool

Top

Gets or sets the text part position properties for the top part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition Top { get; set; }

Property Value

CIMCompositeTextPartPosition

TopLeft

Gets or sets the text part position properties for the top left part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition TopLeft { get; set; }

Property Value

CIMCompositeTextPartPosition

TopRight

Gets or sets the text part position properties for the top right part of the callout text. This contains the relative positioning information, as well as split offset indicating the extent to which the callout part will mask the callout outline, and whether or not the part should be boxed in by the overall callout, or not.

public CIMCompositeTextPartPosition TopRight { get; set; }

Property Value

CIMCompositeTextPartPosition

Methods

FromJson(string, JsonDeserializationSettings)

Reconstructs the CIMCompositeCallout with a specified state from a JSON encoding.

public static CIMCompositeCallout FromJson(string json, JsonDeserializationSettings settings = null)

Parameters

json string

The JSON string containing the CIMCompositeCallout state.

settings JsonDeserializationSettings

The JSON deserialization settings.

Returns

CIMCompositeCallout

ToJson(JsonSerializationSettings)

Creates a JSON encoding of the CIMCompositeCallout and its current state.

public override string ToJson(JsonSerializationSettings settings = null)

Parameters

settings JsonSerializationSettings

The JSON serialization settings.

Returns

string