Class: Decorating maps.nyc.gov

nyc.ol.source.Decorating

new Decorating(options, decorationMixins, autoLoadopt)

Class that extends ol.source.GeoJSON for providing features decorated by an array of mixin objects
Parameters:
Name Type Attributes Description
options Object Vector source options
decorationMixins Array.<Object> An array of objects whose members will be added to all features created by this source
autoLoad nyc.ol.source.Decorating.AutoLoad <optional>
Object including auto loading properties
Source:
See:
Fires:

Extends

  • ol.source.Vector

Members

(static, constant) AUTO_EXEC :string

Mixin function name to execute immediately after decorating the feature
Type:
  • string
Source:

(static) LoaderEventType :string

Enumeration for feature loading event type
Type:
  • string
Properties:
Name Type Description
FEATURESLOADED string The features loaded event type
FEATURELOADERROR string The feature load error event type
Source:

Methods

isXhrFeaturesLoaded() → {boolean}

Has the request for geoJSON data completed successfully
Source:
Returns:
The value indicating if the XHR request has successfully loaded the geoJSON data
Type
boolean

Type Definitions

AutoLoad

Object type to hold the projection for auto loading of features
Type:
  • Object
Properties:
Name Type Description
projection ol.proj.ProjectionLike The projection of the map view in which the features of this source will be rendered
Source:

Events

change:featureloaderror

The feature load error event
Type:
  • boolean
Source:

change:featuresloaded

The features loaded event
Type:
  • boolean
Source: