A layer for feature models. More...

Inheritance diagram for Luciad.Layers.Features.FeatureLayer:

Classes
class	Builder
	`Builder` for the `FeatureLayer` class. More...

Public Member Functions
Luciad.Layers.Features.FeatureLayer.Builder	AsBuilder ()
	Returns a new builder based on this layer instance.
override bool	Equals (object obj)
override int	GetHashCode ()
Public Member Functions inherited from Luciad.Layers.Layer
void	AddObserver (Luciad.Layers.ILayerObserver layerObserver)
	Adds an observer that allows to receive change events from this layer.
void	Dispose ()
void	RemoveObserver (Luciad.Layers.ILayerObserver layerObserver)
	Removes the given observer.

Static Public Member Functions
static Luciad.Layers.Features.FeatureLayer.Builder	NewBuilder ()
	Returns a new builder for creating a `FeatureLayer`.

Properties
Luciad.Layers.Features.DensitySettings	DensitySettings `[get, set]`
	The layer's density settings.
Luciad.Edit.Features.IFeatureEditConfiguration	EditConfiguration `[get]`
	The edit configuration if editing is supported, or null.
Luciad.Models.Features.IFeatureGeometryProvider	EditCreateGeometryProvider `[get]`
	The edit/create geometry provider for a `Feature`.
bool	IsEditable `[get, set]`
	Whether this layer is editable.
bool	IsLabeled `[get, set]`
	Whether this layer displays labels.
bool	IsQueryable `[get, set]`
	Whether the features of this layer can be returned in the `Map.QueryFeatures` method.
Luciad.Layers.Features.FeatureLayerLoadingStrategy	LoadingStrategy `[get]`
	The loading strategy that is used.
Luciad.Models.Features.IFeatureModel	Model `[get]`
	The layer's model, which provides the features to present.
Luciad.Layers.Features.IFeaturePainter	Painter `[get, set]`
	The layer's painter, which determines how the features are presented.
static string	PropertyDensitySettings = PropertyDensitySettingsInternal() `[get]`
	The property name for the `LayerEvent` that is fired as a result of changing the layer's `DensitySettings`.
static string	PropertyEditable = PropertyEditableInternal() `[get]`
	The property name for the `LayerEvent` that is fired as a result of changing the layer's editable flag.
static string	PropertyLabeled = PropertyLabeledInternal() `[get]`
	The property name for the `LayerEvent` that is fired as a result of changing the layer's labeled flag.
static string	PropertyPainter = PropertyPainterInternal() `[get]`
	The property name for the `LayerEvent` that is fired as a result of changing the layer's `IFeaturePainter`.
static string	PropertyQueryable = PropertyQueryableInternal() `[get]`
	The property name for the `LayerEvent` that is fired as a result of changing the layer's queryable flag.
Luciad.Layers.Features.FeatureQueryConfiguration	QueryConfiguration `[get]`
	The query configuration, which specifies which feature to present at different map scales.
Properties inherited from Luciad.Layers.Layer
ulong	Id `[get]`
	The layer's unique id.
bool	IsBusy `[get]`
	Whether this layer is busy loading data, rendering, loading attributions, or anything else.
bool	IsVisible `[get, set]`
	Whether this layer is visible.
static string	PropertyBusy = PropertyBusyInternal() `[get]`
	Property name for the `LayerEvent` that is fired as a result of the layer's busy flag changing.
static string	PropertyTitle = PropertyTitleInternal() `[get]`
	Property name for the `LayerEvent` that is fired as a result of changing the layer's title.
static string	PropertyVisible = PropertyVisibleInternal() `[get]`
	Property name for the `LayerEvent` that is fired as a result of changing the layer's visible flag.
string	Title `[get, set]`
	The layer's title.

Detailed Description

A layer for feature models.

Use FeatureLayer.NewBuilder to create a feature layer instance.

Member Function Documentation

◆ AsBuilder()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.AsBuilder ( )

inline

Returns a new builder based on this layer instance.

You can use this builder, for example, to create a copy of this layer.

Note that this function will not make copies of the used IFeatureModel or IFeaturePainter, but use the same instances that are present on this layer. You need to make sure that these are thread-safe and can handle concurrent usage.

Also note that observers will not be transferred to a new layer.

Returns: a new builder based on this layer instance.

Since: 2025.0

◆ Equals()

override bool Luciad.Layers.Features.FeatureLayer.Equals ( object obj )

inline

◆ GetHashCode()

override int Luciad.Layers.Features.FeatureLayer.GetHashCode ( )

inline

◆ NewBuilder()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.NewBuilder ( )

inlinestatic

Returns a new builder for creating a FeatureLayer.

Returns: a new builder for creating a FeatureLayer.

Property Documentation

◆ DensitySettings

Luciad.Layers.Features.DensitySettings Luciad.Layers.Features.FeatureLayer.DensitySettings

getset

The layer's density settings.

[get]

Returns the layer's density settings. The returned value is the currently set density settings, or null if density painting is not active.

[set]

Sets the layer's density settings. Can be set to null to deactivate density painting.

When density painting is active, the color map in the density settings is used to determine the colors of shapes drawn by the IFeaturePainter.

Since: 2024.1

See also: DensitySettings documentation for more information.

◆ EditConfiguration

Luciad.Edit.Features.IFeatureEditConfiguration Luciad.Layers.Features.FeatureLayer.EditConfiguration

get

The edit configuration if editing is supported, or null.

[get]

Returns the edit configuration if editing is supported, or null. Whether or not the layer can be edited by the user is controlled using setEditable.

Since: 2020.1 [get]

See also: FeatureLayer.Builder.EditConfiguration

◆ EditCreateGeometryProvider

Luciad.Models.Features.IFeatureGeometryProvider Luciad.Layers.Features.FeatureLayer.EditCreateGeometryProvider

get

The edit/create geometry provider for a Feature.

[get]

Returns the edit/create geometry provider for a Feature.

Since: 2020.1 [get]

See also: FeatureLayer.Builder.EditCreateGeometryProvider

◆ IsEditable

bool Luciad.Layers.Features.FeatureLayer.IsEditable

getset

Whether this layer is editable.

[get]

Returns whether this layer is editable. A layer is editable if it has an IFeatureEditConfiguration and if the editable flag is set.

[set]

Sets whether this layer is editable. If the new value is different from the old one, a LayerEvent is delivered to the observers with the property name FeatureLayer.propertyEditable.

This flag is checked by the Editor when receiving events from the IFeatureEditCandidateProvider in conjunction with the model's IFeatureModelUpdater and the layer's IFeatureEditConfiguration.

This flag is true by default. This flag has no effect if the layer does not contain an IFeatureEditConfiguration or if the model's IFeatureModelUpdater is missing.

Since: 2020.1

See also: setEditable

◆ IsLabeled

bool Luciad.Layers.Features.FeatureLayer.IsLabeled

getset

Whether this layer displays labels.

[get]

Returns whether this layer displays labels.

[set]

Sets whether this layer displays labels. Note that in order for the layer to display labels, its IFeaturePainter should also call the FeatureCanvas.DrawLabel method for its features. If not, no labels will be displayed, regardless of this setting.

Since: 2020.2

◆ IsQueryable

bool Luciad.Layers.Features.FeatureLayer.IsQueryable

getset

Whether the features of this layer can be returned in the Map.QueryFeatures method.

[get]

Returns whether the features of this layer can be returned in the Map.QueryFeatures method.

[set]

Sets whether the features of this layer can be returned in the Map.QueryFeatures method. The default is true.

It is useful to set this property to false when:

you don't want features to be selected or set to the hovered state by the SelectEventHandler or HoverEventHandler classes.
there is a performance issue with the Map.QueryFeatures method, for example for a layer with many features that don't need to be selected.

Since: 2023.1

◆ LoadingStrategy

Luciad.Layers.Features.FeatureLayerLoadingStrategy Luciad.Layers.Features.FeatureLayer.LoadingStrategy

get

The loading strategy that is used.

[get]

Returns the loading strategy that is used.

Since: 2023.0.02 [get]

See also: FeatureLayer.Builder.LoadingStrategy

◆ Model

Luciad.Models.Features.IFeatureModel Luciad.Layers.Features.FeatureLayer.Model

get

The layer's model, which provides the features to present.

[get]

Returns the layer's model, which provides the features to present.

◆ Painter

Luciad.Layers.Features.IFeaturePainter Luciad.Layers.Features.FeatureLayer.Painter

getset

The layer's painter, which determines how the features are presented.

[get]

Returns the layer's painter, which determines how the features are presented.

[set]

Sets the layer's painter, which determines how the features are presented. It will replace the IFeaturePainter that was set using the FeatureLayer.Builder.Painter method, or if that method was not called, it will replace the default feature painter.

Limitation: This method currently only supports setting a new IFeaturePainter with the exact same level of details as the previous painter. If this is not the case, this method will throw an exception.

Exceptions

System.ArgumentNullException	when the given feature painter is null
System.ArgumentException	when the new painter has different detail levels than the previous painter

Since: 2023.1 [set]

◆ PropertyDensitySettings

string Luciad.Layers.Features.FeatureLayer.PropertyDensitySettings = PropertyDensitySettingsInternal()

staticget

The property name for the LayerEvent that is fired as a result of changing the layer's DensitySettings.

[get]

Returns the property name for the LayerEvent that is fired as a result of changing the layer's DensitySettings.

Since: 2024.1 [get]

See also: FeatureLayer.DensitySettings

◆ PropertyEditable

string Luciad.Layers.Features.FeatureLayer.PropertyEditable = PropertyEditableInternal()

staticget

The property name for the LayerEvent that is fired as a result of changing the layer's editable flag.

[get]

Returns the property name for the LayerEvent that is fired as a result of changing the layer's editable flag.

See also: setEditable

◆ PropertyLabeled

string Luciad.Layers.Features.FeatureLayer.PropertyLabeled = PropertyLabeledInternal()

staticget

The property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

[get]

Returns the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

Since: 2020.2 [get]

See also: setLabeled

◆ PropertyPainter

string Luciad.Layers.Features.FeatureLayer.PropertyPainter = PropertyPainterInternal()

staticget

The property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.

[get]

Returns the property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.

Since: 2023.1 [get]

See also: Painter

◆ PropertyQueryable

string Luciad.Layers.Features.FeatureLayer.PropertyQueryable = PropertyQueryableInternal()

staticget

The property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

[get]

Returns the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

Since: 2023.1 [get]

See also: setQueryable

◆ QueryConfiguration

Luciad.Layers.Features.FeatureQueryConfiguration Luciad.Layers.Features.FeatureLayer.QueryConfiguration

get

The query configuration, which specifies which feature to present at different map scales.

[get]

Returns the query configuration, which specifies which feature to present at different map scales.

Classes

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AsBuilder()

◆ Equals()

◆ GetHashCode()

◆ NewBuilder()

Property Documentation

◆ DensitySettings

[get]

[set]

◆ EditConfiguration

[get]

◆ EditCreateGeometryProvider

[get]

◆ IsEditable

[get]

[set]

◆ IsLabeled

[get]

[set]

◆ IsQueryable

[get]

[set]

◆ LoadingStrategy

[get]

◆ Model

[get]

◆ Painter

[get]

[set]

◆ PropertyDensitySettings

[get]

◆ PropertyEditable

[get]

◆ PropertyLabeled

[get]

◆ PropertyPainter

[get]

◆ PropertyQueryable

[get]

◆ QueryConfiguration

[get]