Updated docs

airteamaus · Nov 29, 2017 · 3178e2c · 3178e2c
1 parent 5fa9cc8
commit 3178e2c
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 16 deletions.
diff --git a/docs/CircleLayer.md b/docs/CircleLayer.md
@@ -25,8 +25,9 @@
 | `circleBlur` | `number` | `none` | `none` | Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. |
 | `circleOpacity` | `number` | `none` | `none` | The opacity at which the circle will be drawn. |
 | `circleTranslate` | `array` | `none` | `none` | The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively. |
-| `circleTranslateAnchor` | `enum` | `circleTranslate` | `none` | Controls the translation reference point. |
+| `circleTranslateAnchor` | `enum` | `circleTranslate` | `none` | Controls the frame of reference for `circleTranslate`. |
 | `circlePitchScale` | `enum` | `none` | `none` | Controls the scaling behavior of the circle when the map is pitched. |
+| `circlePitchAlignment` | `enum` | `none` | `none` | Orientation of circle when map is pitched. |
 | `circleStrokeWidth` | `number` | `none` | `none` | The width of the circle's stroke. Strokes are placed outside of the `circleRadius`. |
 | `circleStrokeColor` | `color` | `none` | `none` | The stroke color of the circle. |
 | `circleStrokeOpacity` | `number` | `none` | `none` | The opacity of the circle's stroke. |
diff --git a/docs/FillExtrusionLayer.md b/docs/FillExtrusionLayer.md
@@ -23,7 +23,7 @@
 | `fillExtrusionOpacity` | `number` | `none` | `none` | The opacity of the entire fill extrusion layer. This is rendered on a perLayer, not perFeature, basis, and dataDriven styling is not available. |
 | `fillExtrusionColor` | `color` | `none` | `fillExtrusionPattern` | The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fillExtrusionOpacity` to set layer opacity. |
 | `fillExtrusionTranslate` | `array` | `none` | `none` | The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up (on the flat plane), respectively. |
-| `fillExtrusionTranslateAnchor` | `enum` | `fillExtrusionTranslate` | `none` | Controls the translation reference point. |
+| `fillExtrusionTranslateAnchor` | `enum` | `fillExtrusionTranslate` | `none` | Controls the frame of reference for `fillExtrusionTranslate`. |
 | `fillExtrusionPattern` | `string` | `none` | `none` | Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). |
 | `fillExtrusionHeight` | `number` | `none` | `none` | The height with which to extrude this layer. |
 | `fillExtrusionBase` | `number` | `fillExtrusionHeight` | `none` | The height with which to extrude the base of this layer. Must be less than or equal to `fillExtrusionHeight`. |
diff --git a/docs/FillLayer.md b/docs/FillLayer.md
@@ -25,5 +25,5 @@
 | `fillColor` | `color` | `none` | `fillPattern` | The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used. |
 | `fillOutlineColor` | `color` | `none` | `fillPattern` | The outline color of the fill. Matches the value of `fillColor` if unspecified. |
 | `fillTranslate` | `array` | `none` | `none` | The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively. |
-| `fillTranslateAnchor` | `enum` | `fillTranslate` | `none` | Controls the translation reference point. |
+| `fillTranslateAnchor` | `enum` | `fillTranslate` | `none` | Controls the frame of reference for `fillTranslate`. |
 | `fillPattern` | `string` | `none` | `none` | Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). |
diff --git a/docs/LineLayer.md b/docs/LineLayer.md
@@ -27,7 +27,7 @@
 | `lineOpacity` | `number` | `none` | `none` | The opacity at which the line will be drawn. |
 | `lineColor` | `color` | `none` | `linePattern` | The color with which the line will be drawn. |
 | `lineTranslate` | `array` | `none` | `none` | The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively. |
-| `lineTranslateAnchor` | `enum` | `lineTranslate` | `none` | Controls the translation reference point. |
+| `lineTranslateAnchor` | `enum` | `lineTranslate` | `none` | Controls the frame of reference for `lineTranslate`. |
 | `lineWidth` | `number` | `none` | `none` | Stroke thickness. |
 | `lineGapWidth` | `number` | `none` | `none` | Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap. |
 | `lineOffset` | `number` | `none` | `none` | The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset. |

diff --git a/docs/SymbolLayer.md b/docs/SymbolLayer.md
@@ -29,14 +29,16 @@
 | `iconSize` | `number` | `iconImage` | `none` | Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `iconSize`. 1 is the original size; 3 triples the size of the image. |
 | `iconTextFit` | `enum` | `iconImage, textField` | `none` | Scales the icon to fit around the associated text. |
 | `iconTextFitPadding` | `array` | `iconImage, textField` | `none` | Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left. |
-| `iconImage` | `string` | `none` | `none` | Name of image in sprite to use for drawing an image background. A string with {tokens} replaced, referencing the data property to pull from. |
+| `iconImage` | `string` | `none` | `none` | Name of image in sprite to use for drawing an image background. A string with `{tokens}` replaced, referencing the data property to pull from. (`{token}` replacement is only supported for literal `iconImage` values; not for property functions.) |
 | `iconRotate` | `number` | `iconImage` | `none` | Rotates the icon clockwise. |
 | `iconPadding` | `number` | `iconImage` | `none` | Size of the additional area around the icon bounding box used for detecting symbol collisions. |
 | `iconKeepUpright` | `boolean` | `iconImage` | `none` | If true, the icon may be flipped to prevent it from being rendered upsideDown. |
 | `iconOffset` | `array` | `iconImage` | `none` | Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. When combined with `iconRotate` the offset will be as if the rotated direction was up. |
+| `iconAnchor` | `enum` | `iconImage` | `none` | Part of the icon placed closest to the anchor. |
+| `iconPitchAlignment` | `enum` | `iconImage` | `none` | Orientation of icon when map is pitched. |
 | `textPitchAlignment` | `enum` | `textField` | `none` | Orientation of text when map is pitched. |
 | `textRotationAlignment` | `enum` | `textField` | `none` | In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text. |
-| `textField` | `string` | `none` | `none` | Value to use for a text label. Feature properties are specified using tokens like {field_name}.  (Token replacement is only supported for literal `textField` valuesNot for property functions.) |
+| `textField` | `string` | `none` | `none` | Value to use for a text label. Feature properties are specified using tokens like `{field_name}`. (`{token}` replacement is only supported for literal `textField` values; not for property functions.) |
 | `textFont` | `array` | `textField` | `none` | Font stack to use for displaying text. |
 | `textSize` | `number` | `textField` | `none` | Font size. |
 | `textMaxWidth` | `number` | `textField` | `none` | The maximum line width for text wrapping. |
@@ -60,11 +62,11 @@
 | `iconHaloWidth` | `number` | `iconImage` | `none` | Distance of halo to the icon outline. |
 | `iconHaloBlur` | `number` | `iconImage` | `none` | Fade out the halo towards the outside. |
 | `iconTranslate` | `array` | `iconImage` | `none` | Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. |
-| `iconTranslateAnchor` | `enum` | `iconImage, iconTranslate` | `none` | Controls the translation reference point. |
+| `iconTranslateAnchor` | `enum` | `iconImage, iconTranslate` | `none` | Controls the frame of reference for `iconTranslate`. |
 | `textOpacity` | `number` | `textField` | `none` | The opacity at which the text will be drawn. |
 | `textColor` | `color` | `textField` | `none` | The color with which the text will be drawn. |
 | `textHaloColor` | `color` | `textField` | `none` | The color of the text's halo, which helps it stand out from backgrounds. |
 | `textHaloWidth` | `number` | `textField` | `none` | Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize. |
 | `textHaloBlur` | `number` | `textField` | `none` | The halo's fadeout distance towards the outside. |
 | `textTranslate` | `array` | `textField` | `none` | Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up. |
-| `textTranslateAnchor` | `enum` | `textField, textTranslate` | `none` | Controls the translation reference point. |
+| `textTranslateAnchor` | `enum` | `textField, textTranslate` | `none` | Controls the frame of reference for `textTranslate`. |
diff --git a/docs/docs.json b/docs/docs.json
@@ -288,7 +288,7 @@
       {
         "name": "circleTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `circleTranslate`.",
         "requires": [
           "circleTranslate"
         ],
@@ -301,6 +301,13 @@
         "requires": [],
         "disabledBy": []
       },
+      {
+        "name": "circlePitchAlignment",
+        "type": "enum",
+        "description": "Orientation of circle when map is pitched.",
+        "requires": [],
+        "disabledBy": []
+      },
       {
         "name": "circleStrokeWidth",
         "type": "number",
@@ -437,7 +444,7 @@
       {
         "name": "fillExtrusionTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `fillExtrusionTranslate`.",
         "requires": [
           "fillExtrusionTranslate"
         ],
@@ -597,7 +604,7 @@
       {
         "name": "fillTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `fillTranslate`.",
         "requires": [
           "fillTranslate"
         ],
@@ -800,7 +807,7 @@
       {
         "name": "lineTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `lineTranslate`.",
         "requires": [
           "lineTranslate"
         ],
@@ -1906,7 +1913,7 @@
       {
         "name": "iconImage",
         "type": "string",
-        "description": "Name of image in sprite to use for drawing an image background. A string with {tokens} replaced, referencing the data property to pull from.",
+        "description": "Name of image in sprite to use for drawing an image background. A string with `{tokens}` replaced, referencing the data property to pull from. (`{token}` replacement is only supported for literal `iconImage` values; not for property functions.)",
         "requires": [],
         "disabledBy": []
       },
@@ -1946,6 +1953,24 @@
         ],
         "disabledBy": []
       },
+      {
+        "name": "iconAnchor",
+        "type": "enum",
+        "description": "Part of the icon placed closest to the anchor.",
+        "requires": [
+          "iconImage"
+        ],
+        "disabledBy": []
+      },
+      {
+        "name": "iconPitchAlignment",
+        "type": "enum",
+        "description": "Orientation of icon when map is pitched.",
+        "requires": [
+          "iconImage"
+        ],
+        "disabledBy": []
+      },
       {
         "name": "textPitchAlignment",
         "type": "enum",
@@ -1967,7 +1992,7 @@
       {
         "name": "textField",
         "type": "string",
-        "description": "Value to use for a text label. Feature properties are specified using tokens like {field_name}.  (Token replacement is only supported for literal `textField` valuesNot for property functions.)",
+        "description": "Value to use for a text label. Feature properties are specified using tokens like `{field_name}`. (`{token}` replacement is only supported for literal `textField` values; not for property functions.)",
         "requires": [],
         "disabledBy": []
       },
@@ -2180,7 +2205,7 @@
       {
         "name": "iconTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `iconTranslate`.",
         "requires": [
           "iconImage",
           "iconTranslate"
@@ -2244,7 +2269,7 @@
       {
         "name": "textTranslateAnchor",
         "type": "enum",
-        "description": "Controls the translation reference point.",
+        "description": "Controls the frame of reference for `textTranslate`.",
         "requires": [
           "textField",
           "textTranslate"