Session parameters for an Azure Maps overlay. More...

#include <CesiumRasterOverlays/AzureMapsRasterOverlay.h>

Public Attributes
std::string	key
	The Azure Maps subscription key to use.

std::string	apiVersion {"2024-04-01"}
	The version number of Azure Maps API.

std::string	tilesetId {AzureMapsTilesetId::baseRoad}
	A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API.

std::string	language {"en-US"}
	The language in which search results should be returned. Should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, default language is used.

std::string	view {"US"}
	The view (also called the "user region") of a certain country/region for which to show the correct maps. Quoting the Azure Maps' documentation:

bool	showLogo = true
	Whether or not the AzureMapsRasterOverlay should show the Azure Maps logo.

std::string	apiBaseUrl {"https://atlas.microsoft.com/"}
	The base URL for the Azure Maps API.

Detailed Description

Session parameters for an Azure Maps overlay.

Definition at line 118 of file AzureMapsRasterOverlay.h.

Member Data Documentation

◆ apiBaseUrl

std::string CesiumRasterOverlays::AzureMapsSessionParameters::apiBaseUrl {"https://atlas.microsoft.com/"}

The base URL for the Azure Maps API.

Definition at line 189 of file AzureMapsRasterOverlay.h.

◆ apiVersion

std::string CesiumRasterOverlays::AzureMapsSessionParameters::apiVersion {"2024-04-01"}

The version number of Azure Maps API.

Definition at line 127 of file AzureMapsRasterOverlay.h.

◆ key

std::string CesiumRasterOverlays::AzureMapsSessionParameters::key

The Azure Maps subscription key to use.

Definition at line 122 of file AzureMapsRasterOverlay.h.

◆ language

std::string CesiumRasterOverlays::AzureMapsSessionParameters::language {"en-US"}

The language in which search results should be returned. Should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, default language is used.

Refer to Supported Languages for details.

Definition at line 153 of file AzureMapsRasterOverlay.h.

◆ showLogo

bool CesiumRasterOverlays::AzureMapsSessionParameters::showLogo = true

Whether or not the AzureMapsRasterOverlay should show the Azure Maps logo.

Azure requires the logo to be shown, so setting this to false is only valid when something else is already showing the logo.

Definition at line 184 of file AzureMapsRasterOverlay.h.

◆ tilesetId

std::string CesiumRasterOverlays::AzureMapsSessionParameters::tilesetId {AzureMapsTilesetId::baseRoad}

A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a tilesetId to use when making requests. The tilesetId for tilesets created using Azure Maps Creator are generated through the Tileset Create API.

The supported ready-to-use tilesets supplied by Azure Maps are listed here.

Definition at line 140 of file AzureMapsRasterOverlay.h.

◆ view

std::string CesiumRasterOverlays::AzureMapsSessionParameters::view {"US"}

The view (also called the "user region") of a certain country/region for which to show the correct maps. Quoting the Azure Maps' documentation:

"Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to "Unified" even if you haven't defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set 'View=Auto', which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN."

Refer to Supported Views for details and to see the available Views.

Definition at line 175 of file AzureMapsRasterOverlay.h.

The documentation for this struct was generated from the following file:

/home/runner/work/cesium-native/cesium-native/CesiumRasterOverlays/include/CesiumRasterOverlays/AzureMapsRasterOverlay.h

Public Attributes