Luciad.Layers.Features.FeatureLayer.Builder Class Reference

Builder for the luciad::FeatureLayer class. More...

Inheritance diagram for Luciad.Layers.Features.FeatureLayer.Builder:

Public Member Functions
	Builder (Luciad.Layers.Features.FeatureLayer.Builder other)
Luciad.Layers.Features.FeatureLayer	Build ()
	Returns a new layer, based on the properties set on this builder. More...
void	Dispose ()
Luciad.Layers.Features.FeatureLayer.Builder	Editable (bool editable)
	Sets whether the layer should be editable initially. More...
Luciad.Layers.Features.FeatureLayer.Builder	EditConfiguration (Luciad.Edit.Features.IFeatureEditConfiguration editConfiguration)
	Enables editing capabilities using the given IFeatureEditConfiguration. More...
Luciad.Layers.Features.FeatureLayer.Builder	EditCreateGeometryProvider (Luciad.Models.Features.IFeatureGeometryProvider geometryProvider)
	Provides the edit/create geometry provider for a Feature. More...
Luciad.Layers.Features.FeatureLayer.Builder	Labeled (bool labeled)
	Sets whether the layer should display labels initially. More...
Luciad.Layers.Features.FeatureLayer.Builder	LoadingStrategy (Luciad.Layers.Features.FeatureLayerLoadingStrategy loadingStrategy)
	Sets the FeatureLayerLoadingStrategy to use. More...
Luciad.Layers.Features.FeatureLayer.Builder	Model (Luciad.Models.Features.IFeatureModel model)
	Sets the feature model of the layer. More...
Luciad.Layers.Features.FeatureLayer.Builder	Painter (Luciad.Layers.Features.IFeaturePainter featurePainter)
	Sets the IFeaturePainter to use. More...
Luciad.Layers.Features.FeatureLayer.Builder	Queryable (bool queryable)
	Sets whether the features in this layer can be returned in the Map::queryFeatures method. More...
Luciad.Layers.Features.FeatureLayer.Builder	QueryConfiguration (Luciad.Layers.Features.FeatureQueryConfiguration configuration)
	Sets the query configuration to use. More...
Luciad.Layers.Features.FeatureLayer.Builder	Title (string title)
	Sets the title to use for the layer. More...
Luciad.Layers.Features.FeatureLayer.Builder	Visible (bool visible)
	Sets whether the layer should be visible initially. More...

Detailed Description

Builder for the luciad::FeatureLayer class.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder.

Constructor & Destructor Documentation

Builder()

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

inline

Member Function Documentation

Build()

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

inline

Returns a new layer, based on the properties set on this builder.

a new layer, based on the properties set on this builder.

luciad::LogicException

If not all mandatory parameters are set. If no painter is set and the feature model contains at least one feature data type without a geometry.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::build.

Dispose()

void Luciad.Layers.Features.FeatureLayer.Builder.Dispose ( )

inline

Editable()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Editable ( bool  editable )

inline

Sets whether the layer should be editable initially.

When an edit configuration is set, the default is true. When no edit configuration is set, the default is false. When this method is called with true as parameter, and no edit configuration is edit set, a default edit configuration will be used. This default configuration enables editing for all features, using a default handles provider. Refer to editConfiguration for enabling editing capabilities.

editable

the edit capability.

this builder.

FeatureLayer::setEditable for more info.

2020.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::editable.

EditConfiguration()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.EditConfiguration ( Luciad.Edit.Features.IFeatureEditConfiguration  editConfiguration )

inline

Enables editing capabilities using the given IFeatureEditConfiguration.

If not set, editing will not be supported, and FeatureLayer::getEditConfiguration will return nullptr. If set, editing will be enabled by default. Additional configuration for editing can be done using: Editor::Builder: for more global editing configuration FeatureLayer::Builder::editCreateGeometryProvider: to determine the edit/create geometry associated with a Feature

editConfiguration

the feature edit configuration used to edit the feature model. Cannot be nullptr.

this builder.

2020.1

luciad::NullArgumentException

when the given edit configuration is nullptr

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::editConfiguration.

EditCreateGeometryProvider()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.EditCreateGeometryProvider ( Luciad.Models.Features.IFeatureGeometryProvider  geometryProvider )

inline

Provides the edit/create geometry provider for a Feature.

This geometry provider determines using which geometry a Feature can be edited or created, and how to apply this geometry back on the Feature. This implementation is for example used by FeatureHandlesProvider, and by Creator. Calling this method is optional. When this method is not called, a default implementation will be used. This default implementation assumes that the Feature has a DataType with a GeometryDataAnnotation that points to the Geometry that can be edited the changed Geometry can be applied by replacing that Geometry property value, using Feature::asBuilder

geometryProvider

the edit geometry provider for the current Feature. Cannot be nullptr.

this

2020.1

luciad::NullArgumentException

when the given geometry provider is nullptr

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::editCreateGeometryProvider.

Labeled()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Labeled ( bool  labeled )

inline

Sets whether the layer should display labels initially.

The default is true. this builder.

labeled

whether the layer should display labels initially.

FeatureLayer::setLabeled

2020.2

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::labeled.

LoadingStrategy()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.LoadingStrategy ( Luciad.Layers.Features.FeatureLayerLoadingStrategy  loadingStrategy )

inline

Sets the FeatureLayerLoadingStrategy to use.

This method is optional. If a loading strategy is not explicitly configured, the LoadSpatially strategy is used. It tries to use the LoadSpatially strategy first. If that strategy is not supported for the layer's model, the LoadEverything strategy is used as fallback.

loadingStrategy

the loading strategy to use.

this builder

2023.0.02

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::loadingStrategy.

Model()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Model ( Luciad.Models.Features.IFeatureModel  model )

inline

Sets the feature model of the layer.

Calling this function is mandatory.

model

the feature model of the layer. Cannot be nullptr.

this builder.

luciad::NullArgumentException

when the given model is nullptr.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::model.

Painter()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Painter ( Luciad.Layers.Features.IFeaturePainter  featurePainter )

inline

Sets the IFeaturePainter to use.

If not set, a default painter will be used. The default painter relies on the feature model having all of its feature data types containing a geometry annotation.

featurePainter

the feature painter used to paint the feature model. Cannot be nullptr.

this builder.

luciad::NullArgumentException

when the given feature painter is nullptr

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::painter.

Queryable()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Queryable ( bool  queryable )

inline

Sets whether the features in this layer can be returned in the Map::queryFeatures method.

The default is true.

queryable

whether the features in this layer can be returned in the Map::queryFeatures method.

this builder

FeatureLayer::setQueryable

2023.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::queryable.

QueryConfiguration()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.QueryConfiguration ( Luciad.Layers.Features.FeatureQueryConfiguration  configuration )

inline

Sets the query configuration to use.

The query configuration determines which features to load based on the current map's scale. If not set, a default configuration will be used that always loads all features.

configuration

the query configuration. Cannot be nullptr.

this builder

luciad::NullArgumentException

when the given query configuration is nullptr

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::queryConfiguration.

Title()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Title ( string  title )

inline

Sets the title to use for the layer.

If not set, the title from the ModelMetadata is used.

title

the title for the layer.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::title.

Visible()

Luciad.Layers.Features.FeatureLayer.Builder Luciad.Layers.Features.FeatureLayer.Builder.Visible ( bool  visible )

inline

Sets whether the layer should be visible initially.

Default is true.

visible

the visibility.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureLayer::Builder::visible.