Skip To Content ArcGIS for Developers Sign In Dashboard

KmlScreenOverlay QML Type

An image overlay fixed to the screen. More...

Import Statement: import Esri.ArcGISRuntime 100.8
Since: Esri.ArcGISRuntime 100.4
Inherits:

KmlNode

Properties

Detailed Description

ScreenOverlays can be used for compasses, logos, and heads-up displays.

After creating the screen overlay, set the icon using KmlGroundOverlay.icon.

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

color : color

The color mask to be applied to the KML screen overlay's image buffer.

A color mask that can be used to blend the image associated with KML screen overlay. Pixels in the overlay image are multiplied by this color channel-by-channel.

This property is writable as of Esri.ArcGISRuntime 100.7.


drawOrder : int

The KML screen overlay's draw order.

This property is writable as of Esri.ArcGISRuntime 100.7.


icon : KmlIcon

The KML screen overlay icon.

This QML property was introduced in Esri.ArcGISRuntime 100.7.


overlayCoordinate : KmlImageCoordinate

Specifies a point on (or outside of) the overlay image that is mapped to the screen coordinate (screenCoordinate).

It requires x and y values, and the units for those values. The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the image ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the image. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the image. If not specified, the default is the center of the overlay image.

This QML property was introduced in Esri.ArcGISRuntime 100.7.

See also screenCoordinate.


rotation : double

Indicates the angle of rotation of the parent object.

A value of 0 means no rotation. The value is an angle in degrees counterclockwise starting from north. The center of the rotation, if not specified in rotation coordinate (rotationCoordinate), is the center of the overlay image.

This QML property was introduced in Esri.ArcGISRuntime 100.7.


rotationCoordinate : KmlImageCoordinate

The screen location about which the screen overlay is rotated.

If not specified, the rotation point is the center of the screen.

This QML property was introduced in Esri.ArcGISRuntime 100.7.


screenCoordinate : KmlImageCoordinate

Specifies a point relative to the screen origin that the overlay image is mapped to.

The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the screen ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the screen. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the screen. If not specified, the default is the center of the screen.

This QML property was introduced in Esri.ArcGISRuntime 100.7.

See also overlayCoordinate.


Specifies the size of the image for the screen overlay.

  • A value of −1 indicates to use the native dimension.
  • A value of 0 indicates to maintain the aspect ratio.
  • A value of n sets the value of the dimension.

Examples:

  • A x value of -1 and y value of -1 in fractions indicates the image size equals its original x and y dimensions.
  • A x value of -1 and y value of 0.2 in fractions indicates the image size equals its original x dimension and 20% of its y dimension.
  • A x value of 100 and y value of 500 in pixels indicates the image is of size 100 pixels by 500 pixels.

If not specified, the default is the original size of the image.

This QML property was introduced in Esri.ArcGISRuntime 100.7.



Feedback on this topic?