Whether you want to optimize your map for a certain display size, use case, branding, or highlight objects which are important to your users, the HERE SDK map customization feature allows you to have a fine level of control of your map view's rendering characteristics.
This section presents the components and concepts which you need to create your own map look-and-feel.
To customize the map, the first step is to obtain a
NMACustomizableScheme object from the map view. With this object, you can then get and set properties to modify the map. You can change color, width, length, and other properties of map objects such as buildings, land features, roads, and so on. Whether changes to properties are visible or not depends if the scheme you are customizing is currently at the affected zoom level and that the custom scheme is active.
A custom scheme which you create will not be permanently saved but will live as long as the map view object is in memory.
First you create or get a custom scheme from the map view, then get the respective property,
NMACustomizableVariable, and finally modify its properties using its accessor methods.
Map Customization Example on GitHub
Map customization starts by selecting one of the predefined schemes (such as
NMANormalNightScheme) to serve as a staring point. These predefined schemes are not customizable themselves, but provide the initial values from which your custom scheme is derived from. It is necessary to have the proper permission to access this base scheme as well as permission to customize.
Example of pre-defined schemes that we are already familiar with are (respectively, Normal Day, Normal Night):
Creating Your First Map Scheme Customization
In this example we will change the float property
CountryBoundary_Width, which causes the following rendering effect:
Let's learn how to implement this simple change. To begin, once you decided which scheme to base on, create an
NMACustomizableScheme object with the map view method:
NMACustomizableScheme * customScheme; customScheme = [self.mapView createCustomizableSchemeWithName:@"myCustomScheme" basedOnScheme: NMAMapSchemeNormalDay];
Once you created the customizable scheme, you can retrieve it again anytime with the following code as long as the map view object was not destroyed. Custom schemes are created and valid only to the specific Map View from which was obtained.
NMACustomizableScheme * customScheme = [self.mapView.getCustomizableSchemeWithName:@"myCustomScheme"];
Before setting the attributes, you create the zoom range for which the change shall take effect. For this purpose, helper class
NMAZoomRange is provided, taking a minimum and maximum zoom level value:
NMAZoomRange * myZoomRange = [[NMAZoomRange alloc] initWithMinZoomLevel:0.0f and toZoomLevel:20.0f];
You are now ready to read and set values. In the following example we read and change the
//to read a primitive (float) property value: provide the property name and the zoom level. float returnValue = [customScheme floatForProperty:NMASchemeCountryBoundaryWidth forZoomLevel: 10.0f]; //to set a float property: provide the property name, new value, and the previously created zoom range (NMAZoomRange). [customScheme setFloatProperty NMASchemeCountryBoundaryWidth withValue:10.0f forZoomRange: myZoomRange];
As seen above, for simple types such as Integer and Float, an object is not necessary for modification. For types such as color, the methods returns an object for easier manipulation.
Finally, you can activate the custom scheme in the map:
You should now see the map as the following:
Listing the available customizable properties
All available properties can be found in the
NMACustomizableVariable.h header file. For each property type, an
NS_ENUM exists, which is passed as an identifier of the property to its get and set methods. You can refer to the header file to find out its type.
One set of accessor is available for each type of property, for example:
colorForProperty:. The same goes for setter methods.
NMACustomizableVariablealso has the static method
allAvailableProperties, which returns an
NSDictionarywith all the properties the HERE SDK supports for customization (containing all
NMACustomizableVariableobjects, with its name as the key). This is specially useful if one wants to programmatically iterate through all the properties. It is always possible to find out the property type by reading the
NMACustomizableVariable- Base class, used for primitive types such as integer and float
NMACustomizableVariablewith methods to handle color properties
Changing Color Properties
In the following example you can see how to modify the
To modify color map attributes, we first obtain the custom color object
NMACustomizableColor, then modify it:
NMACustomizableColor *buildingColor = [customScheme colorForProperty:NMASchemeBuildingColor forZoomLevel:2.0f]; [buildingColor setRed:100.0f]; [buildingColor setGreen:100.0f]; [buildingColor setBlue:133.0f]; //now apply the changes, using the previously created zoom range [customScheme setColorProperty:buildingColor forZoomRange:myZoomRange];