BCAddressGeocoder.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>BCAddressGeocoder</name> </assembly> <members> <member name="T:BCAddressGeocoder.Commands.GetAddressesCommand"> <summary> <para type="synopsis">Geocode an address</para> <para type="description">Represents the set of geocoded and standardized sites and intersections whose address best matches a given query address.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.AddressString"> <summary> <para type="description">Civic or intersection address as a single string.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.LocationDescriptor"> <summary> <para type="description">Describes the nature of the address location.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.MaxResults"> <summary> <para type="description">The maximum number of search results to return.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Interpolation"> <summary> <para type="description">accessPoint interpolation method.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Echo"> <summary> <para type="description">If true, include unmatched address details such as site name in results.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Brief"> <summary> <para type="description">If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.AutoComplete"> <summary> <para type="description">If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.SetBack"> <summary> <para type="description">The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.OutputSRS"> <summary> <para type="description">The EPSG code of the spatial reference system (SRS) to use for output geometries.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.MinScore"> <summary> <para type="description">The minimum score required for a match to be returned.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.MatchPrecision"> <summary> <para type="description">Example: street,locality. A comma separated list of individual match precision levels to include in results.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.MatchPrecisionNot"> <summary> <para type="description">Example: street,locality. A comma separated list of individual match precision levels to exclude from results.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.SiteName"> <summary> <para type="description">A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.UnitDesignator"> <summary> <para type="description">The type of unit within a house or building.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.UnitNumber"> <summary> <para type="description">The number of the unit, suite, or apartment within a house or building.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.UnitNumberSuffix"> <summary> <para type="description">A letter that follows the unit number as in Unit 1A or Suite 302B.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.CivicNumber"> <summary> <para type="description">The official number assigned to a site by an address authority.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.CivicNumberSuffix"> <summary> <para type="description">A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St).</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.StreetName"> <summary> <para type="description">The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street).</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.StreetType"> <summary> <para type="description">The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St).</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.StreetDirection"> <summary> <para type="description">The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.StreetQualifier"> <summary> <para type="description">Example: the Bridge in Johnson St Bridge. The qualifier of a street name.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.LocalityName"> <summary> <para type="description">The name of the locality assigned to a given site by an address authority.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.ProvinceCode"> <summary> <para type="description">The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Localities"> <summary> <para type="description">A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.NotLocalities"> <summary> <para type="description">A comma-separated list of localities to exclude from the search.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Bbox"> <summary> <para type="description">Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Centre"> <summary> <para type="description">Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.MaxDistance"> <summary> <para type="description">The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.Extrapolate"> <summary> <para type="description">If true, uses supplied parcelPoint to derive an appropriate accessPoint.</para> </summary> </member> <member name="P:BCAddressGeocoder.Commands.GetAddressesCommand.ParcelPoint"> <summary> <para type="description">The coordinates of a point (x,y) known to be inside the parcel containing a given address.</para> </summary> </member> </members> </doc> |