MapBillboard
MapBillboard
MapBillboard
MapBillboard
Class
Definition
Displays an image that scales and fades in relation to its distance from the ReferenceCamera of the MapBillboard.
public : sealed class MapBillboard : MapElement, IMapBillboardpublic sealed class MapBillboard : MapElement, IMapBillboardPublic NotInheritable Class MapBillboard Inherits MapElement Implements IMapBillboard// This API is not available in Javascript.
- Inheritance
-
MapBillboardMapBillboardMapBillboardMapBillboard
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
A MapBillboard is very similar to a MapIcon. Use a MapIcon to emphasize a location on a map. Because images used to mark locations are typically small, they can remain the same size as users zoom in and out on a map.
Use a MapBillboard to show things like large images that relate to map locations. As users zoom out, the image will shrink proportionally in size to enable the user to view more of the map.
Constructors
MapBillboard(MapCamera) MapBillboard(MapCamera) MapBillboard(MapCamera) MapBillboard(MapCamera)
Initializes a new instance of the MapBillboard class.
public : MapBillboard(MapCamera camera)public MapBillboard(MapCamera camera)Public Sub New(camera As MapCamera)// This API is not available in Javascript.
Properties
CollisionBehaviorDesired CollisionBehaviorDesired CollisionBehaviorDesired CollisionBehaviorDesired
Gets or sets the behavior of a MapBillboard when it collides with other map features due to zoom level.
public : MapElementCollisionBehavior CollisionBehaviorDesired { get; set; }public MapElementCollisionBehavior CollisionBehaviorDesired { get; set; }Public ReadWrite Property CollisionBehaviorDesired As MapElementCollisionBehavior// This API is not available in Javascript.
- Value
- MapElementCollisionBehavior MapElementCollisionBehavior MapElementCollisionBehavior MapElementCollisionBehavior
The behavior of a MapBillboard when it collides with other map features due to zoom level.
CollisionBehaviorDesiredProperty CollisionBehaviorDesiredProperty CollisionBehaviorDesiredProperty CollisionBehaviorDesiredProperty
Identifies the CollisionBehaviorDesired dependency property.
public : static DependencyProperty CollisionBehaviorDesiredProperty { get; }public static DependencyProperty CollisionBehaviorDesiredProperty { get; }Public Static ReadOnly Property CollisionBehaviorDesiredProperty As DependencyProperty// This API is not available in Javascript.
Identifier for the CollisionBehaviorDesired dependency property.
Image Image Image Image
Gets or sets the image for the MapBillboard. Provide an optional custom image to replace the default point of interest (POI) image.
public : IRandomAccessStreamReference Image { get; set; }public IRandomAccessStreamReference Image { get; set; }Public ReadWrite Property Image As IRandomAccessStreamReference// This API is not available in Javascript.
- Value
- IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference IRandomAccessStreamReference
The point of interest (POI) image for the MapBillboard.
Remarks
The following line of code displays the MapBillboard with a custom image saved in the Assets folder of the project.
MapBillboard1.Image = RandomAccessStreamReference.CreateFromUri(new Uri("ms-appx:///Assets/customicon.png"));
Location Location Location Location
Gets or sets the geographic location of the MapBillboard on the MapControl. The location is the geographic location on the MapControl at which the NormalizedAnchorPoint of the MapBillboard is positioned.
public : Geopoint Location { get; set; }public Geopoint Location { get; set; }Public ReadWrite Property Location As Geopoint// This API is not available in Javascript.
The geographic location of the MapBillboard on the MapControl.
Remarks
If you provide an altitude and altitude reference system in 3D views, then MapBillboard elements added to the MapControl end up being placed underground or floating in space.
LocationProperty LocationProperty LocationProperty LocationProperty
Identifies the Location dependency property.
public : static DependencyProperty LocationProperty { get; }public static DependencyProperty LocationProperty { get; }Public Static ReadOnly Property LocationProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the Location dependency property.
NormalizedAnchorPoint NormalizedAnchorPoint NormalizedAnchorPoint NormalizedAnchorPoint
Gets or sets the anchor point of the MapBillboard. The anchor point is the point on the MapBillboard that is positioned at the point on the MapControl specified by the Location property.
public : Point NormalizedAnchorPoint { get; set; }public Point NormalizedAnchorPoint { get; set; }Public ReadWrite Property NormalizedAnchorPoint As Point// This API is not available in Javascript.
The anchor point of the MapBillboard.
Remarks
The default value of (0.5, 1), which represents the bottom center of the image.
NormalizedAnchorPointProperty NormalizedAnchorPointProperty NormalizedAnchorPointProperty NormalizedAnchorPointProperty
Identifies the NormalizedAnchorPoint dependency property.
public : static DependencyProperty NormalizedAnchorPointProperty { get; }public static DependencyProperty NormalizedAnchorPointProperty { get; }Public Static ReadOnly Property NormalizedAnchorPointProperty As DependencyProperty// This API is not available in Javascript.
The identifier for the NormalizedAnchorPoint dependency property.
ReferenceCamera ReferenceCamera ReferenceCamera ReferenceCamera
Gets the MapCamera settings that define the position and orientation where the image appears at a 1x scale.
public : MapCamera ReferenceCamera { get; }public MapCamera ReferenceCamera { get; }Public ReadOnly Property ReferenceCamera As MapCamera// This API is not available in Javascript.
The MapCamera settings that define the position and orientation where the image appears at a 1x scale.
Remarks
Because a MapBillboard image scales in and out as the ZoomLevel of the map changes, it's important to define where in that ZoomLevel the image appears at a normal 1x scale. You define that position in a Geopoint, and then pass that Geopoint as a parameter to the MapBillboard constructor.
For example, if you use the map's ActualCamera as that constructor parameter, the position defined in the reference camera becomes equal to the position defined in the maps internal camera. This becomes the position of the camera where the MapBillboard image appears at 1x scale. However, if your app gives users the ability to zoom out on the map, the image decreases in size because the maps internal camera is rising in altitude while the image at 1x scale remains fixed at the reference camera's position.