diff options
Diffstat (limited to 'platform/darwin/src/MGLHeatmapStyleLayer.h')
| -rw-r--r-- | platform/darwin/src/MGLHeatmapStyleLayer.h | 58 |
1 files changed, 42 insertions, 16 deletions
diff --git a/platform/darwin/src/MGLHeatmapStyleLayer.h b/platform/darwin/src/MGLHeatmapStyleLayer.h index 35095fd52e..ad7ba5de01 100644 --- a/platform/darwin/src/MGLHeatmapStyleLayer.h +++ b/platform/darwin/src/MGLHeatmapStyleLayer.h @@ -13,10 +13,11 @@ NS_ASSUME_NONNULL_BEGIN 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 in vector - tiles loaded by an `MGLVectorSource` object or `MGLPointAnnotation`, - `MGLPointFeature`, `MGLPointCollection`, or `MGLPointCollectionFeature` - instances in an `MGLShapeSource` object. + style layer in conjunction with point or point collection features. These + features can come from vector tiles loaded by an `MGLVectorTileSource` object, + or they can be `MGLPointAnnotation`, `MGLPointFeature`, `MGLPointCollection`, + or `MGLPointCollectionFeature` instances in an `MGLShapeSource` or + `MGLComputedShapeSource` object. Consider accompanying a heatmap style layer with an `MGLCircleStyleLayer` or `MGLSymbolStyleLayer` at high zoom levels. If you are unsure whether the point @@ -35,10 +36,10 @@ NS_ASSUME_NONNULL_BEGIN ```swift let layer = MGLHeatmapStyleLayer(identifier: "earthquake-heat", source: earthquakes) - layer.heatmapWeight = NSExpression(format: "FUNCTION(magnitude, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", + layer.heatmapWeight = NSExpression(format: "mgl_interpolate:withCurveType:parameters:stops:(magnitude, 'linear', nil, %@)", [0: 0, 6: 1]) - layer.heatmapIntensity = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", + layer.heatmapIntensity = NSExpression(format: "mgl_interpolate:withCurveType:parameters:stops:($zoomLevel, 'linear', nil, %@)", [0: 1, 9: 3]) mapView.style?.addLayer(layer) @@ -64,9 +65,11 @@ MGL_EXPORT #pragma mark - Accessing the Paint Attributes +#if TARGET_OS_IPHONE /** - Defines the color of each point based on its density value in a heatmap. Should - be an expression that uses `$heatmapDensity` as input. + 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. The default value of this property is an expression that evaluates to a rainbow color scale from blue to red. Set this property to `nil` to reset it to the @@ -84,17 +87,40 @@ MGL_EXPORT feature attributes. */ @property (nonatomic, null_resettable) NSExpression *heatmapColor; +#else +/** + 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. + + The default value of this property is an expression that evaluates to a rainbow + color scale from blue to red. Set this property to `nil` to reset it to the + default value. + + You can set this property to an expression containing any of the following: + + * Constant `NSColor` values + * Predefined functions, including mathematical and string operators + * Conditional expressions + * Variable assignments and references to assigned variables + * Interpolation and step functions applied to the `$heatmapDensity` variable + + This property does not support applying interpolation or step functions to + feature attributes. + */ +@property (nonatomic, null_resettable) NSExpression *heatmapColor; +#endif /** Similar to `heatmapWeight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level. The default value of this property is an expression that evaluates to the float - `1`. Set this property to `nil` to reset it to the default value. + 1. Set this property to `nil` to reset it to the default value. You can set this property to an expression containing any of the following: - * Constant numeric values + * Constant numeric values no less than 0 * Predefined functions, including mathematical and string operators * Conditional expressions * Variable assignments and references to assigned variables @@ -116,11 +142,11 @@ MGL_EXPORT The global opacity at which the heatmap layer will be drawn. The default value of this property is an expression that evaluates to the float - `1`. Set this property to `nil` to reset it to the default value. + 1. Set this property to `nil` to reset it to the default value. You can set this property to an expression containing any of the following: - * Constant numeric values + * Constant numeric values between 0 and 1 inclusive * Predefined functions, including mathematical and string operators * Conditional expressions * Variable assignments and references to assigned variables @@ -145,11 +171,11 @@ MGL_EXPORT This property is measured in points. The default value of this property is an expression that evaluates to the float - `30`. Set this property to `nil` to reset it to the default value. + 30. Set this property to `nil` to reset it to the default value. You can set this property to an expression containing any of the following: - * Constant numeric values + * Constant numeric values no less than 1 * Predefined functions, including mathematical and string operators * Conditional expressions * Variable assignments and references to assigned variables @@ -171,11 +197,11 @@ MGL_EXPORT Especially useful when combined with clustering. The default value of this property is an expression that evaluates to the float - `1`. Set this property to `nil` to reset it to the default value. + 1. Set this property to `nil` to reset it to the default value. You can set this property to an expression containing any of the following: - * Constant numeric values + * Constant numeric values no less than 0 * Predefined functions, including mathematical and string operators * Conditional expressions * Variable assignments and references to assigned variables |