Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
AccessType Enum
Address Class
Answers Class
ApexPages Class
Approval Class
Blob Class
Boolean Class
BusinessHours Class
Callable Interface
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Double Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
FlexQueue Class
FeatureManagement Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
Location Methods
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
OrgLimit Class
OrgLimits Class
PageReference Class
Packaging Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
Quiddity Enum
RemoteObjectController
Request Class
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
Security Class
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserManagement Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Location Class

Contains methods for accessing the component fields of geolocation compound fields.

Namespace

system

Usage

Each of these methods is also equivalent to a read-only property. For each getter method you can access the property using dot notation. For example, myLocation.getLatitude() is equivalent to myLocation.latitude.

You can’t use dot notation to access compound fields’ subfields directly on the parent field. Instead, assign the parent field to a variable of type Location, and then access its components.

1Location loc = myAccount.MyLocation__c;
2Double lat = loc.latitude;

“Location” in Salesforce can also refer to the Location standard object. When referencing the Location object in your Apex code, always use Schema.Location instead of Location to prevent confusion with the standard Location compound field. If referencing both the location object and the Location field in the same snippet, you can differentiate between the two by using System.Location for the field and Schema.Location for the object.

Important

Example

1// Select and access the Location field. MyLocation__c is the name of a geolocation field on Account.
2Account[] records = [SELECT id, MyLocation__c FROM Account LIMIT 10];
3for(Account acct : records) {
4   Location loc = acct.MyLocation__c;
5   Double lat = loc.latitude;
6   Double lon = loc.longitude;
7}
8
9// Instantiate new Location objects and compute the distance between them in different ways.
10Location loc1 = Location.newInstance(28.635308,77.22496);
11Location loc2 = Location.newInstance(37.7749295,-122.4194155);
12Double dist = Location.getDistance(loc1, loc2, 'mi');
13Double dist2 = loc1.getDistance(loc2, 'mi');

Location Methods

The following are methods for Location.

getDistance(toLocation, unit)

Calculates the distance between this location and the specified location, using an approximation of the haversine formula and the specified unit.

Signature

public Double getDistance(Location toLocation, String unit)

Parameters

toLocation
Type: Location
The Location to which you want to calculate the distance from the current Location.
unit
Type: String
The distance unit you want to use: mi or km.

Return Value

Type: Double

getDistance(firstLocation, secondLocation, unit)

Calculates the distance between the two specified locations, using an approximation of the haversine formula and the specified unit.

Signature

public static Double getDistance(Location firstLocation, Location secondLocation, String unit)

Parameters

firstLocation
Type: Location
The first of two locations used to calculate distance.
secondLocation
Type: Location
The second of two locations used to calculate distance.
unit
Type: String
The distance unit you want to use: mi or km.

Return Value

Type: Double

getLatitude()

Returns the latitude field of this location.

Signature

public Double getLatitude()

Return Value

Type: Double

getLongitude()

Returns the longitude field of this location.

Signature

public Double getLongitude()

Return Value

Type: Double

newInstance(latitude, longitude)

Creates an instance of the Location class, with the specified latitude and longitude.

Signature

public static Location newInstance(Decimal latitude, Decimal longitude)

Parameters

latitude
Type: Decimal
longitude
Type: Decimal

Return Value

Type: Location