ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / Layer Class
Properties Methods Events


In This Topic
    Layer Class Members
    In This Topic

    The following tables list the members exposed by Layer.

    Public Properties
     NameDescription
    Public Property  
    Public Property Gets the blending mode of a layer.  
    Public Property Gets a value indicating the MapMember's connection status. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Property Gets the depth priority of a layer.  
    Public Property Gets the layer's display cache type.  
    Public Property Returns the elevation type of the layer.  
    Public Property Gets whether the layer has any joins  
    Public Property Gets whether the layer has any relates  
    Public Property Gets whether the layer is expanded or collapsed on the TOC.  
    Public Property Gets the layer's visibility state.  
    Public Property Gets a read only collection of legend groups. Check the LegendStatus property before accessing this collection.  
    Public Property Gets the status of the layer's legend.  
    Public Property Get the map which the MapMember belongs to. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Property Gets map layer type.  
    Public Property Gets the duration of display cache for the layer.  
    Public Property Gets the maximum distance (in meter) at which the layer is visible in a 3D scene or globe view.  
    Public Property Gets the layer's maximum scale (representative fraction) at which the layer is visible in a 2D map view.  
    Public Property Gets the minimum distance (in meter) at which the layer is visible in a 3D scene or globe view.  
    Public Property Gets the layer's minimum scale (representative fraction) at which the layer is visible in a 2D map view.  
    Public Property Gets the display name of the MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Property Gets the parent of the layer. It is either the group layer it belongs to, or the map for layers that do not belong in any group layers.  
    Public Property Gets and sets the rasterize on export flag.  
    Public Property Gets and sets the maximum scale saved when ShowLayerAtAllScales is set to true.  
    Public Property Gets and sets the minimum scale saved when ShowLayerAtAllScales is set to true.  
    Public Property Gets the scene layer type.  
    Public Property Gets and sets whether the layer is visible at all scales.  
    Public Property Gets a value indicating whether the MapMember is configured to show pop-ups when a feature is clicked. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Property Gets whether the MapMember supports metadata (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Property Gets the transparency value set to the layer. 100 being fully transparent and 0 means opaque.  
    Public Property Gets the unique path of this MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Top
    Public Methods
     NameDescription
    Public Method Gets if the mapMember supports time filtering and can clear the time filter. Clearing the time filter ensures that data is always shown. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Gets if the mapMember supports time filtering. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method calling code must run on MCT  
    Public Method calling code can be run on any thread  
    Public Method Check if the layer's data source can be replace with this dataset. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Check if blending mode can be set on this layer.  
    Public Method Gets whether the elevation type definition can be set on the layer. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets if the mapMember supports time filtering and if the specified time parameters are valid. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Refreshes the layer drawing and clears the feature cache (for layer types supporting it). This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Clears the time filter for the mapMember. Clearing the time filter ensures that data is always shown. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Performs a find and replace of workspace path for the layer. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverridden.  Gets whether the Layer metadata can be edited or not. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets a CIMDataConnection value object. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Gets the time extent of the data for the specified fieldName - that is the minimum and maximum dates present in the data. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Gets the set of time intervals for the specified field name present in the data. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Returns the layer's CIM definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns computed effective maximum scale considering all its parent group layers. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns computed effective minimum scale considering all its parent group layers. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the elevation type definition for the layer. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverridden.  Gets the Layer metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the path of the dataset underneath the MapMember as a Uri. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Returns the layer spatial reference. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the current time parameters for the mapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Gets whether or not the MapMember stores its own metadata or uses metadata retrieved from its source. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Gets if time is supported for this mapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Determines whether the layer is visible in the given map view  
    Public Method Loads the layer's legend. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns extent of the layer optionally taking symbol size in account. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Replace the layer's data source. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the layer's blending mode. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the layer's caching options. If the layer's feature class supports feature caching, then both the display cache and feature cache are set otherwise just the display cache is set. This method must be called on the MCT. Use QueuedTask.Run  
    Public Method Updates a MapMember's data source. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Updates the layer's CIM definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the duration after which the layer's display cache will be refreshed in the local storage. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the elevation type definition for the layer. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets whether the layer appears expanded i.e. showing legends on the TOC. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the maximum distance (in meter) at which the layer is visible in a 3D scene or globe view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the layer's maximum scale (representative fraction) at which the layer is visible in a 2D map view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverridden.  Sets the Layer metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the minimum distance (in meter) at which the layer is visible in a 3D scene or globe view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the layer's minimum scale (representative fraction) at which the layer is visible in a 2D map view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the display name for the MapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Sets whether the layer is visible at all scales.  
    Public Method Toggles enabling pop-ups for the layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Sets the specified time parameters for the mapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Sets the transparency of the layer. 100 being fully transparent and 0 means opaque. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverridden.  Sets whether or not the Layer will use its own metadata or the metadata from its underlying source (if it has one). This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the layer visibility. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the display name of the MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Top
    Protected Methods
     NameDescription
    Protected Methodstatic (Shared in Visual Basic) Gets the expanded state of the layer and it's parents.  
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodOverloaded.   
    Top
    Extension Methods
     NameDescription
    Public Extension Method Gets whether templates have been loaded for the specified map member.
    Public Extension Method Generate feature templates for a layer or standalone-table. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Creates a new preset template from the specified set of features.
    Public Extension MethodOverloaded. 
    Public Extension Method Gets a template by name for a map member. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets all templates for a map member. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets all templates for a map member, including templates for any children. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodLoads a row into a new inspector instance. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets whether the layer is controlled by a parcel fabric of the specified type.
    Public Extension MethodOverloaded. 
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also