ArcObjects Library Reference (Carto)

ILayer Interface

Provides access to members that work with all layers. Note: the ILayer interface has been superseded byILayer2. Please consider using the more recent version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

ILayer is a generic interface for all layer objects. This interface has a method to draw the layer and provides access to generic layer properties.

Members

		Description
	AreaOfInterest	The default area of interest for the layer.
	Cached	Indicates if the layer needs its own display cache.
	Draw	Draws the layer to the specified display for the given draw phase.
	MaximumScale	Maximum scale (representative fraction) at which the layer will display.
	MinimumScale	Minimum scale (representative fraction) at which the layer will display.
	Name	Layer name.
	ShowTips	Indicates if the layer shows map tips.
	SpatialReference	Spatial reference for the layer.
	SupportedDrawPhases	Supported draw phases.
	TipText	Map tip text at the specified location.
	Valid	Indicates if the layer is currently valid.
	Visible	Indicates if the layer is currently visible.

CoClasses that implement ILayer

CoClasses and Classes	Description
BasemapLayer	Layer containing a Basemap.
CadAnnotationLayer	An Esri Cad annotation layer.
CadastralFabricLayer	Cadastral Fabric Layer Object.
CadastralFabricSubLayer	Cadastral Fabric Feature Layer Object.
CadFeatureLayer	Esri CAD Feature Layer class.
CadLayer	Esri CAD Layer class.
CompositeGraphicsLayer	A collection of graphics layers that behave like single layer.
CoverageAnnotationLayer	An Esri coverage annotation layer.
DimensionLayer	A collection of properties for a dimension layer.
DummyGraduatedMarkerLayer	A dummy layer used to display legend items in the style gallery (Singleton).
DummyLayer	A dummy layer used to display legend items in the style gallery (Singleton).
FDOGraphicsLayer	A collection of properties for an annotation layer (feature data object graphics layer).
FDOGraphicsSublayer	A collection of properties for an annotation sublayer layer (feature data object graphics sublayer).
FeatureLayer	A collection of features and their visual representation.
GdbRasterCatalogLayer	Geodabase RasterCatalog source and display options.
GeoVideoLayer (esriGlobeCore)	The georeferenced video layer.
GlobeGraphicsLayer (esriGlobeCore)	The Globe Graphics Layer.
GlobeLayer (esriGlobeCore)	The cache-only globe layer.
GlobeServerLayer (esriGlobeCore)	Provides programmatic access to a globe server layer.
GraphicsLayer3D (esri3DAnalyst)	A 3D Graphics Layer.
GraphicsSubLayer	Graphic sublayer handed back by the composite graphics layer.
GroupLayer	A collection of layers that behaves like a single layer.
ImageServerLayer	Image server layer source and display options.
IMSMapLayer	A container for the display and manipulation of IMS layers.
IMSSubFeatureLayer	A collection of IMS features as a sublayer of an IMSMapLayer.
IMSSubLayer	An IMS Layer as a sublayer of an IMSMapLayer.
JoinedControlPointLayer (esriCadastralUI)	Layer object that represents Control Points.
JoinedLinePointLayer (esriCadastralUI)	Layer object that represents Joined LinePoints.
JoinedParcelLayer (esriCadastralUI)	Layer object that represents Joined Parcels.
JoinedParcelLineLayer (esriCadastralUI)	Layer object that represents Joined Parcel Lines.
JoinedPointLayer (esriCadastralUI)	Layer object that represents Joined Points.
KmlLayer (esriGlobeCore)	Esri KML Layer class.
LasDatasetLayer	The Terrain Layer class.
MapServerBasicSublayer	Provides programmatic access to a basic map server sublayer.
MapServerFindSublayer	Provides programmatic access to a map server sublayer with Find capability.
MapServerIdentifySublayer	Provides programmatic access to a map server sublayer with Identify capability.
MapServerLayer	Provides programmatic access to a map server layer.
MapServerQuerySublayer	Provides programmatic access to a map server sublayer with Find and Identify capability.
MapServerRESTLayer	Provides programmatic access to a a layer based on MapServer using REST access.
MapServerRESTSubLayer	Provides programmatic access to a MapServer SubLayer.
MosaicLayer	The layer implementation of the Mosaic Dataset.
NALayer (esriNetworkAnalyst)	The layer for defining, solving, and viewing network analysis results.
NetworkLayer	Esri Network Layer CoClass.
NITFGraphicsLayer	A NITF graphics layer containing NITF CGM graphics.
PacketJoinedLayer (esriCadastralUI)	Layer object that represents a packet of Joined Parcels, Lines, Points, Control Points, LinePoints and Text.
ProcessLayer (esriGeoprocessing)	A collection of process layers that behaves like a single layer.
RasterBasemapLayer	Basemap Layer containing a Raster.
RasterCatalogLayer	Raster catalog source and display options.
RasterLayer	Raster layer source and display options.
SchematicLayer (esriSchematic)	A Schematic layer object.
SearchResultsLayer (esriCatalog)	A layer that lets you preview a search result in the Geography tab. This object is not supported on ArcGIS version 10.1. or later.
TemporalFeatureLayer (esriTrackingAnalyst)	Defines the coclass IDL parameters and attributes of the TemporalFeatureLayer COM object.
TerrainLayer	The Terrain Layer class.
TinLayer	The TIN Layer class.
TopologyLayer	A collection of properties for a topology layer.
WCSLayer	WCS layer source and display options.
WMSGroupLayer	A container for the display of WMS group layers.
WMSLayer	A container for the display of WMS sub layers.
WMSMapLayer	A container for the display and manipulation of WMS layers.
WMTSLayer	Provides programmatic access to WMTS layer.

Remarks

This interface has a method to draw the layer and properties to define the minimum and maximum display scales, the spatial reference, the name, layer visibility, whether or not the layer is cached, and whether or not the layer shows map tips.

There are also properties that indicate whether the layer is valid, its supported draw phases, area of interest, and the map tip text for a given coordinate.

.NET Snippets

.NET Samples

Closest facility solver (Code Files: frmClosestFacilitySolver) | Convert part to feature command (Code Files: ConvertPart) | 3D multipatch examples (Code Files: GraphicsLayer3DUtilities) | ArcGIS Network Analyst extension Engine application (Code Files: cmdRemoveLayer frmLoadLocations frmMain frmNALayerProperties) | Displaying a TOCControl context menu (Code Files: LayerSelectable RemoveLayer ScaleThresholds ZoomToLayer) | Layer property page and property sheet (Code Files: LayerVisibilityPage) | Visualizing the camera path while animating (Code Files: VisualizeCameraPath) | Service area solver (Code Files: frmServiceAreaSolver) | Dynamic display layer (Code Files: AddMyDynamicLayerCmd) | Implementing a schematic layout algorithm and its layout property page (Code Files: TranslateTree) | Load network layer from active analysis to the table of contents (Code Files: LoadNetworkLayerFromActiveAnalysisToTOC) | Create a geoprocessing tool to buffer a layer and retrieve messages (Code Files: BufferDlg) | Location-allocation solver (Code Files: frmLocationAllocationSolver) | Tabbed feature inspector (Code Files: EngineApplication) | Utility wizard for basic schematic datasets configuration (Code Files: GenerateSchematicTemplate) | Adding a real-time feed to ArcMap (Code Files: AddTrackingServerLayerButton) | Selection restriction evaluator (Code Files: SelectionRestrictionEvaluator) | Custom UI elements using add-ins (Code Files: ZoomToLayerButton) | Vehicle routing problem solver (Code Files: frmVRPSolver) | Updating the purge rule on a real-time temporal layer (Code Files: PurgeRuleForm) | Origin-destination cost matrix solver (Code Files: frmODCostMatrixSolver) | Applying a time offset to a time-aware feature layer (Code Files: TimeOffsetButton) | Dynamic cache layer manager controller (Code Files: CacheManagerDlg) | Layer effects animation in ArcMap (Code Files: AnimationTypeLayerEffects MapLayerEffectsKeyframe) | Layer filtering TOC view (Code Files: TOCLayerFilter) | Change layer rendering using the SymbologyControl (Code Files: LayerRendering) | Graphics layers ToolControl (Code Files: GraphicsLayersListCtrl) | Displaying MapTips in the MapControl (Code Files: MapTips) | ArcGIS Network Analyst extension barrier location editor (Code Files: NABarrierLocationEditor) | Add a traversal result to the map (Code Files: AddTraversalResultsToMap) | Creating a toolbar of globe tools (Code Files: Layer TableOfContents) | Custom scene navigation commands (Code Files: SelectFeatures SelectGraphics) | Subset network evaluators (Code Files: SubsetHelperUI) | Implementing a property page for an ArcGIS Engine application (Code Files: frmMain) | RSS weather layer (Code Files: AddRSSWeatherLayer AddWeatherItemCmd AddWeatherItemTool RefreshLayerCmd RSSLayerProperties RSSWeatherIdentifyObject SelectByCityName) | Create a command by inheriting from BaseCommand (Code Files: ZoomToLayer) | Save a layer file in a MapControl application (Code Files: frmMain) | Add and symbolize a historical temporal layer in ArcMap (Code Files: AddTemporalLayerButton) | Custom selection extension (Code Files: ZoomToLayerMultiItem) | Create camera flyby from path (Code Files: frmCameraPath) | Route layer (Code Files: Program) | Create a custom selection extension by extending ArcObjects (Code Files: ZoomToLayerMultiItem) | TOCControl metadata viewer (Code Files: MetadataViewer) | Schematic diagram auto refresh (Code Files: FormAutorefresh) | Schematics Engine application (Code Files: RemoveLayer ZoomToLayer) | Temporal statistics (Code Files: MainForm) | Working with packages in ArcGIS Engine (Code Files: FrmMapControl) | Time Series Graph tool add-in (Code Files: TimeSeriesGraph)

.NET Related Topics