MLNHeatmapStyleLayer class

An MLNHeatmapStyleLayer is a style layer that renders a heatmap.

A heatmap visualizes the spatial distribution of a large, dense set of point data, using color to avoid cluttering the map with individual points at low zoom levels. The points are weighted by an attribute you specify. Use a heatmap style layer in conjunction with point or point collection features. These features can come from vector tiles loaded by an MLNHeatmapStyleLayer object, or they can be MLNHeatmapStyleLayer, MLNHeatmapStyleLayer, MLNHeatmapStyleLayer, or MLNHeatmapStyleLayer instances in an MLNHeatmapStyleLayer or MLNHeatmapStyleLayer object.

Consider accompanying a heatmap style layer with an MLNHeatmapStyleLayer or MLNHeatmapStyleLayer at high zoom levels. If you are unsure whether the point data in an MLNHeatmapStyleLayer is dense enough to warrant a heatmap, you can alternatively cluster the source using the MLNHeatmapStyleLayer option and render the data using an MLNHeatmapStyleLayer or MLNHeatmapStyleLayer.

You can access an existing heatmap style layer using the MLNStyle/layerWithIdentifier: method if you know its identifier; otherwise, find it using the MLNStyle/layers property. You can also create a new heatmap style layer and add it to the style using a method such as MLNStyle/addLayer:.

See the Create a heatmap layer example to learn how to add this style layer to your map.

Example

Inheritance

Constructors

MLNHeatmapStyleLayer()
Returns a new instance of MLNHeatmapStyleLayer constructed with the default new method.
factory
MLNHeatmapStyleLayer.castFrom(ObjCObjectBase other)
Constructs a MLNHeatmapStyleLayer that points to the same underlying object as other.
MLNHeatmapStyleLayer.castFromPointer(Pointer<ObjCObject> other, {bool retain = false, bool release = false})
Constructs a MLNHeatmapStyleLayer that wraps the given raw object pointer.

Properties

debugDescription$1 → NSString
debugDescription
no setterinherited
description$1 → NSString
description
no setterinherited
hash$1 int
hash
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
heatmapColor NSExpression
The color of each screen point based on its density value in a heatmap. This property is normally set to an interpolation or step expression with the $heatmapDensity value as its input.
getter/setter pair
heatmapIntensity NSExpression
Similar to heatmapWeight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
getter/setter pair
heatmapIntensityTransition MLNTransition
The transition affecting any changes to this layer’s heatmapIntensity property.
getter/setter pair
heatmapOpacity NSExpression
The global opacity at which the heatmap layer will be drawn.
getter/setter pair
heatmapOpacityTransition MLNTransition
The transition affecting any changes to this layer’s heatmapOpacity property.
getter/setter pair
heatmapRadius NSExpression
Radius of influence of one heatmap point in points. Increasing the value makes the heatmap smoother, but less detailed.
getter/setter pair
heatmapRadiusTransition MLNTransition
The transition affecting any changes to this layer’s heatmapRadius property.
getter/setter pair
heatmapWeight NSExpression
A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
getter/setter pair
identifier → NSString
A string that uniquely identifies the style layer in the style to which it is added.
no setterinherited
isProxy bool
isProxy
no setterinherited
maximumZoomLevel double
The maximum zoom level at which the layer gets parsed and appears. This value is a floating-point number.
getter/setter pairinherited
minimumZoomLevel double
The minimum zoom level at which the layer gets parsed and appears. This value is a floating-point number.
getter/setter pairinherited
predicate NSPredicate?
The style layer’s predicate.
getter/setter pairinherited
ref → ObjCObjectRef
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sourceIdentifier → NSString?
Identifier of the source from which the receiver obtains the data to style.
no setterinherited
sourceLayerIdentifier ↔ NSString?
Identifier of the layer within the source identified by the sourceIdentifier property from which the receiver obtains the data to style.
getter/setter pairinherited
superclass$1 → ObjCObjectBase
superclass
no setterinherited
visible bool
Whether this layer is displayed. A value of NO hides the layer.
getter/setter pairinherited

Methods

autorelease() MLNHeatmapStyleLayer
autorelease
override
class$1() → ObjCObjectBase
class
inherited
conformsToProtocol$1(Protocol aProtocol) bool
conformsToProtocol:
inherited
copy() → ObjCObjectBase
copy
inherited
dealloc() → void
dealloc
inherited
doesNotRecognizeSelector(Pointer<ObjCSelector> aSelector) → void
doesNotRecognizeSelector:
inherited
forwardingTargetForSelector(Pointer<ObjCSelector> aSelector) → ObjCObjectBase
forwardingTargetForSelector:
inherited
forwardInvocation(NSInvocation anInvocation) → void
forwardInvocation:
inherited
init() MLNHeatmapStyleLayer
init
override
initWithIdentifier(NSString identifier, {required MLNSource source}) MLNHeatmapStyleLayer
Returns a heatmap style layer initialized with an identifier and source.
isEqual(ObjCObjectBase object) bool
isEqual:
inherited
isKindOfClass(ObjCObjectBase aClass) bool
isKindOfClass:
inherited
isMemberOfClass(ObjCObjectBase aClass) bool
isMemberOfClass:
inherited
methodForSelector(Pointer<ObjCSelector> aSelector) Pointer<NativeFunction<Void Function()>>
methodForSelector:
inherited
methodSignatureForSelector(Pointer<ObjCSelector> aSelector) → NSMethodSignature
methodSignatureForSelector:
inherited
mutableCopy() → ObjCObjectBase
mutableCopy
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
performSelector(Pointer<ObjCSelector> aSelector) → ObjCObjectBase
performSelector:
inherited
performSelector$1(Pointer<ObjCSelector> aSelector, {required ObjCObjectBase withObject}) → ObjCObjectBase
performSelector:withObject:
inherited
performSelector$2(Pointer<ObjCSelector> aSelector, {required ObjCObjectBase withObject, required ObjCObjectBase withObject$1}) → ObjCObjectBase
performSelector:withObject:withObject:
inherited
release() → void
release
inherited
respondsToSelector(Pointer<ObjCSelector> aSelector) bool
respondsToSelector:
inherited
retain() MLNHeatmapStyleLayer
retain
override
retainCount() int
retainCount
inherited
self$1() MLNHeatmapStyleLayer
self
override
toString() String
A string representation of this object.
inherited
zone() Pointer<NSZone>
zone
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

alloc() MLNHeatmapStyleLayer
alloc
override
allocWithZone(Pointer<NSZone> zone) MLNHeatmapStyleLayer
allocWithZone:
override
isInstance(ObjCObjectBase obj) bool
Returns whether obj is an instance of MLNHeatmapStyleLayer.
override
new$() MLNHeatmapStyleLayer
new
override