Balloon Class |
Each 3D scene has a balloon view which can display HTML content directly. The balloon is associated with
a Cartographic or screen space coordinate, and an indicator attached to the the balloon will stay fixed to that coordinate.
The balloon content will resize and position itself such that it is clear what the indicator is pointing to. The balloon is useful for
displaying rich content that is associated with a particular Cartographic or screen space coordinate.
Inheritance HierarchyNamespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.1.418.0 (24.1.418.0)
SyntaxThe Balloon type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BackgroundColor |
Gets the color of the Background of the balloon and content associated with this balloon. This property returns null if a background color was not specified.
|
| CartographicPosition |
Gets the Cartographic position of the balloon. This property returns null if the Balloon is associated with a ControlPosition or a position was not specified.
|
| CentralBody |
Gets the CentralBody associated with the CartographicPosition of the balloon. This property returns null if the Balloon is associated with a ControlPosition or a position was not specified.
|
| Content |
Gets the HTML content associated with the balloon.
|
| ContentColor |
Gets the color of the Html content associated with this balloon. This property returns null if a content color was not specified.
|
| ControlPosition |
Gets the Rectangular associated with the control position of the balloon. This property returns null if the Balloon is associated with a CartographicPosition or a position was not specified.
|
| IsShown |
Gets whether or not the balloon is shown in the Scene.
|
| ShowBorder |
Gets or sets whether to display the decorative border around the balloon.
|
Methods| Name | Description | |
|---|---|---|
 | Dispose | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Hide |
Hides the balloon for the Scene.
|
| Show(String) |
Shows the balloon with the HTML content specified by htmlContent, at the center of the control.
|
| Show(String, Cartographic) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on EarthCentralBody.
|
| Show(String, Rectangular) |
Shows the balloon with the HTML content specified by htmlContent, at the control position specified by controlPosition.
|
| Show(String, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the center of the control.
|
| Show(String, Cartographic, CentralBody) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on centralBody.
|
| Show(String, Cartographic, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on EarthCentralBody.
|
| Show(String, Rectangular, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the control position specified by controlPosition.
|
| Show(String, Color, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the center of the control.
|
| Show(String, Cartographic, CentralBody, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on centralBody.
|
| Show(String, Cartographic, Color, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on EarthCentralBody.
|
| Show(String, Rectangular, Color, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the control position specified by controlPosition.
|
| Show(String, Cartographic, CentralBody, Color, Color) |
Shows the balloon with the HTML content specified by htmlContent, at the Cartographic position specified on centralBody.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Navigating |
Raised when a link is navigated to in the balloon.
|
See Also