This document is archived and information here might be outdated.  Recommended version.


IMapServer3.GetDefaultLayerDrawingDescriptions Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IMapServer3.GetDefaultLayerDrawingDescriptions Method

Get Layer Drawing Description

[Visual Basic .NET]
Public Function GetDefaultLayerDrawingDescriptions ( _
    ByVal MapName As String, _
    ByVal pLayerIDs As ILongArray, _
    ByVal outputOptions As IServerSymbolOutputOptions _
) As ILayerDrawingDescriptions
[C#]
public ILayerDrawingDescriptions GetDefaultLayerDrawingDescriptions (
    string MapName,
    ILongArray pLayerIDs,
    IServerSymbolOutputOptions outputOptions
);
[C++]
HRESULT GetDefaultLayerDrawingDescriptions(
  BSTR MapName,
  ILongArray* pLayerIDs,
  IServerSymbolOutputOptions* outputOptions,
  ILayerDrawingDescriptions** ppLayerDrawingDescriptions
);
[C++]

Parameters MapName [in] MapName is a parameter of type BSTR pLayerIDs [in]
pLayerIDs is a parameter of type ILongArray outputOptions [in]
outputOptions is a parameter of type IServerSymbolOutputOptions ppLayerDrawingDescriptions [out, retval]
ppLayerDrawingDescriptions is a parameter of type ILayerDrawingDescriptions

Product Availability

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

Remarks

An array of ILayerDrawingDescription for layers which IDs were passed in. The result contains drawing descriptions only for feature layers. Therefore the count of input LayerIDs may not match with the count of returned array. If any ID is passed in that is neither of a FeatureLayer nor of an existing layer, no drawing description will be returned for that ID.

You may want to use IMapLayerInfo::HasLayerDrawingDescription to check whether MapServer will return ILayerDrawingDescription for a layer.

outputOptions parameter can be Null, in that case MapServer returns images in PNG format. In absence of virtual directory images are returned as PNG mime.

A LayerDrawingDescription object contains information on the symbology and label specified by the author. FeatureRenderer describes how the layer is symbolized while LabelingDescription contains all label classes defined in the source map by the author.

 

Please note that MapServer only returns the followings:

Types of renderer:

Types of symbol:

point features

line features

polygon features

If a layer’s renderer is not one of those supported one, nothing will be returned. Symbols that are not the supported get downgraded to one of supported one. Please see the rules below.

 

 

Here is how a layer’s symbols get downgraded:

Point symbols

Line symbols

Polygon symbols


Labels:

Graphic of Layer Label Properties in ArcMap

 

LabelPlacement

 

See Also

IMapServer3 Interface