Class: MapboxUtil

MapboxUtil

Utilities from mapbox or implementations of mapbox specifications. It is static and should not be initiated.

Static Methods

  • (static) exports.createFilter(filter) [source]

  • Given a filter expressed as nested arrays, return a new function that evaluates whether a given feature (with a .properties or .tags property) passes its test.
    Parameter Type Description
    filter Array mapbox gl filter
    Returns:
    function: filter-evaluating function
  • (static) exports.getFilterFeature(geometry) [source]

  • Get feature object from a geometry for filter functions.
    Parameter Type Description
    geometry Geometry geometry
    Returns:
    Object: feature for filter functions
  • (static) exports.compileStyle(styles) [source]

  • Compile layer's style, styles to symbolize layer's geometries, e.g.
    [
      {
        'filter' : ['==', 'foo', 'val'],
        'symbol' : {'markerFile':'foo.png'}
      }
    ]
    
    Parameter Type Description
    styles Object | Array.<Object> style to compile
    Returns:
    Array.<Object>: compiled styles
  • (static) exports.isFunctionDefinition(obj) [source]

  • Check if object is a definition of function type
    Parameter Type Description
    obj Object object
    Returns:
    Boolean:
  • (static) exports.loadFunctionTypes(parameters) [source]

  • Load function types defined in object
    Parameter Type Description
    parameters Array.<Object> parameters
    Returns:
    Object: loaded object
  • (static) exports.getFunctionTypeResources(t) [source]

  • Get external resources in the function type
    Parameter Type Description
    t Object Function type definition
    Returns:
    Array.<String>: resouces