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.

Only placemark features are visualized, that contain any of the following geometry:

  • Points
  • LineString
  • LinearRing
  • Polygon
  • MultiGeometry
  • Models are converted to Points

The layer's default painter draws placemark features taking into account KML styles that are encoded into placemark features. You can use a custom painter that extends from KMLPainter to implement a custom rendering logic of placemark features

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 order for a feature to be visible, the visibility element in KML data must be set to 1. You can control visibility of loaded KML features by changing the KMLFeatureProperties.visibility property.

Limitations:

  • Level-of-Detail elements (i.e. Region), and other view-based attributes, are not used for painting.

Hierarchy (view full)

Constructors

  • Creates a new KML Layer that can visualize KML Models in a LuciadRIA Map.

    Parameters

    • kmlModel: FeatureModel

      A model containing KML data.

    • Optional options: KMLLayerConstructorOptions

      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.

    Returns KMLLayer

Properties

isSnapTarget: boolean

The isSnapTarget is a boolean value that determines whether or not the object should be considered as a snap target.

Accessors

  • get balloonContentProvider(): ((obj) => string | HTMLElement)
  • 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.

    Returns ((obj) => string | HTMLElement)

  • set balloonContentProvider(balloonContentProvider): void
  • Parameters

    Returns void

  • get bounds(): undefined | Bounds
  • 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;
    }
    }

    Returns undefined | Bounds

  • get children(): LayerTreeNode[]
  • 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.

    Returns LayerTreeNode[]

  • get drapeTarget(): DrapeTarget
  • Specifies the surface onto which KML placemarks will be rendered (the drape target). Here are some rules to be aware of when a KML placemark uses a drape target on 3D maps:

    • Shapes will be draped onto the surface specified by `KMLLayer.drapeTarget` if the geometry's `altitudeMode` in the KML file is either:
      • `clampToGround`
      • `relativeToGround`, with all z-coordinates of the shape set to zero.
    • Otherwise, shapes are not draped.

    The style of a placemark with a drape target can be customized using the style objects returned by KMLPainter.getPlacemarkShapeStyle or KMLPainter.getPlacemarkIconStyle.

    Note: Draping does not apply to extruded shapes.

    By default, this is DrapeTarget.TERRAIN.

    Returns DrapeTarget

    Since

    2022.1

  • set drapeTarget(target): void
  • Parameters

    Returns void

  • get editable(): boolean
  • Denotes whether the layer can be edited

    Returns boolean

  • set editable(editable): void
  • Parameters

    • editable: boolean

    Returns void

  • get filter(): null | FilterPredicateType
  • 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.

    Returns null | FilterPredicateType

  • set filter(filter): void
  • Parameters

    Returns void

  • get hoverable(): boolean
  • Determines whether the KML layer is hoverable.

    If the hoverable 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.

    Returns boolean

  • set hoverable(enabled): void
  • Determines whether the layer is hoverable (i.e. detects a cursor hovering over features).

    Parameters

    • enabled: boolean

    Returns void

    Since

    2021.0

  • get id(): string
  • 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.

    Returns string

  • get label(): string
  • 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.

    Returns string

  • set label(value): void
  • Parameters

    • value: string

    Returns void

  • get loadingStrategy(): LoadingStrategy
  • 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.

    Returns LoadingStrategy

    Since

    2015.0

  • get map(): null | Map
  • The map this note is attached to, or null. This property will be null if this node is not attached to a map.

    Returns null | Map

  • get painter(): FeaturePainter
  • 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.

    Returns FeaturePainter

  • set painter(painter): void
  • Parameters

    Returns void

  • get panoramaModel(): null | PanoramaModel
  • 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.

    Returns null | PanoramaModel

    Since

    2020.1

  • get parent(): null | LayerGroup
  • 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.

    Returns null | LayerGroup

  • get query(): any
  • 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.

    Returns any

    Deprecated

    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"
    }
    });
  • set query(query): void
  • Parameters

    • query: any

    Returns void

  • get scaleRange(): Interval
  • The scale range of this layer.

    Returns Interval

  • get selectable(): boolean
  • Determines whether the layer is selectable.

    Returns boolean

  • set selectable(selectable): void
  • Parameters

    • selectable: boolean

    Returns void

  • get shapeProvider(): ShapeProvider
  • 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.

    Returns ShapeProvider

  • set shapeProvider(shapeProvider): void
  • Parameters

    Returns void

  • get supportedPaintRepresentations(): PaintRepresentation[]
  • Denotes what PaintRepresentations are available for this layer. This usually depends on the type of layer or the painter configuration on the layer

    Returns PaintRepresentation[]

  • get type(): LayerType
  • The LayerType of this layer. The layer type is used by the Map to optimize rendering. It is an optional parameter of the layer constructor.

    Returns LayerType

  • get visible(): boolean
  • 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.

    Returns boolean

  • set visible(visible): void
  • Parameters

    • visible: boolean

    Returns void

  • get visibleInTree(): boolean
  • 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.

    Returns boolean

  • set visibleInTree(value): void
  • Parameters

    • value: boolean

    Returns void

  • get workingSet(): WorkingSet
  • 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 WorkingSet

Methods

  • 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.

    Parameters

    • id: string

      The id of the layer that you want to retrieve.

    Returns Layer

    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.

    Parameters

    • id: string

      The id of the layer group that you want to retrieve.

    Returns LayerGroup

    the requested layer group or undefined if it is not present in the tree

    Since

    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.

    Parameters

    • id: string

      The id of the layerTreeNode that you want to retrieve.

    Returns LayerTreeNode

    the requested layerTreeNode or undefined if it is not present in the tree

    Since

    2014.0

  • Returns the area of the map that is currently visible, expressed in model coordinates.

    Returns null | Bounds

    the visible bounds in model coordinates or null if nothing is visible

    Deprecated

    Please use mapBounds instead.

  • Determines if the given paint representation is supported by this layer.

    Parameters

    Returns boolean

    true if the paint representation is supported; 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.

    Parameters

    Returns boolean

    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.

    Parameters

    Returns boolean

    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.

    Parameters

    • contextMenu: ContextMenu

      The context menu to populate

    • map: Map

      The map that is about to show a context menu

    • contextMenuInfo: any

      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.

    Returns void

  • 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.

    Parameters

    Returns void

  • Accepts the given visitor on the children of this.

    Parameters

    • visitor: LayerTreeVisitor

      The visitor which will receive the callbacks for the children.

    • order: VisitOrder

      The order in which the children need to be traversed.

    Returns void

  • 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.

    Examples:

      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);

    This call can be used to have a reliable, programmatic way to wait for all work leading up to the call to be reflected on the screen.
    The returned promise will always resolve once, when the layer is ready. The promise is rejected when the layer does not become ready in 5 minutes.

    Examples (not exhaustive) of aspects this promise will wait for:

    • While loading image data when it displayed for the first time, or after navigating the view
    • While loading image data after changing raster model properties such as WMS style
    • While loading feature data when it displayed for the first time, enters its scale range, or after navigating the view
    • While loading feature data after invalidating the layer query provider
    • While processing features after invalidating the layer feature painter or shape provider, or changing the layer filter
    • While processing features after they were added, updated or removed to/in/from a model or workingSet

    NOTE: The promise gets resolved also when an error (QueryStatus.QUERY_ERROR) occurs while handling underlying query or when the node is invisible.

    A LayerTree will wait until all its children are ready.

    Returns Promise<LayerTreeNode>

    A promise that resolves to the LayerTreeNode when all current work is done

Events

"" event

  • on("", callback: ((...args) => void), context?: any) : Handle
  • Registers a callback function for a given event type.

    Parameters

    • event: string

      the event type to register on

    • callback: ((...args) => void)

      the callback function to register

        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional context: any

      the context in which the callback function should be invoked implementation dependent.

    Returns Handle

    a handle to the registered callback with a single function 'remove'. This function can be used to unregister the callback function.

"EditableChanged" event

  • on("EditableChanged", callback: ((editable) => void), context?: any) : Handle
  • Event fired when the editability of the layer changes.

    Parameters

    • event: "EditableChanged"

      the 'EditableChanged' changed event.

    • callback: ((editable) => void)

      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.

        • (editable): void
        • Parameters

          • editable: boolean

          Returns void

    • Optional context: any

      value to use as this when executing callback

    Returns Handle