brightness
(Read and Write)
|
Provides the ability to get or set the brightness value. The default, normal brightness, is 0%. Enter any value between +100% and -100%. Enter a plus or minus sign to the left of the value to specify whether it is above or below 0. Not all layers support the
brightness
property (for example, group layers and feature layers), so it is good practice to test for this ahead of time using the
supports
method.
|
Integer
|
contrast
(Read and Write)
|
Provides the ability to get or set the contrast value. The default, neutral contrast, is 0%. Enter any value between +100% and -100%. Enter a plus or minus sign to the left of the value to specify whether it is above or below 0. Not all layers support the
contrast
property (for example, annotation layers and fabric layers), so it is good practice to test for this ahead of time using the
supports
method.
|
Integer
|
credits
(Read and Write)
|
Provides the ability to either get or set the layer's credits or copyright information.
|
String
|
datasetName
(Read Only)
|
Returns the name of the layer's dataset the way it appears in the workspace, not in the TOC. Not all layers support the
datasetName
property (for example, web services), so it is good practice to test for this ahead of time using the
supports
method.
|
String
|
dataSource
(Read Only)
|
Returns the complete path for the layer's data source. It includes the
workspacePath
and the
datasetName
properties combined. Not all layers support the
dataSource
property (for example, annotation classes and web services), so it is good practice to test for this ahead of time using the
supports
method.
|
String
|
definitionQuery
(Read and Write)
|
Provides the ability to get or set a layer's definition query. Not all layers support the
definitionQuery
property (for example, raster layers and group layers), so it is good practice to test for this ahead of time using the
supports
method.
|
String
|
description
(Read and Write)
|
Provides the ability to either get or set the layer's description information. Not all layers support the
description
property (for example, topology layers), so it is good practice to test for this ahead of time using the
supports
method.
|
String
|
isBasemapLayer
(Read Only)
|
Returns
True
if a layer is a basemap layer.
|
Boolean
|
isBroken
(Read Only)
|
Returns
True
if a layer's data source is broken.
|
Boolean
|
isFeatureLayer
(Read Only)
|
Returns
True
if a layer is a feature layer.
|
Boolean
|
isGroupLayer
(Read Only)
|
Returns
True
if a layer is a group layer.
|
Boolean
|
isNetworkAnalystLayer
(Read Only)
|
Returns
True
if a layer is an
ArcGIS Network Analyst extension
layer type.
|
Boolean
|
isNetworkDatasetLayer
(Read Only)
|
Returns
True
if a layer is an
ArcGIS Network Analyst extension
network dataset layer type.
|
Boolean
|
isRasterizingLayer
(Read Only)
|
Returns
True
if a layer will cause rasterization of other vector layers in the data frame when the map is printed or exported. Rasterization of vector layers during output most often occurs when layer transparency is used but can also happen when a layer has raster-based picture symbols or field-based transparency.
|
Boolean
|
isRasterLayer
(Read Only)
|
Returns
True
if a layer is a raster layer.
|
Boolean
|
isServiceLayer
(Read Only)
|
Returns
True
if a layer is a GIS service layer. GIS services are automated geographic information services that are
published and accessed over the web using standard technologies and
protocols.
|
Boolean
|
labelClasses
(Read and Write)
|
Provides access to a layer's label class properties by returning a list of
LabelClass
objects. Individual
LabelClass
object properties can be read and modified and written back to the layer. Not all layers support the
labelClasses
property (for example, raster layers and annotation layers), so it is good practice to test for this ahead of time using the
supports
method.
|
LabelClass
|
longName
(Read Only)
|
This property is valuable when trying to determine whether a layer belongs to a group layer. If a layer does not belong to a group layer, the long name will equal the layer name. If a layer does belong to a group layer, the group layer structure will be included in the long name. For example, the name of a layer nested inside a group layer within another group layer may look something like
Group1\Group2\LayerName
. All layer types support this property.
|
String
|
maxScale
(Read and Write)
|
Provides the ability to set or get the layer's maximum scale threshold.
|
Double
|
minScale
(Read and Write)
|
Provides the ability to set or get the layer's minimum scale threshold.
|
Double
|
name
(Read and Write)
|
Provides the ability to set or get the name of a layer the way it would appear in the ArcMap table of contents. Spaces can be included. All layer types support this property.
|
String
|
serviceProperties
(Read Only)
|
Provides access to connection information for ArcSDE and web service layers. The returned results are dictionary key-value pairs. There are two different dictionaries returned based on the type of layer. The first is for ArcSDE connections, and the second is for all web service layer types. The web services dictionary contains keys that work for all service layer types and also includes specific keys that work for only a particular web service type (for example, WMS has a key called WMSTitle). Either your script can check the
ServiceType
key before evaluating specific keys or you can use the
get
method that allows you to bypass keys that are not available. Not all layers support the
serviceProperties
property (for example, layers that are not ArcSDE or web service layers), so it is good practice to test for this ahead of time using the
supports
method.
Keys for an ArcSDE dictionary
-
ServiceType —The property displaying the type of service. This will only be SDE for ArcSDE layer types.
-
Server —The name or IP address of the computer where the ArcSDE geodatabase is located.
-
Service —The name or port number of the process running on the ArcSDE server.
-
Database —The name of the enterprise RDBMS database. This is not required when using Oracle.
-
UserName —A user account. This will be blank if using operating system authentication.
-
AuthenticationMode —Geodatabase or operating system authentication.
-
Version —The version of the geodatabase to which you are connecting.
Keys for a web service dictionary
-
ServiceType —Property displaying the type of service. These include ImageServer, IMS, MapServer, TiledInternetLayer, WMS, and WCS.
-
URL —Property displaying the URL to the service. If the connection to ArcGIS for Server is through a local area network (LAN), this value will be null.
-
Server —Property displaying the server name. If the connection to ArcGIS for Server is through the Internet (HTTP), this value will be null.
-
UserName —Property displaying the user name used to access a secured service. If the service is not password protected, this property will be null.
-
ServiceName —IMS service layers only. Property displays the name of the IMS service.
-
WMSName —WMS service layers only. Property displays the text string for the WMS service used for machine-to-machine communication.
-
WMSTitle —WMS service layers only. Property displays the description title string for the WMS service.
-
Name —WMS service layers only. Property displays the text string for the WMS layer used for machine-to-machine communication.
-
Title —WMS service layers only. Property displays the description title string for the WMS layer.
|
Dictionary
|
showLabels
(Read and Write)
|
Controls the display of labels for a layer. If set to
True
, labels will display; if set to
False
, labels will not be drawn. Not all layers support the
showLabels
property (for example, raster layers and annotation layers), so it is good practice to test for this ahead of time using the
supports
method. Layer types that support the
showLabels
property also support the
labelClasses
property.
|
Boolean
|
symbology
(Read Only)
|
Returns a reference to the layer's symbology class. Each supported layer symbology class has its own unique set of properties. It is best to first determine the layer's
symbologyType
before attempting to modify the symbology class properties.
|
Object
|
symbologyType
(Read Only)
|
Returns a string that represents the layer's symbology class type. Not all layer symbology class types are supported; for those that are not, the keyword
OTHER
is returned. The following is a list of possible values:
|
Object
|
time
(Read Only)
|
Returns the
LayerTime
class that provides access to time properties of time-enabled layers.
|
Object
|
transparency
(Read and Write)
|
Provides the ability to get or set the transparency value. This enables you to see through a layer to the layers underneath. Type
0
if you don't want a layer to be transparent. A transparency value of more than 90 percent usually results in the layer not being drawn at all. Not all layers support the
transparency
property (for example, fabric group layers and web service sublayers), so it is good practice to test for this ahead of time using the
supports
method.
|
Integer
|
visible
(Read and Write)
|
Controls the display of a layer. This has the same effect as checking the check box next to the layer in the table of contents in ArcMap. If set to
True
, the layer will draw; if set to
False
, the layer will not be drawn. Not all layers support the
visible
property (for example, restricted web service layers), so it is good practice to test for this ahead of time using the
supports
method.
|
Boolean
|
workspacePath
(Read Only)
|
Returns a path to the layer's workspace or connection file. Not all layers support the
workspacePath
property (for example, web services), so it is good practice to test for this ahead of time using the
supports
method.
|
String
|