Creates a FeatureLayer that displays the data represented by a given FeatureModel. A number of parameters and flags can be set at construction time, such as amongst others the FeaturePainter, LoadingStrategy, whether the layer is visible and/or selectable, etc.
the feature model to visualize
Optional options: FeatureLayerConstructorOptionsan object hash containing layer parameters
The isSnapTarget is a boolean value that determines whether or not the object should be considered
as a snap target.
The content provider that may be used when showBalloon is called on the map. The content provider is a function that takes a single parameter and returns the contents for the balloon. The parameter is the object for which the balloon is shown, which is typically a Feature. The return value of the function can be a string or a DOM-node.
See showBalloon for information on how to style the balloon.
The content provider that may be used when showBalloon is called on the map. The content provider is a function that takes a single parameter and returns the contents for the balloon. The parameter is the object for which the balloon is shown, which is typically a Feature. The return value of the function can be a string or a DOM-node.
See showBalloon for information on how to style the balloon.
The bounds of the layer (read-only). This is the bounds of all the objects that are currently in this layer's workingSet. The return value is undefined when no objects are shown.
Note that this bounds includes all features that are currently in the working set. If there is a FeatureLayer.filter on the layer, this means that the bounds may be bigger than what is actually visible on the screen.
In order to get the bounds that applies only to the features that pass the filter, you can use the below utility function.
function calculateFilteredBounds(layer) {
var boundsArray = layer.workingSet.get()
.filter(layer.filter)
.map(function(feature) { return feature.shape.bounds; });
if (boundsArray.length !== 0) {
return boundsArray.reduce(function(previousValue, currentValue) {
previousValue.setTo2DUnion(currentValue);
return previousValue;
}, boundsArray[0].copy());
} else {
return;
}
}
The list of direct children of the node. The children are ordered according to the painting order (the bottom layer is the first element in the array). Note that also the nodes that are not visible will be included.
Denotes whether the layer can be edited
Get or set the layer's filter function. This is a predicate function, a plain javascript function which
must return either true or false. The argument of this function is a
Feature contained in the workingSet.
If the feature does not pass the test of the filter function, the feature will not be visualized on the map. Selected objects which do not pass the filter will be deselected.
Even though features may fail the filter-test, they still remain present in the layer's workingSet. To exclude features from the workingSet, use model-based filtering.
For performance reasons, the result of the function is cached. This means that the filter function must be idempotent: for identical input, the function must return the same boolean value. In practice, this means that the function should not depend on mutable global state. If there is a state-change during the runtime of the application which requires that the filter function must be re-evaluated, simply reset the filter on the layer.
Note that you can also use OGCConditions as a filter. In order to do so, first convert the
condition to a function with FilterFactory.toFeaturePredicate.
Determines whether the layer is hoverable (i.e. detects a cursor hovering over features).
This flagged is used by the HoverController. If you want to enable hovering, also make sure this controller is being used. This controller is part of the default LuciadRIA map behavior.
Determines whether the layer is hoverable (i.e. detects a cursor hovering over features).
2021.0
The node's ID (immutable). This ID was configured at construction time and is unique over the whole layer tree. If no ID was given, a UUID will have been generated automatically.
The node's label. This label was configured at construction time. If no label was given, the label will correspond to the layer's ID.
The LoadingStrategy used by this layer. This property can only be set through the constructor option.
If a loading strategy is not explicitly configured, a one will be selected automatically: if the FeatureLayer's FeatureModel supports spatial querying, the LoadSpatially loading strategy will be used. if not, the LoadEverything data loading strategy will be used. A FeatureModel supports spatial querying if its spatialQuery method.
2015.0
The model of this layer, immutable.
The painter used to paint the objects in the layer. The property is both readable and writable.
If assigning to this property, the new value must have luciad.view.feature.FeaturePainter
in its prototype chain.
The model used to retrieve panoramic images for GeoCanvas.drawPanorama calls. Note that this is set once at construction time, and cannot be changed afterwards.
2020.1
The parent of this node or null. This property
will be null if this node has not been added as the child of another
node yet.
The query used by this Layer. The query object is passed on to the 'query(...)' method of the model of this layer when retrieving the data to be painted. When setting this property, the FeatureLayer will automatically requery the model.
Use a QueryProvider instead of using the
query property.
Use a QueryProvider to configure the query parameters
that must be sent to the FeatureModel instead of using the
query property.
The simplest way to upgrade existing code to the QueryProvider approach is creating a LoadEverything data loading loading strategy that is configured with the value of the query property. See the code example.
For additional information on loading strategies and Query Providers, please refer to the LuciadRIA developer guide.
var myLoadingStrategy = new LoadEverything({
query: {
type:"human",
firstname:"John"
}
});
Determines whether the layer is selectable.
The shape provider used by this layer. A ShapeProvider maps a model object to a shape.
This shape is the geometry which is visualized by the layer.
It does not necessarily have to be the same as the .shape property of a Feature.
Both gettable and settable.
Denotes what PaintRepresentations are available for this layer. This usually depends on the type of layer or the painter configuration on the layer
The model transformer for this layer. Set a ClusteringTransformer if you want to enable clustering, or null when clustering should be disabled.
Denotes whether the node is visible. This can be considered to be the master visibility switch: Setting this to false makes the layer entirely invisible. If it is true, the visible paint representations will be visible.
This property does not reflect whether this node's parent is visible as well, If this is desired, use visibleInTree instead.
Denotes whether this layer is visible on the map. This method will only return true if this layer and every parent layer up to the root of the layer tree is visible.
If visibleInTree is set to true, this will ensure that every parent LayerTreeNode up to the of the tree is configured to be visible as well.
The working set of this layer (read-only). A working set represents the objects which are being visualized by
the FeatureLayer. This may be a subset of the objects which are contained within the
FeatureModel of the FeatureLayer. This will be the case when the Store (either client side, or on
the server) has applied a filter on the results, based on the query-parameter. This may also be the case when
the FeatureLayer has not yet completed processing all objects or completed processing all model updates.
Returns the layer with the given ID if that layer is this node or one of its children. Note that the layer's ID does not correspond with the layer's label.
The id of the layer that you want to retrieve.
the requested layer or undefined if it is not present in the tree
Returns the layer group with the given ID if that layer is this node or one of its children.
The id of the layer group that you want to retrieve.
the requested layer group or undefined if it is not present in the tree
2014.0
Returns the layer tree node with the given ID if that layer is this node or one of its children. This may be a layer-group or a layer.
The id of the layerTreeNode that you want to retrieve.
the requested layerTreeNode or undefined if it is not present in the tree
2014.0
Determines if the given paint representation is supported by this layer.
a paint representation
true if the paint representation is supported; false otherwise
Indicates whether the specified paint representation is visible.
The paint representation
true when paintRepresentation is supported
and visible, false otherwise
Indicates whether the specified paint representation is visible on the map. This method will only return true if this paint representation is visible for this layer and every parent layer up to the layer tree.
The paint representation
true when paintRepresentation is supported
and visible, false otherwise
Called when the map has detected a single click on an object that is contained by this layer. This method
can be overridden to take action when the click is detected. The default implementation of this method
simply returns false.
the object that was clicked on
true to indicate that the click was handled and default behavior should not occur; false otherwise
Called when the map is going to display a context menu for an object that is contained by this layer. This method can be overridden to populate the given context menu with additional items.
The context menu to populate
The map that is about to show a context menu
The object that was passed to the map when requesting the context menu. The context menu info object. This object may contain arbitrary data. The default implementation expects a pickInfo object which will be passed to the appropriate Layer's onCreateContextMenu method. A pickInfo object is JavaScript object with two properties: the objects that were touched (an array of Features) and the layer that object resides in.
Sets the visibility of a specific paint representation. This allows for example to only show the PaintRepresentation.BODY of a layer and not the PaintRepresentation.LABEL:
var layer = ...;
layer.setPaintRepresentationVisible( PaintRepresentation.BODY, true );
layer.setPaintRepresentationVisible( PaintRepresentation.LABEL, false );
The renderer-type of the layer. Must be one of the supported paint representations.
the new visible state of the paint representation
Sets the visibility of a specific paint representation in a layer tree. If it set to true, this will ensure that the paint representation of every parent LayerTreeNode up to the roof of the tree is configured to be visible as well.
The renderer-type of the layer. Must be one of the supported paint representations.
the new visible state of the paint representation
Accepts the given visitor on the children of this.
The visitor which will receive the callbacks for the children.
The order in which the children need to be traversed.
Wait until this layer or layer group is finished with all possible work related to any change that happened before this call.
At that moment, the screen is up-to-date with all changes.
map.mapNavigator.fit({ bounds: somewhere });
map.layerTree.whenReady().then(makeScreenshot);
or
layer.painter.invalidateAll();
layer.whenReady().then(alert);
or
layer.model.add(newFeature);
layer.whenReady().then(alert);
A promise that resolves to the LayerTreeNode when all current work is done
Registers a callback function for a given event type.
the event type to register on
the callback function to register
Rest ...args: any[]Optional context: anythe context in which the callback function should be invoked implementation dependent.
a handle to the registered callback with a single function 'remove'. This function can be used to unregister the callback function.
Event fired when the editability of the layer changes.
the 'EditableChanged' changed event.
the callback to be invoked when the editability of the layer changes. The callback gets the 'editable' boolean parameter, which indicates whether or not the layer is editable.
Optional context: anyvalue to use as this when executing callback
A feature layer displays a collection of Features (Feature) in the Map. Rendering of features is controlled via a FeaturePainter object.