Skip to content

Commit

Permalink
Use GH markdown in MapStyleEditorDocumentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matteblair committed Dec 7, 2017
1 parent 8792e05 commit 2296dbf
Showing 1 changed file with 36 additions and 43 deletions.
79 changes: 36 additions & 43 deletions MapStyleEditorDocumentation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
MAP STYLE EDITOR
Map Style Editor
================

You can edit and save the settings for your map in an asset called a Map Style. To create a new Map Style, go to the 'Assets' menu and choose 'Create' -> 'Mapzen' -> 'MapStyle'. To edit the Map Style, select it from the project window and then use the inspector window to view and change settings.

LAYER LIST
Layer List
----------

The first item in the Map Style editor is a list of "Layers". Each Layer in a Map Style represents a grouping of objects in the map data (these objects are called features) and the settings that will be applied to those objects when they are downloaded.
Expand All @@ -12,71 +12,64 @@ You can add a new layer with the 'Add Layer' button and remove one or more layer

Layers can be renamed in the list by selecting one and pressing Enter. It's often helpful to name Layers according to the grouping of features that you intend to include in the Layer. For example, if you wanted a Layer to style buildings of a certain height you could name the layer "Tall Buildings".

LAYER PROPERTIES
Layer Properties
----------------

When a layer is selected its properties will be displayed below the list.

FEATURE COLLECTIONS
### Feature Collections

Features in the map data are organized into broad groupings called "feature collections". Use this drop-down to select which feature collection(s) this Layer will apply to.

MATCHERS
### Matchers

To narrow down the set of features that this Layer will apply to, you can add one or more Matchers in the form of a list.

Each item in the list is a separate Matcher, which can be one of several types selectable from the drop-down.

The 'None' type Matcher simply matches all features.
Type | Description
-----|------------
None | Matches all features.
Property | Matches features that contain the property named in 'Property Key', regardless of the value of that property.
Property Range | Matches features have the property named in 'Property Key' with a value >= and < the two range parameters.
Property Regex | Matches features have the property named in 'Property Key' with a value that matches the regular expression in the 'With Pattern' parameter.
Property Value | Matches features have the property named in 'Property Key' with a value equal to the 'With Value' parameter.

The 'Property' type Matcher has a 'Property Key' parameter. It matches features that contain the property named in 'Property Key', regardless of the value of that property.

The 'Property Range' type Matcher has 'Property Key', '>=', and '<' parameters. It matches features have the property named in 'Property Key' with a value >= and < the two range parameters.

The 'Property Regex' type Matcher has 'Property Key' and 'With Pattern' parameters. It matches features have the property named in 'Property Key' with a value that matches the regular expression in the 'With Pattern' parameter.

The 'Property Value' type Matcher has 'Property Key' and 'With Value' parameters. It matches features have the property named in 'Property Key' with a value equal to the 'With Value' parameter.

COMBINE MATCHERS
### Combine Matchers

If you have more than one Matcher in the Matchers list, they can be logically combined with one of several options.

'All Of' will make the Layer apply to features that match all of the Matchers in the list.
Option | The Layer will apply to features that ...
-------|------------------------------------------
All Of | match all of the Matchers in the list
Any Of | match any of the Matchers in the list
None Of | match any of the Matchers in the list

'Any Of' will make the Layer apply to features that match any of the Matchers in the list.

'None Of' will make the Layer apply to features that don't match any of the Matchers in the list.

STYLE
### Style

Each of the features in this Layer will be turned into renderable meshes using the builders enabled in the Style section.

POLYGON BUILDER
### Polygon Builder

The Polygon Builder will create flat or extruded polygons from features that include polygon geometry.

'Material' is the material that will be applied to the polygon mesh.

'Extrusion' determines how the polygon will be extruded. 'Top Only' produces only a flat polygon. 'Sides Only' produces vertical faces along each segment of the polygon. 'Top And Sides' produces vertical faces with a flat polygon on top.

'UV Mode' determines how UV coordinates will be placed on the mesh. 'Stretch' will generate UV coordinates that span 0 to 1 across each mesh face. 'Tile' will generate UV coordinates distributed uniformly in world space, possibly outside the 0 to 1 range. 'Stretch U Tile V' and 'Tile U Stretch V' apply these two options separately to the U and V coordinates.
Field | Description
------|------------
Material | The material that will be applied to the polygon mesh.
Extrusion | Determines how the polygon will be extruded. 'Top Only' produces only a flat polygon. 'Sides Only' produces vertical faces along each segment of the polygon. 'Top And Sides' produces vertical faces with a flat polygon on top.
UV Mode | Determines how UV coordinates will be placed on the mesh. 'Stretch' will generate UV coordinates that span 0 to 1 across each mesh face. 'Tile' will generate UV coordinates distributed uniformly in world space, possibly outside the 0 to 1 range. 'Stretch U Tile V' and 'Tile U Stretch V' apply these two options separately to the U and V coordinates.
Min Height | The height of the bottom of an extruded polygon in meters. If this is left as 0, the "min_height" property of the feature will be used.
Max Height | The height of the top of an extruded polygon in meters. If this is left as 0, the "max_height" property of the feature will be used.

'Min Height' is the height of the bottom of an extruded polygon in meters. If this is left as 0, the "min_height" property of the feature will be used.

'Max Height' is the height of the top of an extruded polygon in meters. If this is left as 0, the "max_height" property of the feature will be used.

POLYLINE BUILDER
### Polyline Builder

The Polyline Builder will create flat or extruded polylines from features that include either polyline geometry or polygon geometry.

'Material' is the material that will be applied to the polyline mesh.

'Extrusion' determines how the polyline will be extruded. 'Top Only' produces only a flat polyline. 'Sides Only' produces vertical faces along each segment of the polyline. 'Top And Sides' produces vertical faces with a flat polyline on top.

'Min Height' is the height of the bottom of an extruded polyline in meters.

'Max Height' is the height of the top of an extruded polygon in meters.

'Width' is the width of the polyline in meters.

'Miter Limit' sets a maximum length for the corners of polylines with tight bends.
Field | Description
------|------------
Material | The material that will be applied to the polyline mesh.
Extrusion | Determines how the polyline will be extruded. 'Top Only' produces only a flat polyline. 'Sides Only' produces vertical faces along each segment of the polyline. 'Top And Sides' produces vertical faces with a flat polyline on top.
Min Height | The height of the bottom of an extruded polyline in meters.
Max Height | The height of the top of an extruded polygon in meters.
Width | The width of the polyline in meters.
Miter Limit | Sets a maximum length for the corners of polylines with tight bends.

0 comments on commit 2296dbf

Please sign in to comment.