Creates a new KML Layer that can visualize KML Models in a LuciadRIA Map.
A model containing KML data.
The options for this layer. If no painter is set in these options, the KML will use a custom built-in painter to paint KML features, adhering to the style information in the KML file.
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.
value to use as this when executing callback
The content provider that may be used when Map.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 Map.showBalloon for information on how to style the balloon.
The content provider that may be used when Map.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 Map.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.
The target on which KML draped content will be draped. By default, this is the terrain.
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.
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 KML layer is hoverable.
If thehoverable state is not set explicitly by the user then
the state is deduced from the underlying KML data, making the layer hoverable
only when the KML data defines a different style for the normal and the highlight state.
Determines whether the KML layer is hoverable.
If thehoverable state is not set explicitly by the user then
the state is deduced from the underlying KML data, making the layer hoverable
only when the KML data defines a different style for the normal and the highlight state.
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 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 Store implement the spatialQuery method.
The map this note is attached to, or null. This property
will be null if this node is not attached to a map.
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 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.
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.
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.
The scale range of this layer. The scale range is an object with a 'min' and 'max' property.
Determines whether the layer is selectable.
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.
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.
The model transformer for this layer. Set a ClusteringTransformer if you want to enable clustering, or null when clustering should be disabled.
The model transformer for this layer. Set a ClusteringTransformer if you want to enable clustering, or null when clustering should be disabled.
The LayerTreeNodeType of this layer. The value is LayerTreeNodeType.LAYER.
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 LayerTreeNode.visibleInTree instead.
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 LayerTreeNode.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.
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
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
Returns the area of the map that is currently visible, expressed in model coordinates.
the visible bounds in model coordinates or null if nothing is visible
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 BODY of a layer and not the 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
A KML Layer that can visualize KML Models in a LuciadRIA Map.
A KML Layer is a layer that is capable of visualizing OGC KML 2.3 Models.
Currently, only Placemark features are visualized, that contain any of the following geometry:
If selection is enabled on the layer, you can select a feature to have it generate a balloon. Note that balloons are only generated if the feature contains a description. The balloon can have static HTML content.
In 3D maps, shapes are draped when the
altitudeModeproperty for the geometry in the KML file equals "clampToGround" or "relativeToGround". The drapeTarget determines the target of the draped KML content, TERRAIN (default) or MESH.In order for a feature to be visible, the
visibilityelement in KML data must be set to 1. You can control visibility of loaded KML features by changing the KMLFeatureProperties.visibility property.Limitations: