LayerResultOptions
A class that defines if and how geometry is included in query results from a layer.
Property |
Type |
Description |
---|---|---|
FormatValuesInResults |
bool |
Use field formatting defined for the layer in the source map. Number values will be converted to string. Default is true. If false, formatting will be ignored. |
GeometryResultOptions |
Define how geometry is modified when returned in query results. Operations include densify and generalize. IncludeGeometry must be set to true. | |
IncludeGeometry |
bool |
Define if geometry should be included in query results. Default is true. |
ReturnFieldNamesInResults |
bool |
Include field aliases in query results. Default is false. If true, the original field names will be returned. |
Remarks
In general, this object is used to indicate if and how geometry is included in query results. In some cases you may want modify geometry returned from a query to enhance performance or enable compatibility. If geometry is not necessary, set IncludeGeometry to False and query results will not include geometry. If geometry is included, you can modify its content through densify or generalize operations defined via GeometryResultOptions. Densification is used to support clients that do not support non-linear geometry such as Bezier and Circular Arcs. Generalization reduces the number of vertices in geometry which reduces the amount of data returned to the client and improves query response time.
FormatValuesInResults and ReturnFieldNamesInResults are only applied to Find and Identify map service methods. They are ignored by QueryFeatureData2, QueryFeatureIDs2, QueryFeatureCount2 and QueryHyperLinks methods. The default values for FormatValuesInResults and ReturnFieldNamesInResults are True and False respectively; that means if they are not set explicitly, those functions will respect field formatting and field alias set in the source map document. That means values are converted to a string in the result. When FormatValuesInResults is set to False, the numerical results of the query will be not be formatted. When ReturnFieldNamesInResults is set to True, the results will display original field names.