Javascript API 7.x

Namespace: source

bu. source

This namespace contains definitions of objects that extend the functionality of the OpenLayers ol.source namespace.

Source:
bu/source/source.jsdoc

Classes

Cesium3DTileset
LiDARCesium3DTileset
LiDARProjects
Panoramas
Proxy
TileDebug
Vector
WFS

Type Definitions

Cesium3DTilesetOptions

Type:
  • Object
Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
logo string | olx.LogoOptions | undefined

The logo for the source.
pointCloudShading Cesium.PointCloudShading | undefined

The options for performing point attenuation based on geometric error when rendering point clouds using 3D Tiles.
projection ol.ProjectionLike

The projection for the source.
state ol.source.State | undefined

The state of the source, see ol.source.State for possible states.
url string | Cesium.Resource | undefined

The url to a tileset.json file or to a directory containing a tileset.json file.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
Source:
bu/typedefs.js

LiDARCesium3DTilesetOptions

Type:
  • Object
Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
logo string | olx.LogoOptions | undefined

The logo for the source.
pointCloudShading Cesium.PointCloudShading | undefined

The options for performing point attenuation based on geometric error when rendering point clouds using 3D Tiles.
projection ol.ProjectionLike

The projection for the source.
state ol.source.State | undefined

The state of the source, see ol.source.State for possible states.
url string | Cesium.Resource | undefined

The url to a tileset.json file or to a directory containing a tileset.json file.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
project bu.LiDARProjectMetadata | undefined

The LiDAR project metadata.
Source:
bu/typedefs.js

LocalFileProperties

Type:
  • Object
Properties:
Name Type Description
file File | undefined

The File object.
logo string | olx.LogoOptions | undefined

Logo.
Source:
bu/typedefs.js

RemoteFileProperties

Type:
  • Object
Properties:
Name Type Description
url string | undefined

The URL to the remote resource file.
Source:
bu/typedefs.js

SourceDefinition

Type:
  • Object
Properties:
Name Type Description
type bu.source.SourceType | undefined

Type of the source.
properties bu.source.LocalFileProperties | bu.source.RemoteFileProperties | bu.source.WebServiceProperties | undefined

Source properties.
Source:
bu/typedefs.js

SourceType

Types of sources.


LOCALFILE: 'localfile' // Source type is a local file.
REMOTEFILE: 'remotefile' // Source type is a remote file.
WEBSERVICE: 'webservice' // Source type is a web service, like WMS, WMTS, WFS or other.
Type:
  • string
Source:
bu/enums.js

TileDebugOptions

Type:
  • Object
Properties:
Name Type Description
projection ol.ProjectionLike

Projection for the source.
tileGrid ol.tilegrid.TileGrid | undefined

TileGrid object.
wrapX boolean | undefined

If repeat the source in X direction.
color string | undefined

Color for the tiles.
Source:
bu/typedefs.js

VectorEventType

Event types that extend the current events of a ol.source.Vector.


FEATURESLOADED: 'featuresloaded' // The features has been loaded or a failure
// has happened
Type:
  • string
Source:
bu/enums.js

VectorOptions

Type:
  • Object
Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
features Array.<ol.Feature> | ol.Collection.<ol.Feature> | undefined

Features. If provided as ol.Collection, the features in the source and the collection will stay in sync.
format ol.format.Feature | undefined

The feature format used by the XHR feature loader when url is set. Required if url is set, otherwise ignored. Default is undefined.
loader ol.FeatureLoader | undefined

The loader function used to load features, from a remote source for example. If this is not set and url is set, the source will create and use an XHR feature loader.
logo string | olx.LogoOptions | undefined

Logo.
overlaps boolean | undefined

This source may have overlapping geometries. Default is true. Setting this to false (e.g. for sources with polygons that represent administrative boundaries or TopoJSON sources) allows the renderer to optimise fill and stroke operations.
strategy ol.LoadingStrategy | undefined

The loading strategy to use. By default an ol.loadingstrategy.all strategy is used, a one-off strategy which loads all features at once.
url string | ol.FeatureUrlFunction | undefined

Setting this option instructs the source to load features using an XHR loader (see ol.featureloader.xhr). Use a string and an ol.loadingstrategy.all for a one-off download of all features from the given URL. Use a ol.FeatureUrlFunction to generate the url with other loading strategies. Requires format to be set as well. When default XHR feature loader is provided, the features will be transformed from the data projection to the view projection during parsing. If your remote data source does not advertise its projection properly, this transformation will be incorrect. For some formats, the default projection (usually EPSG:4326) can be overridden by setting the defaultDataProjection constructor option on the format. Note that if a source contains non-feature data, such as a GeoJSON geometry or a KML NetworkLink, these will be ignored. Use a custom loader to load these.
useSpatialIndex boolean | undefined

By default, an RTree is used as spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance. Note that ol.source.Vector#getFeaturesInExtent, ol.source.Vector#getClosestFeatureToCoordinate and ol.source.Vector#getExtent cannot be used when useSpatialIndex is set to false, and ol.source.Vector#forEachFeatureInExtent will loop through all features. When set to false, the features will be maintained in an ol.Collection, which can be retrieved through ol.source.Vector#getFeaturesCollection. The default is true.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
name string | undefined

Name for the source.
sourceProxyID string

Unique ID of this source in the bu.SourceProxy singleton.
localFileFormat string

Format of the local file that generated this source.
featuresProjection ol.proj.Projection | undefined

Projection of the incoming features.
geometryLayout ol.geom.GeometryLayout

Geometry layout for the source. We asume that all the geometries share the same geometry layout.
showLabels boolean

If show the labels of the features or not. By default is true.
Source:
bu/typedefs.js

WebServiceProperties

Type:
  • Object
Properties:
Name Type Description
url string | undefined

URL of the web service.
Source:
bu/typedefs.js

WFSOptions

Options for a bu.source.Panoramas.

Type:
  • Object
Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
features Array.<ol.Feature> | ol.Collection.<ol.Feature> | undefined

Features. If provided as ol.Collection, the features in the source and the collection will stay in sync.
format ol.format.Feature | undefined

The feature format used by the XHR feature loader when url is set. Required if url is set, otherwise ignored. Default is undefined.
logo string | olx.LogoOptions | undefined

Logo.
overlaps boolean | undefined

This source may have overlapping geometries. Default is true. Setting this to false (e.g. for sources with polygons that represent administrative boundaries or TopoJSON sources) allows the renderer to optimise fill and stroke operations.
strategy ol.LoadingStrategy | undefined

The loading strategy to use. By default an ol.loadingstrategy.all strategy is used, a one-off strategy which loads all features at once.
useSpatialIndex boolean | undefined

By default, an RTree is used as spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance. Note that ol.source.Vector#getFeaturesInExtent, ol.source.Vector#getClosestFeatureToCoordinate and ol.source.Vector#getExtent cannot be used when useSpatialIndex is set to false, and ol.source.Vector#forEachFeatureInExtent will loop through all features. When set to false, the features will be maintained in an ol.Collection, which can be retrieved through ol.source.Vector#getFeaturesCollection. The default is true.
wrapX boolean | undefined

Wrap the world horizontally. Default is true. For vector editing across the -180° and 180° meridians to work properly, this should be set to false. The resulting geometry coordinates will then exceed the world bounds.
featureTypeResolutions Array.<bu.FeatureTypeResolution>

An array defining wha feature types will be visibles at certain resolutions.
urlFunction string | ol.FeatureUrlFunction

The string or function that will be used to create a ol.FeatureLoader. Notice that the loader option present in olx.source.VectorOptions is not more available here.
urlFunctionAll string | ol.FeatureUrlFunction

The string or function that will be used to create a ol.FeatureLoader to load all features types on each request.
loadAll boolean

If true then only the urlFunctionAll will be used and to load features the loadAllFeatures method must be used. If false then urlFunction will be used and the source will behave as a normal ol.source.Vector.
Source:
bu/typedefs.js