An image overlay fixed to the screen. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.4 |
| Inherits: |
Properties
- color : color
- drawOrder : int
- icon : KmlIcon
- overlayCoordinate : KmlImageCoordinate
- rotation : double
- rotationCoordinate : KmlImageCoordinate
- screenCoordinate : KmlImageCoordinate
- size : KmlImageCoordinate
Signals
- colorChanged()
- drawOrderChanged()
- iconChanged()
- overlayCoordinateChanged()
- rotationChanged()
- rotationCoordinateChanged()
- screenCoordinateChanged()
- sizeChanged()
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.
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 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 property was introduced in Esri.ArcGISRuntime 100.7.
See also screenCoordinate.
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 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 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 property was introduced in Esri.ArcGISRuntime 100.7.
See also overlayCoordinate.
size : KmlImageCoordinate |
Specifies the size of the image for the screen overlay.
- A value of
−1indicates to use the native dimension. - A value of
0indicates to maintain the aspect ratio. - A value of
nsets the value of the dimension.
Examples:
- A x value of
-1and y value of-1in fractions indicates the image size equals its original x and y dimensions. - A x value of
-1and y value of0.2in fractions indicates the image size equals its original x dimension and 20% of its y dimension. - A x value of
100and y value of500in 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 property was introduced in Esri.ArcGISRuntime 100.7.
Signal Documentation
Emitted when the color property changes.
Note: The corresponding handler is onColorChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the drawOrder property changes.
Note: The corresponding handler is onDrawOrderChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the icon property changes.
Note: The corresponding handler is onIconChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the overlayCoordinate property changes.
Note: The corresponding handler is onOverlayCoordinateChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the rotation property changes.
Note: The corresponding handler is onRotationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the rotationCoordinate property changes.
Note: The corresponding handler is onRotationCoordinateChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the screenCoordinate property changes.
Note: The corresponding handler is onScreenCoordinateChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the size property changes.
Note: The corresponding handler is onSizeChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.