<%= name %>
<% if (prop.function == "interpolated" ) { %>
<% } %>
<% if (prop.function == "piecewise-constant" ) { %>
<% } %>
<% if (prop.transition) { %>
<% } %>
<%= prop.required ? 'Required' : 'Optional' %>
<% if (prop.type && prop.type !== '*') { %><%= prop.type %>.<% } %>
<% if (prop.values && Array.isArray(prop.values) === false) { // skips $root.version %>
One of <%= _(Object.keys(prop.values)).map(function(opt) { return '' + opt + '' }).join(', ') %>.
<% } %>
<% if (prop.units) { %>
Units in
<% if (typeof prop.units === 'object') { %>
<%= _(prop.units).map(function(opt) { return '' + opt + '' }).join(', ') %>.
<% } else { %>
<%= prop.units %>.
<% } %>
<% } %>
<% if (prop.default || prop.default === false || prop.default === 0) { %>
Defaults to <%= prop.default %>.
<% } %>
<% if (prop.requires) { %>
<%= _(prop.requires).map(function(req) {
if (typeof req === 'string') {
return 'Requires ' + req + '.';
} else {
if (req['!']) {
return 'Disabled by ' + req['!'] + '.';
} else if (req['<=']) {
return 'Must be less than or equal to ' + req['<='] + '.';
} else {
var requiredValue = _.toPairs(req)[0][1];
var requiredDisplay = _.isArray(requiredValue)
? 'one of ' + requiredValue.join(', ')
: requiredValue;
return 'Requires ' + _.toPairs(req)[0][0] + ' = ' + requiredDisplay + '.';
}
}
}).join(' ') %>
<% } %>
<% if (prop.doc) { %>
<%= md(prop.doc) %>
<% } %>
<% if (prop.values && Array.isArray(prop.values) === false) { // skips $root.version %>
<% for (var v in prop.values) { %>
- <%= v %>
- <%= md(prop.values[v].doc) %>
<% } %>
{% highlight json %}
<%= '"' + name + '": ' + JSON.stringify(prop.example, null, 2) %>
{% endhighlight %}
<% } %>
<% if (prop['sdk-support']) {
var support = function(type, sdk) {
var support = prop['sdk-support'][type];
if (!support) return 'Not yet supported';
support = support[sdk];
if (support === undefined) return 'Not yet supported';
return '>= ' + support;
}
%>
| SDK Support |
Mapbox GL JS |
iOS SDK |
Android SDK |
<% _.each(Object.keys(prop['sdk-support']), function(key) { %>
| <%= md(key) %> |
<%- support(key, 'js') %> |
<%- support(key, 'ios') %> |
<%- support(key, 'android') %> |
<% }); %>
<% } %>