CatalogLoadLayerSet Class
A class for automatically loading maps from a Carmenta Engine Catalog.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECatalog assembly)
Syntax
public class CatalogLoadLayerSet : LayerSet
Remarks
A CatalogLoadLayerSet is similar to a LoadLayerSet, but instead of loading map layers from additional .px files, it loads map services from a catalog and inserts them as child layers. Since the class can be configured in Carmenta Studio, this makes is very simple to include a catalog map in an application; the application does not even have to use the Catalog mechanism API.
CatalogLoadLayerSet can also be used in .px files inside a catalog. This makes it possible to create new catalog maps by combining one or more simpler catalog maps.
The Queries property should normally hold one or more CatalogQuery instances. Each query will be executed, and the matching metadata records will be loaded using Catalog.LoadMap. The resulting CatalogMap instances will then be added as child layers to this CatalogLoadLayerSet. If no queries are specified, all maps from the catalog will be loaded and added as child layers, which could be very ineffective.
A Catalog object must be available when this class is initialized. This catalog may come from three different places:
If the CatalogLoadLayerSet is loaded from a .px file that is read during the initialization of a Catalog, then that Catalog instance will be used by the CatalogLoadLayerSet.
If the .px file is loaded directly by an application, the application may supply a Catalog object.
If no catalog object is found, the Catalog property is used.
If no catalog object can be located at all, an exception is thrown during initialization.
Using the queries, it also possible to modify the loaded catalog maps in various way. You can for instance override metadata properties like display names and descriptions, or enable or disable named styles. See CatalogQuery for more information.
To avoid loading the same map several times but in different languages, you can use the Catalog.PreferredLanguages to specify which language you want.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Layer
LayerSet
CatalogLoadLayerSet
Platforms
Windows, Linux, Android
CatalogLoadLayerSet Members
The CatalogLoadLayerSet type has the following members.
Constructors
Name | Description |
---|---|
CatalogLoadLayerSet | Initializes a new instance of the CatalogLoadLayerSet class. |
Properties
Name | Description |
---|---|
BlendMode | Gets or sets the blend mode that determines how the layer is combined with previously rendered layers. Inherited from Layer |
Catalog | Gets or sets the catalog instance to load map services from. |
Condition | Gets or sets the Condition that determines whether the CatalogLoadLayerSet is drawn or not. Inherited from Layer |
CoverageHint | Gets or sets a value that can assert that the visualization is fully opaque within the data extent. Inherited from Layer |
Description | Gets or sets a short description of the layer. Inherited from Layer |
DisableOnError | Gets or sets a value specifying if an error within the layer should automatically disable the layer, or throw an exception. Inherited from Layer |
DisplayName | Gets or sets a display name for the layer. Inherited from Layer |
Effects | List of effects Inherited from Layer |
Enabled | Determines whether the CatalogLoadLayerSet is enabled or not. Inherited from Layer |
EnabledDuringQuickUpdates | Determines whether the CatalogLoadLayerSet is temporarily turned off during mouse interactions. Inherited from Layer |
IsDisposed | Gets a value that tells whether the current CatalogLoadLayerSet has been disposed. Inherited from EngineObject |
IsoMetadataDocument | Gets or sets the path or URL to an ISO 19139 metadata document for the layer. Inherited from Layer |
Layers | Gets the child layers of this CatalogLoadLayerSet. Inherited from LayerSet |
Legend | Gets or sets a map legend associated with this layer. Inherited from Layer |
MaxScale | Gets or sets the highest inverted nominal scale in a 2D view, or the furthest distance in a 3D globe view, at which objects from this CatalogLoadLayerSet should be drawn. Inherited from Layer |
MinScale | Gets or sets the lowest inverted nominal scale this CatalogLoadLayerSet should be drawn at. Inherited from Layer |
Name | Gets or sets the name of the layer. Inherited from Layer |
NamedStyles | Gets the list of named styles that can be enabled for the layer. Inherited from Layer |
NativeHandle | Gets the native Carmenta Engine kernel object the current CatalogLoadLayerSet represents. Inherited from EngineObject |
Opacity | Gets or sets a value that specifies the opacity of the layer. Inherited from Layer |
Queries | Gets the list of queries used to find and load the map services. |
Selectable | Gets or sets a value that determines whether features in this CatalogLoadLayerSet can be selected. Inherited from Layer |
IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
Methods
Name | Description |
---|---|
Clone | Creates a copy of an object. Inherited from EngineObject |
Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
EnableStyle | Enables or disables a named style for the layer. Inherited from Layer |
Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Layer |
FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Layer |
GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Layer |
GetDataBounds | Calculates the bounds of all dataset coverages in the layer. Inherited from Layer |
GetFeatureAttributes | Gets information about all attributes that may be present on features in this layer. Inherited from Layer |
GetFeatures | Overloaded. Gets features from the layer and any child layers. Inherited from Layer |
GetLastError | Gets the error message for the last error that occurred within the layer. Inherited from Layer |
GetLocalizedDescription | Gets a localized version of the layer description in a specific language. Inherited from Layer |
GetLocalizedDisplayName | Gets a localized version of the layer display name in a specific language. Inherited from Layer |
GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Layer |
HasLocalizedDescription | Checks if a localized version of the layer description is available in a specific language. Inherited from Layer |
HasLocalizedDisplayName | Checks if a localized version of the layer display name is available in a specific language. Inherited from Layer |
HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Layer |
IsStyleEnabled | Checks if a certain style is enabled for the layer or not. Inherited from Layer |
Match | Checks if a metadata instance matches the queries of this CatalogLoadLayerSet. |
MoveLayer | Moves a child layer to a new position. Inherited from LayerSet |
SetLocalizedDescription | Sets a layer description in a specific language. Inherited from Layer |
SetLocalizedDisplayName | Sets a layer display name in a specific language. Inherited from Layer |
SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the layer, for a specific language. Inherited from Layer |
Events
Name | Description |
---|---|
EnabledChanged | Occurs when the value of the Enabled property has changed. Inherited from Layer |