Skip to main content
Ctrl+K
PySTK - Home PySTK - Home
  • Getting started
  • User guide
  • API reference
  • Examples
  • Contribute
  • Artifacts
  • Release notes
Ctrl+K
  • GitHub
  • Getting started
  • User guide
  • API reference
  • Examples
  • Contribute
  • Artifacts
  • Release notes
Ctrl+K
  • GitHub

Section Navigation

  • The core library
    • πŸ–Ώ stkengine
    • πŸ–Ώ stkobjects
    • πŸ–Ώ stkrfchannelmodeler
    • πŸ–Ώ utilities
    • πŸ—Ž analysis_workbench
    • πŸ—Ž graphics
      • IConvolutionFilter
      • IDisplayCondition
      • IGlobeImageOverlay
      • IGlobeOverlay
      • IKmlContainer
      • IKmlFeature
      • IOverlay
      • IPathPrimitiveUpdatePolicy
      • IPositionInterpolator
      • IPrimitive
      • IProjection
      • IRaster
      • IRasterFilter
      • IRasterStream
      • IScreenOverlay
      • IScreenOverlayCollectionBase
      • IScreenOverlayContainer
      • ITerrainOverlay
      • ITriangulatorResult
      • AGICustomTerrainOverlay
      • AGICustomTerrainOverlayFactory
      • AGIProcessedImageGlobeOverlay
      • AGIProcessedImageGlobeOverlayFactory
      • AGIProcessedTerrainOverlay
      • AGIProcessedTerrainOverlayFactory
      • AGIRoamImageGlobeOverlay
      • AGIRoamImageGlobeOverlayFactory
      • AlphaFromLuminanceFilter
      • AlphaFromLuminanceFilterFactory
      • AlphaFromPixelFilter
      • AlphaFromPixelFilterFactory
      • AlphaFromRasterFilter
      • AlphaFromRasterFilterFactory
      • AltitudeDisplayCondition
      • AltitudeDisplayConditionFactory
      • AxesPrimitive
      • AxesPrimitiveFactory
      • BandExtractFilter
      • BandExtractFilterFactory
      • BandOrderFilter
      • BandOrderFilterFactory
      • BatchPrimitiveIndex
      • BlurFilter
      • BlurFilterFactory
      • BoundingSphere
      • BoundingSphereFactory
      • BoxTriangulatorInitializer
      • BrightnessFilter
      • BrightnessFilterFactory
      • Camera
      • CameraSnapshot
      • CameraVideoRecording
      • CentralBodyGraphics
      • CentralBodyGraphicsIndexer
      • Clouds
      • ColorToLuminanceFilter
      • ColorToLuminanceFilterFactory
      • CompositeDisplayCondition
      • CompositeDisplayConditionFactory
      • CompositePrimitive
      • CompositePrimitiveFactory
      • ConstantDisplayCondition
      • ConstantDisplayConditionFactory
      • ContrastFilter
      • ContrastFilterFactory
      • ConvolutionFilter
      • ConvolutionFilterFactory
      • CustomImageGlobeOverlay
      • CustomImageGlobeOverlayPluginActivator
      • CustomImageGlobeOverlayPluginActivatorFactory
      • CustomImageGlobeOverlayPluginProxy
      • CylinderTriangulatorInitializer
      • DisplayCondition
      • DistanceDisplayCondition
      • DistanceDisplayConditionFactory
      • DistanceToGlobeOverlayDisplayCondition
      • DistanceToGlobeOverlayDisplayConditionFactory
      • DistanceToPositionDisplayCondition
      • DistanceToPositionDisplayConditionFactory
      • DistanceToPrimitiveDisplayCondition
      • DistanceToPrimitiveDisplayConditionFactory
      • DurationPathPrimitiveUpdatePolicy
      • DurationPathPrimitiveUpdatePolicyFactory
      • EdgeDetectFilter
      • EdgeDetectFilterFactory
      • EllipsoidTriangulatorInitializer
      • ExtrudedPolylineTriangulatorInitializer
      • ExtrudedPolylineTriangulatorResult
      • FactoryAndInitializers
      • FilteringRasterStream
      • FilteringRasterStreamFactory
      • FlipFilter
      • FlipFilterFactory
      • FrameRate
      • GammaCorrectionFilter
      • GammaCorrectionFilterFactory
      • GaussianBlurFilter
      • GaussianBlurFilterFactory
      • GeospatialImageGlobeOverlay
      • GeospatialImageGlobeOverlayFactory
      • GlobeImageOverlay
      • GlobeImageOverlayAddCompleteEventArgs
      • GlobeImageOverlayInitializer
      • GlobeOverlay
      • GlobeOverlaySettings
      • GradientDetectFilter
      • GradientDetectFilterFactory
      • GraphicsFont
      • GraphicsFontFactory
      • GreatArcInterpolator
      • GreatArcInterpolatorFactory
      • ImageCollection
      • Jpeg2000WriterInitializer
      • KmlContainer
      • KmlDocument
      • KmlDocumentCollection
      • KmlDocumentLoadedEventArgs
      • KmlFeature
      • KmlFeatureCollection
      • KmlFolder
      • KmlGraphics
      • KmlNetworkLink
      • LevelsFilter
      • LevelsFilterFactory
      • Lighting
      • MarkerBatchPrimitive
      • MarkerBatchPrimitiveFactory
      • MarkerBatchPrimitiveOptionalParameters
      • MarkerBatchPrimitiveOptionalParametersFactory
      • MaximumCountPathPrimitiveUpdatePolicy
      • MaximumCountPathPrimitiveUpdatePolicyFactory
      • ModelArticulation
      • ModelArticulationCollection
      • ModelPrimitive
      • ModelPrimitiveFactory
      • ModelTransformation
      • ObjectCollection
      • Overlay
      • PathPoint
      • PathPointCollection
      • PathPointFactory
      • PathPrimitive
      • PathPrimitiveFactory
      • PathPrimitiveUpdatePolicy
      • PickResult
      • PickResultCollection
      • PixelSizeDisplayCondition
      • PixelSizeDisplayConditionFactory
      • PointBatchPrimitive
      • PointBatchPrimitiveFactory
      • PointBatchPrimitiveOptionalParameters
      • PointBatchPrimitiveOptionalParametersFactory
      • PolylinePrimitive
      • PolylinePrimitiveFactory
      • PolylinePrimitiveOptionalParameters
      • PolylinePrimitiveOptionalParametersFactory
      • PositionInterpolator
      • Primitive
      • PrimitiveManager
      • ProjectedRasterOverlay
      • ProjectedRasterOverlayFactory
      • Projection
      • ProjectionFactory
      • ProjectionRasterStreamPluginActivator
      • ProjectionRasterStreamPluginActivatorFactory
      • ProjectionRasterStreamPluginProxy
      • ProjectionStream
      • Raster
      • RasterAttributes
      • RasterAttributesFactory
      • RasterFactory
      • RasterFilter
      • RasterImageGlobeOverlay
      • RasterImageGlobeOverlayFactory
      • RasterStream
      • RendererTexture2D
      • RendererTextureTemplate2D
      • RenderingEventArgs
      • RhumbLineInterpolator
      • RhumbLineInterpolatorFactory
      • RotateFilter
      • RotateFilterFactory
      • Scene
      • SceneCollection
      • SceneDisplayCondition
      • SceneDisplayConditionFactory
      • SceneGlobeOverlaySettings
      • SceneManager
      • SceneManagerInitializer
      • ScreenOverlay
      • ScreenOverlayCollection
      • ScreenOverlayCollectionBase
      • ScreenOverlayFactory
      • ScreenOverlayManager
      • ScreenOverlayPickResult
      • ScreenOverlayPickResultCollection
      • SequenceFilter
      • SequenceFilterFactory
      • SharpenFilter
      • SharpenFilterFactory
      • SolidPrimitive
      • SolidPrimitiveFactory
      • SolidTriangulatorResult
      • Stereoscopic
      • SurfaceExtentTriangulatorInitializer
      • SurfaceMeshPrimitive
      • SurfaceMeshPrimitiveFactory
      • SurfacePolygonTriangulatorInitializer
      • SurfaceShapesInitializer
      • SurfaceShapesResult
      • SurfaceTriangulatorResult
      • TerrainOverlay
      • TerrainOverlayAddCompleteEventArgs
      • TerrainOverlayCollection
      • TerrainOverlayInitializer
      • TextBatchPrimitive
      • TextBatchPrimitiveFactory
      • TextBatchPrimitiveOptionalParameters
      • TextBatchPrimitiveOptionalParametersFactory
      • TextOverlay
      • TextOverlayFactory
      • Texture2DFactory
      • TextureFilter2D
      • TextureFilter2DFactory
      • TextureMatrix
      • TextureMatrixFactory
      • TextureScreenOverlay
      • TextureScreenOverlayFactory
      • TimeIntervalDisplayCondition
      • TimeIntervalDisplayConditionFactory
      • TriangleMeshPrimitive
      • TriangleMeshPrimitiveFactory
      • TriangleMeshPrimitiveOptionalParameters
      • TriangleMeshPrimitiveOptionalParametersFactory
      • TriangulatorResult
      • VectorPrimitive
      • VectorPrimitiveFactory
      • VideoStream
      • VideoStreamFactory
      • VisualEffects
      • ≔ AntiAliasingMethod
      • ≔ BinaryLogicOperation
      • ≔ BlurMethod
      • ≔ ConstrainedUpAxis
      • ≔ CylinderFillOptions
      • ≔ EdgeDetectMethod
      • ≔ FaceCullingMode
      • ≔ FontStyle
      • ≔ GradientDetectMethod
      • ≔ Jpeg2000CompressionProfile
      • ≔ KmlNetworkLinkRefreshMode
      • ≔ KmlNetworkLinkViewRefreshMode
      • ≔ MagnificationFilter
      • ≔ MapProjection
      • ≔ MarkerBatchRenderingMethod
      • ≔ MarkerBatchRenderPass
      • ≔ MarkerBatchSizeSource
      • ≔ MarkerBatchSizeUnit
      • ≔ MarkerBatchSortOrder
      • ≔ MinificationFilter
      • ≔ ModelTransformationType
      • ≔ ModelUpAxis
      • ≔ Origin
      • ≔ OutlineAppearance
      • ≔ OverlayAspectRatioMode
      • ≔ OverlayRole
      • ≔ PathPrimitiveRemoveLocation
      • ≔ PolylineType
      • ≔ PrimitiveIndicesOrderHint
      • ≔ PrimitivesSortOrder
      • ≔ RasterBand
      • ≔ RasterFlipAxis
      • ≔ RasterFormat
      • ≔ RasterOrientation
      • ≔ RasterSharpenMethod
      • ≔ RasterType
      • ≔ RefreshRate
      • ≔ RendererShadingModel
      • ≔ RenderPass
      • ≔ RenderPassHint
      • ≔ ScreenOverlayOrigin
      • ≔ ScreenOverlayPinningOrigin
      • ≔ ScreenOverlayUnit
      • ≔ SetHint
      • ≔ SnapshotFileFormat
      • ≔ StereoProjectionMode
      • ≔ StereoscopicDisplayMode
      • ≔ SurfaceMeshRenderingMethod
      • ≔ TextureFormat
      • ≔ TextureWrap
      • ≔ VideoFormat
      • ≔ VideoPlayback
      • ≔ Visibility
      • ≔ WindingOrder
    • πŸ—Ž stkdesktop
    • πŸ—Ž stkruntime
    • πŸ—Ž stkutil
    • πŸ—Ž stkx
    • πŸ—Ž uiapplication
    • πŸ—Ž uicore
  • The extensions module
  • PyAnsys
  • API reference
  • The core library
  • The graphics module
  • KmlNetworkLink

KmlNetworkLink#

class ansys.stk.core.graphics.KmlNetworkLink#

Bases: IKmlFeature

A KML network link.

Overview#

refresh

Refresh the network link.

uri

Get the uri of the network link.

refresh_mode

Get or set the refresh mode of the network link. The refresh mode specifies a time-based refresh policy for this link.

refresh_interval

Get or set the interval duration at which this network link will refresh, when refresh mode is set to on interval.

view_refresh_mode

Get or set the view refresh mode of the network link. The view refresh mode specifies the refresh policy for the when the camera’s view changes.

view_refresh_time

Get or set the duration after camera view movement stops that this network link will refresh, when view refresh mode is set to on stop.

view_bound_scale

Get or set the value that scales the bounding box defining the view associated with this network link. A value less than 1.0 specifies to use less than the full view (screen). A value greater than 1…

minimum_refresh_period

Get the duration that is the minimum allowed time between refreshes of this network link.

cookie

Get the cookie string associated with this network link.

message

Get the message string associated with this network link.

link_snippet

Get the link snippet associated with this network link.

expires

Get the string specifying the date/time this network should expire and be refreshed.

Import detail#

from ansys.stk.core.graphics import KmlNetworkLink

Property detail#

property KmlNetworkLink.uri: str#

Get the uri of the network link.

property KmlNetworkLink.refresh_mode: KmlNetworkLinkRefreshMode#

Get or set the refresh mode of the network link. The refresh mode specifies a time-based refresh policy for this link.

property KmlNetworkLink.refresh_interval: float#

Get or set the interval duration at which this network link will refresh, when refresh mode is set to on interval.

property KmlNetworkLink.view_refresh_mode: KmlNetworkLinkViewRefreshMode#

Get or set the view refresh mode of the network link. The view refresh mode specifies the refresh policy for the when the camera’s view changes.

property KmlNetworkLink.view_refresh_time: float#

Get or set the duration after camera view movement stops that this network link will refresh, when view refresh mode is set to on stop.

property KmlNetworkLink.view_bound_scale: float#

Get or set the value that scales the bounding box defining the view associated with this network link. A value less than 1.0 specifies to use less than the full view (screen). A value greater than 1…

property KmlNetworkLink.minimum_refresh_period: float#

Get the duration that is the minimum allowed time between refreshes of this network link.

property KmlNetworkLink.cookie: str#

Get the cookie string associated with this network link.

property KmlNetworkLink.message: str#

Get the message string associated with this network link.

property KmlNetworkLink.link_snippet: str#

Get the link snippet associated with this network link.

property KmlNetworkLink.expires: str#

Get the string specifying the date/time this network should expire and be refreshed.

Method detail#

KmlNetworkLink.refresh(self) → None#

Refresh the network link.

Returns:

None

previous

KmlGraphics

next

LevelsFilter

On this page
  • ansys.stk.core.graphics.KmlNetworkLink
  • Overview
  • Import detail
  • Property detail
    • uri
    • refresh_mode
    • refresh_interval
    • view_refresh_mode
    • view_refresh_time
    • view_bound_scale
    • minimum_refresh_period
    • cookie
    • message
    • link_snippet
    • expires
  • Method detail
    • refresh()
Edit on GitHub
  • Show Source

Β© Copyright (c) 2025 ANSYS, Inc. All rights reserved.

Created using Sphinx 7.4.7.

Built with the Ansys Sphinx Theme 1.5.3.
Last updated on