GeoProcessor / Command / SetGeoLayerProperty
Overview
The SetGeoLayerProperty
command sets the value of a property on the GeoLayer.
The property will be available to subsequent commands that support using ${gl:Property}
notation in parameters.
One use for GeoLayer properties is to pass a layer property to the processor using
SetPropertyFromGeoLayer
commands to control processing logic.
GeoLayer properties may not be supported by spatial data formats and therefore may only be useful to control processing.
The command sets a GeoLayer property to a value of one of the following types:
Type | Description |
---|---|
bool |
Boolean value False or True . |
float |
Floating point number. |
int |
Integer number. |
str |
String. |
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
SetGeoLayerProperty
Command Editor (see full-size image)
Command Syntax
The command syntax is as follows:
SetGeoLayerProperty(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
GeoLayerID required |
The GeoLayer identifier, can use ${Property} . |
None - must be specified. |
PropertyName required |
The property name. | None - must be specified. |
PropertyType required |
The property type as bool , float , int , or str . |
None - must be specified. |
PropertyValue required |
The property value, as a string that can convert to the given type. | None - must be specified. |
Examples
See the automated tests.
Troubleshooting
See Also
SetProperty
command.SetPropertyFromGeoLayer
command.