KmlGraphics#

class ansys.stk.core.graphics.KmlGraphics#: Provide loading and unloading of kml documents for a particular central body.

Overview#

Methods

`load_document`	Load a kml document from a uri.
`load_document_string`	Load a kml document from a Uri.
`load`	Load a kml document from a string containing the document.
`load_document_async`	Load a kml document asynchronously from a uri. The document loaded event is raised when the document is loaded.
`load_document_async_string`	Load a kml document asynchronously from a Uri. The document loaded event is raised when the document is loaded.
`load_async`	Load a kml document asynchronously from a string containing the document. The document loaded event is raised when the document is loaded.
`unload`	Unloads a kml document. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.
`unload_all`	Unloads all kml documents associated with this central body. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.
`subscribe`	“””Return an IKmlGraphicsEventHandler that is subscribed to handle events associated with this instance of KmlGraphics.”””

Properties

documents

The collection of kml documents that are currently loaded.

Import detail#

from ansys.stk.core.graphics import KmlGraphics

Property detail#

property KmlGraphics.documents: KmlDocumentCollection#: The collection of kml documents that are currently loaded.

Method detail#

KmlGraphics.load_document(self, kml_uri: str) → KmlDocument#

Load a kml document from a uri.

Parameters:: kml_uri : str
Returns:: KmlDocument

KmlGraphics.load_document_string(self, kml_uri: str) → KmlDocument#

Load a kml document from a Uri.

Parameters:: kml_uri : str
Returns:: KmlDocument

KmlGraphics.load(self, kml_document: str) → KmlDocument#

Load a kml document from a string containing the document.

Parameters:: kml_document : str
Returns:: KmlDocument

KmlGraphics.load_document_async(self, kml_uri: str) → None#

Load a kml document asynchronously from a uri. The document loaded event is raised when the document is loaded.

Parameters:: kml_uri : str
Returns:: None

KmlGraphics.load_document_async_string(self, kml_uri: str) → None#

Load a kml document asynchronously from a Uri. The document loaded event is raised when the document is loaded.

Parameters:: kml_uri : str
Returns:: None

KmlGraphics.load_async(self, kml_document: str) → None#

Load a kml document asynchronously from a string containing the document. The document loaded event is raised when the document is loaded.

Parameters:: kml_document : str
Returns:: None

KmlGraphics.unload(self, kml_document: KmlDocument) → None#

Unloads a kml document. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.

Parameters:: kml_document : KmlDocument
Returns:: None

KmlGraphics.unload_all(self) → None#

Unloads all kml documents associated with this central body. All associated visual features will be removed from the Scene. Once a KmlDocument is unloaded, it is no longer valid and will throw when accessing properties or methods.

Returns:: None