FRAMES | NO FRAMES
StdGeographiesFromTreeParams Type

Parameters of StdGeographiesFromTree utility method.

Availability: Business Analyst Server.

class StdGeographiesFromTreeParams : AnalysisParameters

Property Description
BranchID The ID of branch in the tree of standard geography levels. The tree could be retrieved with StdGeographiesTree method. Type String.
Criterion (optional) A string to search in names of geography locations. Type String.
Depth Depth of the geography level in the given branch. Type Int32.
IDCriterion (optional) A string to search in IDs of geography locations. Type String.
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer in. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

A geography level is selected using the BranchID and Depth properties. The BranchID specifies a branch of the tree of standard geography levels (e.g. "USbyTracts", "USbyCounties", or "USbyZIP5") and the Depth specifies the geography level depth for the given branch (e.g. the level depth in "USbyZIP5" branch is 0 for whole USA, 1 for States, 2 for Counties, and 3 for ZIPs).

The Criterion and IDCriterion properoties specify the criteria for search in the location name and ID fields, respectively. If both criteria are specified, the geography locations are searched in the standard geography level using the logical "and" operation. If both criteria are missing, all locations of the standard geography level are queried. The returned feature list represents the complete list of children of all matching locations from the specified geography level.

See Also