HERE iOS SDK Developer's Guide

NMACustomizableScheme

Class Summary

class NMACustomizableScheme

Derived from: NSObject

Represents a Customizable scheme.

Include: NMAKit.framework/headers/NMACustomizableScheme.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMACustomizableScheme

[For complete information, see the section Class Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(nullable NMACustomizableColor *) colorForProperty:( NMASchemeColorProperty ) colorProperty forZoomLevel:(float) zoomLevel

-(float) floatForProperty:( NMASchemeFloatProperty ) floatProperty forZoomLevel:(float) zoomLevel

-(nonnull instancetype) init

Use NMAMapView to obtain an instance of this class

-(int) integerForProperty:( NMASchemeIntegerProperty ) integerProperty forZoomLevel:(float) zoomLevel

-(nonnull NSString *) name

Returns the name of a customizable scheme object

-(void) setColorProperty:(nonnull NMACustomizableColor *) variableColor forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a color property

-(void) setFloatProperty:( NMASchemeFloatProperty ) floatProperty withValue:(float) value forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a property of Float type

-(void) setIntegerProperty:( NMASchemeIntegerProperty ) integerProperty withValue:(int) value forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a property of Integer type

Class Method Summary

Table 2. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents a Customizable scheme. Customizable schemes are obtained from NMAMapView% class with getCustomizableSchemeWithName: or createCustomizableSchemeWithName: methods

Instance Method Details

-(nullable NMACustomizableColor *) colorForProperty:( NMASchemeColorProperty ) colorProperty forZoomLevel:(float) zoomLevel

Retrieves a color property

Note:

The zoom parameter takes a specific zoom level, and not a range.

Parameters:

  • colorProperty

    The NMASchemeColorProperty% to retrieve.

Returns:

The NMACustomizableColor% object.

-(float) floatForProperty:( NMASchemeFloatProperty ) floatProperty forZoomLevel:(float) zoomLevel

Retrieve value of a Float property

Note:

The zoom parameter takes a specific zoom level, and not a range.

Parameters:

  • floatProperty

    The NMASchemeFloatProperty% to retrieve.

Returns:

The property value as float.

-(nonnull instancetype) init

Use NMAMapView to obtain an instance of this class.

-(int) integerForProperty:( NMASchemeIntegerProperty ) integerProperty forZoomLevel:(float) zoomLevel

Retrieve value of an Integer property

Note:

The zoom parameter takes a specific zoom level, and not a range.

Parameters:

  • integerProperty

    The NMASchemeIntegerProperty% to retrieve.

Returns:

The property value as int.

-(nonnull NSString *) name

Returns the name of a customizable scheme object.

Returns:

name of customizable scheme or empty string if scheme is not valid.

-(void) setColorProperty:(nonnull NMACustomizableColor *) variableColor forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a color property.

Parameters:

  • variableColor

    The NMACustomizableColor.

  • zoomRange

    The zooom range to which the propety should be set to.

-(void) setFloatProperty:( NMASchemeFloatProperty ) floatProperty withValue:(float) value forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a property of Float type.

Parameters:

  • floatProperty

    The property to be modified.

  • zoomRange

    The zooom range to which the propety should be set to.

-(void) setIntegerProperty:( NMASchemeIntegerProperty ) integerProperty withValue:(int) value forZoomRange:(nonnull NMAZoomRange *) zoomRange

Sets a property of Integer type.

Parameters:

  • integerProperty

    The property to be modified.

  • zoomRange

    The zooom range to which the propety should be set to.

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly