summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Kiley <jmkiley@users.noreply.github.com>2017-03-15 13:57:37 -0700
committerGitHub <noreply@github.com>2017-03-15 13:57:37 -0700
commit2c0005c262153a161d07f8c1ca3c5a843ed5f7ed (patch)
tree5112354c2c2a2ed1c5aae9f883478881121e9482
parent458de43b9e8d17d24c56cfcec53d1a1f3ac6602e (diff)
downloadqtlocation-mapboxgl-2c0005c262153a161d07f8c1ca3c5a843ed5f7ed.tar.gz
[ios, macos] Add more information to interpolation mode docs (#8425)
Addresses #8192 until #8354 lands.
-rw-r--r--platform/darwin/src/MGLStyleValue.h19
1 files changed, 13 insertions, 6 deletions
diff --git a/platform/darwin/src/MGLStyleValue.h b/platform/darwin/src/MGLStyleValue.h
index d6a8b95d81..eb9d40ca6b 100644
--- a/platform/darwin/src/MGLStyleValue.h
+++ b/platform/darwin/src/MGLStyleValue.h
@@ -54,23 +54,30 @@ extern MGL_EXPORT const MGLStyleFunctionOption MGLStyleFunctionOptionDefaultValu
*/
typedef NS_ENUM(NSUInteger, MGLInterpolationMode) {
/**
- Values between two stops are interpolated exponentially or linearly if the
- `MGLStyleFunctionOptionInterpolationBase` is 1.
+ Values between two stops are interpolated linearly, or exponentially based on
+ the `MGLStyleFunctionOptionInterpolationBase`. A higher interpolation base
+ causes the function’s output values to vary exponentially, increasing more rapidly
+ towards the high end of the function’s range. The default interpolation base of 1
+ creates a linear interpolation. Use exponential interpolation mode to show values
+ relative to stop keys.
*/
MGLInterpolationModeExponential = 0,
/**
Values between two stops are not interpolated. Instead, properties are set
- to the value of the stop just less than the function input.
+ to the value of the stop just less than the function input. Use interval
+ interpolation mode to show values that fall within a range.
*/
MGLInterpolationModeInterval,
/**
Values between two stops are not interpolated. Instead, properties are set
- to the value of the stop equal to the function input's key value.
+ to the value of the stop equal to the function input's key value. Use
+ categorical interpolation mode to show values that fit into categories.
*/
MGLInterpolationModeCategorical,
/**
- Values between two stops are not interpolated. Instead, values are set
- to their input value.
+ Values between two stops are not interpolated. Instead, values are set to their
+ input value. Use identity interpolation mode to show attribute values that can be
+ used as style values.
*/
MGLInterpolationModeIdentity
};