diff options
Diffstat (limited to 'platform/macos/docs/guides/Data-Driven Styling.md')
| -rw-r--r-- | platform/macos/docs/guides/Data-Driven Styling.md | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/platform/macos/docs/guides/Data-Driven Styling.md b/platform/macos/docs/guides/Data-Driven Styling.md new file mode 100644 index 0000000000..8344de23c9 --- /dev/null +++ b/platform/macos/docs/guides/Data-Driven Styling.md @@ -0,0 +1,117 @@ + +<!-- + This file is generated. + Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. +--> + +# Data-Driven Styling + +Mapbox’s data-driven styling features allow you to use data properties to style your maps. You can style objects within the same layer differently based on their individual attributes. This enables you to style icons, routes, parks, and more based on feature attributes. + +  + +# How to use Data-Driven Styling +This guide uses earthquake data from the [U.S. Geological Survey](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php) to style a map based on attributes. For more information about how to work with GeoJSON data in our iOS SDK, please see our [working with GeoJSON data](working-with-geojson-data.html) guide. + +`MGLStyleFunction` + +There are three subclasses of `MGLStyleFunction`: + +* `MGLCameraStyleFunction` - For a style value that changes with zoom level. For example, you can make the radius of a circle to increase based on zoom level. In iOS SDK v3.4, this was a `MGLStyleFunction`. +* `MGLSourceStyleFunction` - For a style value that changes with the attributes of a feature. You can adjust the radius of a circle based on the magnitude of an earthquake, for example. +* `MGLCompositeStyleFunction` - For a style value that changes with both zoom level and attribute values. For example, you can add a circle layer where each circle has a radius based on both zoom level and the magnitude of an earthquake. + +The documentation for individual style properties will note which style functions are enabled for that property. + +## Stops + +Stops are key-value pairs that that determine a style value. With a `MGLCameraSourceFunction` stop, you can use a dictionary with a zoom level for a key and a `MGLStyleValue` for the value. For example, you can use a stops dictionary with zoom levels 0, 10, and 20 as keys, and yellow, orange, and red as the values. A `MGLSourceStyleFunction` uses the relevant attribute value as the key. + +## Interpolation Mode + +The effect a key has on the style value is determined by the interpolation mode. There are four interpolation modes that can be used with a source style function: exponential, interval, categorical, and identity. You can also use exponential and interval interpolation modes with a camera style function. + +### Exponential (or Linear) + +`MGLInterpolationModelExponential` creates a linear or exponential effect based on the values. The key value is the starting point for interpolation, and the style value is based on where an attribute value falls between two keys. By default, `MGLInterpolationModeExponential` uses an interpolation base of 1. This causes a linear relationship between the style value and stop key. + +The stops dictionary below, for example, shows colors that continuously shift from yellow to orange to red to blue to white based on the attribute value. + +``` swift + let url = URL(string: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_week.geojson") + let symbolSource = MGLSource(identifier: "source") + let symbolLayer = MGLSymbolStyleLayer(identifier: "place-city-sm", source: symbolSource) + + let source = MGLShapeSource(identifier: "earthquakes", url: url, options: nil) + style.addSource(source) + + let stops = [0: MGLStyleValue(rawValue: NSColor.yellow), + 2.5: MGLStyleValue(rawValue: NSColor.orange), + 5: MGLStyleValue(rawValue: NSColor.red), + 7.5: MGLStyleValue(rawValue: NSColor.blue), + 10: MGLStyleValue(rawValue: NSColor.white)] + + let layer = MGLCircleStyleLayer(identifier: "circles", source: source) + layer.circleColor = MGLStyleValue(interpolationMode: .exponential, + sourceStops: stops, + attributeName: "mag", + options: [.defaultValue: MGLStyleValue<NSColor>(rawValue: .green)]) + layer.circleRadius = MGLStyleValue(rawValue: 10) + style.insertLayer(layer, below: symbolLayer) +``` + + + +### Interval + +`MGLInterpolationModeInterval` creates a range using the keys from the stops dictionary. The range is from the given key to just less than the next key. The attribute values that fall into that range are then styled using the style value assigned to that key. + +When we use the stops dictionary given above with an interval interpolation mode, we create ranges where earthquakes with a magnitude of 0 to just less than 2.5 would be yellow, 2.5 to just less than 5 would be orange, and so on. + +``` swift +layer.circleColor = MGLStyleValue(interpolationMode: .interval, + sourceStops: stops, + attributeName: "mag", + options: [.defaultValue: MGLStyleValue<NSColor>(rawValue: .green)]) +``` + + + +### Categorical + +Returns the output value that is equal to the stop for the function input. We’re going to use a different stops dictionary than we did for the previous two modes. + +There are three main types of events in the dataset: earthquakes, explosions, and quarry blasts. In this case, the color of the circle layer will be determined by the type of event, with a default value of green to catch any events that do not fall into any of those categories. + +``` swift +let categoricalStops = ["earthquake": MGLStyleValue(rawValue: NSColor.orange), + "explosion": MGLStyleValue(rawValue: NSColor.red), + "quarry blast": MGLStyleValue(rawValue: NSColor.yellow)] + +layer.circleColor = MGLStyleValue(interpolationMode: .categorical, + sourceStops: categoricalStops, + attributeName: "type", + options: [.defaultValue: MGLStyleValue(rawValue: NSColor.blue)]) + +``` + +  + +### Identity + +`MGLInterpolationModeIdentity` uses the attribute’s value as the style value. For example, you can set the `circleRadius` to the earthquake’s magnitude. Since the attribute value itself will be used as the style value, `sourceStops` can be set to `nil`. + +``` swift +layer.circleRadius = MGLStyleValue(interpolationMode: .identity, + sourceStops: nil, + attributeName: "mag", + options: [.defaultValue: MGLStyleValue<NSNumber>(rawValue: 0)]) + +``` + + + +##Resources + +* [USGS](https://earthquake.usgs.gov/earthquakes/feed/v1.0/geojson.php) +* [For Style Authors](for-style-authors.html) |