[ios, macos] Add more information to interpolation mode docs (#8425)

Addresses #8192 until #8354 lands.
This commit is contained in:
Jordan Kiley
2017-03-15 13:57:37 -07:00
committed by GitHub
parent 458de43b9e
commit 2c0005c262

View File

@@ -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
};