Chapter 3 JavaScript Basics
3.1 Introduction
So far we learned how to define the contents and style of web pages, with HTML (Chapter 1) and CSS (Chapter 2), respectively. We now move to the third major web technology, JavaScript. Being a programming language, JavaScript is fundamentally different from HTML and CSS, which are essentially data formats. Using HTML and CSS we can instruct the browser to display the given contents, with particular styling. Using a programming language, such as JavaScript, we can give the browser (or other computing environments) a much wider variety of instructions. For example, we can instruct the computer to perform mathematical calculations, to show or hide contents in response to user input, to periodically load up-to-date contents from an external source, and so on.
JavaScript is the most important of the technologies presented in this book, and we will use it extensively throughout the later chapters to build interactive web maps. Chapter 3 (this chapter) introduces the basic principles of the JavaScript language and the practical way of experimenting with it, using the JavaScript console built into web browsers (Figure 3.1). All of the examples we will see in this chapter work “in isolation,” not affecting web page content and style. Therefore, while reading this chapter, the reader can temporarily put aside what we learned in Chapters 1–2. Then, in Chapter 4, we will go back to HTML and CSS and see how to associate our JavaScript code with the web page contents, and how to modify that contents in response to user input. Finally, in Chapters 6–13, we will apply these techniques in the context of web mapping, using JavaScript to create customized web maps and to control their behavior.
3.2 What is JavaScript?
JavaScript is a programming language, mostly used to define the interactive behavior of web pages. JavaScript allows you to make web pages more interactive by accessing and modifying the contents and styling in a web page while it is being viewed in the browser. JavaScript, along with HTML and CSS, forms the foundation of modern web browsers and the internet.
JavaScript is considered, unofficially, to be the most popular programming language in the world (Figure 0.2). Numerous open-source mapping and data visualization libraries are written in JavaScript, including Leaflet, which we use in this book, OpenLayers, D3, and many others. Many commercial services of web mapping also provide a JavaScript API for building web maps with their tools, such as Google Maps JavaScript API, Mapbox-GL-JS and ArcGIS API for JavaScript (more on that in Section 6.4).
3.3 Client-side vs. server-side
When talking about programming for the web, one of the major concepts is the distinction between server-side and client-side.
- The server is the location on the web that serves your website to the rest of the world.
- The client is the computer that is accessing that website, requesting information from the server.
In server-side programming, we are writing scripts that run on the server. In client-side programming, we are writing scripts that run on the client, that is—in the browser. This book focuses on client-side programming, though we will say a few words on server-side programming in Chapter 5. JavaScript can be used in both server-side16 and client-side programming, but is primarily a client-side language, working in the browser on the client computer.
As we will see later on, there are two fundamental ways for using JavaScript on the client-side:
- Executing scripts when the web page is being loaded, such as scripts that instruct the browser to download data from an external location and display them on the page
- Executing scripts in response to user input or interaction with the page, such as performing a calculation and showing the result when the user clicks on a button
When JavaScript code is executed in a web page, it can do many different types of things, such as modifying the contents of the page, changing the appearance of content, sending information to a server, or getting information from the server.
3.4 The JavaScript console
When loading a web page which is associated with one or more scripts, the JavaScript code is automatically interpreted and executed by the browser. We can also manually interact with the browser’s interpreter or engine using the JavaScript console, also known as the command line, which is built into all modern web browsers. The console is basically a way to type code into a computer and get the computer’s answer back. This is useful for experimenting with JavaScript code, such as quickly testing short JavaScript code snippets. It is exactly what we are going to do in this chapter.
- Open a web browser.
- In Chrome: open the JavaScript console by pressing Ctrl+Shift+J, or by opening the developer tools with F12, then clicking on the Console tab.
- Type
5+5
and press Enter.- You have just typed a JavaScript expression, which was interpreted and the returned value
10
was printed.- The expression sent to the interpreter is marked with the
>
symbol. The returned value being printed is marked with the<-
symbol (Figure 3.1).- Use Ctrl+L to clear the console.
Figure 3.1 shows a screenshot of the JavaScript console with the entered expression 5+5
and the response 10
.
In this chapter, we will be using the console to get familiar with the JavaScript language. We will be typing expressions and examining the computer’s responses. In the following Chapters 4–13, instead of typing our JavaScript code, we will mostly load the code using the <script>
element (Section 1.6.3), either from embedded scripts or from external files. Nevertheless, the console is still going to be useful to interactively explore function behavior or currently loaded objects, or to interactively debug our scripts when they contain errors.
3.5 Assignment
Assignment to variables is one of the most important concepts in programming, since it lets us keep previously calculated results in memory for further processing. Variables are containers that hold data values, simple or complex, that can be referred to later in your code.
In JavaScript, variables are defined using the keyword var
, followed by the variable name. For example, the following two expressions define the variables x
and y
:
Note that each JavaScript expression should end with ;
. Ending statements with semicolon is not strictly required, since statement ending can also be automatically determined by the browser, but it is highly recommended to use ;
in order to reduce ambiguity.
Values can be assigned to variables using the assignment operator =
. Assignment can be made along with variable definition:
or later on, in separate expressions:
Either way, we have now defined two variables x
and y
. The values contained in these two variables are 5
and 6
, respectively. In your JavaScript console, to see a current value of a variable, type its name and hit Enter. The current value will be returned and printed:
The above code uses a JavaScript comment. We already learned how to write HTML comments (Section 1.5.2) and CSS comments (Section 2.8.2.1) in previous chapters. In JavaScript:
- Single line comments start with
//
- Single or multi-line comments start with
/*
and end with*/
(like in CSS)
There are several short-hand assignment operators, in addition to the basic assignment operator =
. For example, another commonly used assignment operator is the addition assignment operator +=
, which adds a value to a variable. The following expression uses the addition assignment operator +=
:
This is basically a shortcut for the following assignment17:
3.6 Data types
3.6.1 Overview
In the examples in Section 3.5 we defined variables holding numeric data, such as the numbers 5
and 6
. JavaScript variables can also hold other data types. JavaScript data types are divided into two groups: primitive data types and objects.
Primitive data types include the following:
- String—Text characters that are delimited by quotes, for example:
"Hello"
or'Hello'
- Number—Integer or floating-point value, for example:
5
and-10.2
- Boolean—Logical values,
true
orfalse
- Undefined—Specifies that a variable is declared but has no defined value,
undefined
- Null—Specifies an intentional absence of any object value,
null
Objects are basically collections of the primitive data types and/or other objects:
- Array—Multiple variables in a single variable, for example:
["Saab", "Volvo", "BMW"]
- Object—Collections of
name:value
pairs, for example:{type:"Fiat", model:"500", color:"white"}
The data types in JavaScript are summarized in Table 3.1. In the following Sections 3.6.2–3.6.4 we go over the data types in JavaScript one by one.
Group | Data type | Example |
---|---|---|
Primitive | String | "Hello" |
Number | 5 |
|
Boolean | true |
|
Undefined | undefined |
|
Null | null |
|
Objects | Array | ["Saab", "Volvo"] |
Object | {type: "Fiat", model: "500"} |
3.6.2 Primitive data types
3.6.2.1 String
Strings are collections of text characters, inside single ('
) or double ("
) quotes18. For example, the following expressions define two variables that contain strings, s1
and s2
:
Strings can be concatenated using the +
operator:
3.6.2.2 Number
Numbers can be integers or decimals. The usual arithmetic operators, +
, -
, *
, and /
, can be used with numeric variables:
In this example, we defined two variables x
and y
and assigned their values (5
and 6
). We also defined a third variable z
without assigning a value. Note how we defined x
, y
, and z
in the same expression, separated by commas—this saves typing the var
keyword three times. In the last expression we calculated x+y
and assigned the result of that calculation into z
.
JavaScript also has increment ++
and decrement --
operators. The increment operator ++
adds one to the current number. The decrement operator --
subtracts one from the current number. For example:
var x = 5;
x++; // Same as: x=x+1; the value of x is now 6
x--; // Same as: x=x-1; the value of x is now 5
When running the last two expressions, you will see 5
and 6
(not 6
and 5
) printed in the console, respectively. This is because the increment ++
and decrement --
expressions return the current value, before modifying it19.
3.6.2.3 Boolean
Boolean (logical) values are either true
or false
. For example:
In practice, Boolean values are usually created as the result of comparison operators. For example:
JavaScript comparison operators are summarized in Table 3.2.
Operator | Meaning |
---|---|
== |
Equal to |
=== |
Equal value and equal type |
!= |
Not equal |
!== |
Not equal value or not equal type |
> |
Greater than |
< |
Less than |
>= |
Greater than or equal to |
<= |
Less than or equal to |
You may have noticed there are two versions of the equality (==
, ===
) and inequality (!=
, !==
) comparison operators (Table 3.2). The difference between them is that the former ones (==
, !=
) consider just the value, while the latter ones (===
, !==
) consider both value and type. What do the terms equal value and equal type mean? Consider the following example, where 5
and "5"
have equal value (5) but unequal type (number vs. string). Comparing these two values gives different results when using the ==
and ===
operators. This is because ==
considers just the value, while ===
is more strict and considers both value and type:
Since the conversion rules of the ==
and !=
operators are complicated and unmemorable, it is not advised to use them. Instead, the ===
and !==
operators, with their expected and strict behaviors, are recommended (Crockford 2008).
Boolean values can be combined with logical operators:
&&
—AND operator,true
only if both values aretrue
||
—OR operator,true
if at least one of the values istrue
20!
—NOT operator,true
if value isfalse
For example:
var x = 6;
var y = 3;
(x < 10 && y > 1); // Returns true
(x == 5 || y == 5); // Returns false
!(x == 5 || y == 5); // Returns true
Boolean values are commonly used for flow control, which we learn about later on (Section 3.10).
3.6.2.4 Undefined
Undefined (undefined
) means that a variable has been declared but has not been assigned with a value yet. For example:
3.6.2.5 Null
Null (null
) is another special data type, representing lack of a value. For example:
3.6.3 Objects
3.6.3.1 Array
JavaScript arrays are used to store an ordered set of values in a single variable. An array can be created by putting zero or more values inside a pair of square brackets ([
and ]
), separating the values with commas (,
). For example:
Array items can be accessed using the brackets ([
) along with a numeric index. Note that index position in JavaScript starts at 0
. For example:
An array can be composed of different types of values, though this is rarely useful:
An array element can also be an array, or an object (Section 3.6.3.2 below). For example, an array of arrays can be thought of as a multi-dimensional array:
To access an element inside a multi-dimensional array we can combine several array access operations:
In the last expression, we used d[2]
to access the element in position 2
of d
, which is [7, 8, 9]
. This is actually the third element of d
, since, as you remember, JavaScript index positions start at 0
. Then, we used d[2][1]
to access the second element of [7, 8, 9]
, which gives us the final value of 8
21.
3.6.3.2 Objects
JavaScript objects are collections of named values22. An object can be defined using curly brackets ({
and }
). Inside the brackets, there is a list of name: value
pairs, separated by commas (,
). For example:
The above expression defines an object named person
. This object is composed of four named values, separated by commas. Each named value is composed of a name (such as firstname
) and a value (such as "John"
), separated by a colon (:
).
The named values are also called object properties. For example, the above object has four properties, named firstname
, lastname
, age
, and eyecolor
. The property values can be of any data type, including primitive data types (as in the above example, "John"
, "Smith"
, 50
, "blue"
), but also arrays and objects. Property values can also be functions, in which case they are referred to as methods (Section 3.8).
Objects are fundamental to JavaScript, and almost everything we work with in JavaScript is an object. The rationale of an object is to bind related data and/or functionality into a single collection. The collection usually consists of several variables and functions, which are called properties and methods when they are inside objects, respectively.
A JavaScript object is comparable to a real-life object. For example, a car can be thought of as an object (Figure 3.2). The car has properties like weight and color, which are set to certain values, and it has methods, like starting and stopping.
Object properties can be accessed using either of the following two methods:
- The dot notation (
.
) - The bracket notation (
[
)
In both cases, we need to specify the object name and the property/method name. For example, getting the person
properties using the dot notation looks like this:
person.firstname; // Returns "John"
person.age; // Returns 50
person.firstname + " is " + person.age + " years old.";
- What do you think will be returned by the third expression in the above code section?
- Create the
persons
object in the console and run the expression to check your answer.
The same can be accomplished using the bracket notation, as follows:
person["firstname"]; // Returns "John"
person["age"]; // Returns 50
person["firstname"] + " is " + person["age"] + " years old.";
When using the bracket notation, property names are specified as strings, in quotes. This means the dot notation is shorter to type, but the bracket notation is useful when the property name is specified with a variable:
As we already mentioned, an object property value can be another object or an array rather than a primitive data type. For example, we could arrange the information in the person
object in a different way:
Instead of having individual firstname
and lastname
properties, we now have a name
property which is an internal object, containing the firstname
and lastname
properties. To reach an internal object within another object, the dot notation (or the bracket notation) can be repeated several times in the same expression:
This is typical syntax that you will see a lot in JavaScript code:
- Note the auto-complete functionality, which can make it easier to interactively construct this kind of expression interactively in the console.
- For example, create the
person
object in the console, then start typingperson.
orperson.name.
to observe the auto-complete suggestions.
Object properties can also be modified via assignment. For example, we can change the person name from "John"
to "Joe"
as follows23:
3.6.4 Checking type of variables
The typeof
operator can always be used to query the type of variable we are working with. The following expressions demonstrate the use of typeof
on primitive data types:
typeof "a"; // Returns "string"
typeof 1; // Returns "number"
typeof false; // Returns "boolean"
typeof undefined; // Returns "undefined"
typeof null; // Returns "object" (!)
Note that typeof
returns "object"
when applied to null
, even though null
is a primitive data type. This behavior is considered to be a bug in the JavaScript language, kept for legacy reasons.
Arrays and objects are collectively classified as objects:
3.7 Functions
A function is a block of code designed to perform a particular task. If different parts of our JavaScript code need to perform the same task, we do not need to repeat the same code block multiple times. Instead, we define a function once, then call it multiple times whenever necessary.
A function is defined with:
- The
function
keyword - A function name of our choice, such as
multiply
- Parameter names separated by commas, inside parentheses (
(
and)
), such as(a, b)
- The code to be executed by the function, curly brackets (
{
and}
), such as{return a * b;}
The function code may contain one or more expressions. One or more of those can contain the return
keyword, followed by a value the function returns when executed. When a return
expression is reached the function stops, and the value after return
is returned by the function. In case there is no return
expression in the function code, the function returns undefined
.
For example, the following expression defines a function named multiply
. The multiply
function has two parameters, a
and b
. The function returns the result of a
multiplied by b
.
Once the function is defined, you can execute it with specific arguments. This is known as a function call. For example, the following expression is a function call of the multiply
function, returning 20
:
Note the distinction between parameters and arguments. Function parameters are the names listed in the function definition. Function arguments are the real values passed to the function when it is called. In the above example, the parameters of the multiply
function are a
and b
. The arguments in the above function call of multiply
were 4
and 5
.
A function does not necessarily have any parameters at all, and it does not necessarily return any value. For example, here is a function that has no parameters and does not return any value24:
The code in the greeting
function uses the console.log
function, which we have not met until now. The console.log
function prints text into the console.
The console.log
function is very helpful when experimenting with JavaScript code, and we will use it often. For example, when running a long script we may wish the current value of a variable to be printed out, to monitor its change through our program.
To keep the returned value of a function for future use, we use assignment25:
3.8 Methods
3.8.1 What are methods?
When discussing objects (Section 3.6.3.2 above), we mentioned that an object property can also be a function, in which case it is also known as a method. For example, a method may be defined when creating an object, in case one of the properties is assigned with a function definition:
Note that, in this example, the function was defined a little differently—there was no function name between the function
keyword and the list of parameters ()
. This type of function is called an anonymous function. Once it is defined, a method can be accessed just like any other property:
The parentheses ()
at the end of the last expressions imply we are making a function call for the method. For example, let us define a car
object (Figure 3.2), which has several properties with primitive data types, and one method named start
:
var car = {
name: "Mitsubishi",
model: "Super Lancer",
weight: 1300,
year: 1996,
color: "grey",
start: function() { console.log("Car started!"); }
};
Generally, methods define the actions that can be performed on objects. Using the car as an analogy, the methods might be start, drive, brake, and stop. These are actions that the car can perform. For example, starting the car can be done like this:
As a more realistic example, think of an object representing a layer in an interactive web map (Section 6.6). The layer object may have properties, such as the layer geometry, symbology, etc. The layer object may also have methods, such as methods for adding it to or removing it from a given map, adding popup labels on top of it, returning its data in a different format, and so on.
- Add another method to the
car
object, namedstop
, which prints a"Car stopped!"
message in the console.- Try using the new
stop
method withcar.stop()
.
3.8.2 Array methods
In JavaScript, primitive data types and arrays also have several predefined properties and methods, even though they are not strictly objects26. In this section, we look into a few useful properties and methods of arrays: .length
, .pop
, and .push
.
The .length
property of an array gives the number of items that it has:
- In the above code section:
- Why does the first expression return
3
?- Why does the second expression return
2
?
The .pop
and .push
methods can be used to remove or to add an item at the end of an array, respectively. The .pop
method removes the last element from an array. For example:
var fruits = ["Orange", "Banana", "Mango", "Apple"];
fruits.pop(); // Removes the last element from fruits
Note that the .pop
method, like many other JavaScript methods, modifies the array itself, rather than creating and returning a modified copy of it. The returned value by the .pop
method is in fact the item which was removed. In this case, the returned value is "Apple"
. In other words, when executing the above expressions the value "Apple"
is printed, while the new value of fruits
becomes ["Orange", "Banana", "Mango"]
.
The .push
method adds a new element at the end of an array:
var fruits = ["Orange", "Banana", "Mango", "Apple"];
fruits.push("Pineapple"); // Adds a new element to fruits
Again, note that the .push
method modifies the original array, which means that fruits
now has length of 5 (including "Pineapple"
at the end), after the above expressions are executed. The returned value of the .push
method is the new array length. In this example, the returned value is 5
.
3.9 Scope
Variable scope is the region of a computer program where that variable is accessible or “visible”. In JavaScript there are two types of scope:
- Global scope
- Local scope
Variables declared outside of a function have global scope. All expressions in the same script, inside or outside of functions, can access global variables. Variables defined inside a function have local scope. Local variables are only accessible from expressions inside the same function where they are defined.
In the following code section, carName
is a global variable. It can be used inside and outside of the myFunction
function:
var carName = "Suzuki";
// Code here can use carName
function myFunction() {
// Code here can use carName
}
Here carName
is a local variable. It can only be used inside myFunction
, where it was defined:
// Code here *cannot* use carName
function myFunction() {
var carName = "Suzuki";
// Code here can use carName
}
If you assign a value to a variable that has not been declared, it will automatically be defined as a global variable. In the following code example, carName
is a global variable even though the value is assigned inside a function:
// Code here can use carName
function myFunction() {
carName = "Suzuki";
// Code here can use carName
}
It is not recommended to create global variables unless you intend to, since they can conflict (override) other variables having the same name in the global environment.
3.10 Flow control
3.10.1 What is flow control?
By default, all expressions in our script are executed in the given order, top to bottom. This behavior can be modified using flow control expressions. There are two types of flow control expressions: conditionals and loops.
- Conditionals are used to condition code execution based on different criteria.
- Loops are used to execute a block of code a number of times.
3.10.2 Conditionals
The if
conditional is the most commonly used conditional. It is used to specify that a block of JavaScript code will be executed if a condition is true. An if
conditional is defined as follows:
For example, the following conditional sets greeting
to "Good day"
if the value of hour
is less than 18
:
The else
statement can be added to specify an alternative block of code, to be executed if the condition is false:
if(condition) {
// Code to be executed if the condition is true
} else {
// Code to be executed if the condition is false
}
For example, the following conditional sets greeting
to "Good day"
if hour
is less than 18
, or to "Good evening"
otherwise:
Decision trees of any complexity can be created by combining numerous if else
expressions. For example, the following set of conditionals defines that if time is less than 10:00, set greeting
to "Good morning"
, if not, but time is less than 18:00, set greeting
to "Good day"
, otherwise set greeting
to "Good evening"
:
if(hour < 10) {
greeting = "Good morning";
} else {
if(hour < 18) {
greeting = "Good day";
} else {
greeting = "Good evening";
}
}
This type of code may be used to create a customized greeting on a website, for instance. As another example, think of the way you can toggle layers on and off in a web map by using an if
statement to see whether the layer is currently visible. If visible is true, hide the layer, and vice versa.
Conditionals can also be used in map symbology, as we will see later on (Section 8.4). Consider the following example of a function that determines color based on an attribute. The function uses conditionals to return a color based on the “party” attribute: "red"
for Republican, "blue"
for Democrat, and "grey"
for anything else:
function party_color(p) {
if(p === "Republican") return "red"; else
if(p === "Democrat") return "blue"; else
return "grey";
}
Note that in the above example, the brackets ({}
) around conditional code blocks are omitted to make the code shorter, which is legal when code blocks consist of a single expression27.
- Define the
party_color
function, by copying the above code and pasting it in the console.- Try running the
party_color
function three times, each time with a different argument, to see how you can get all three possible returned values:"red"
,"blue"
, or"grey"
.
3.10.3 Loops
3.10.3.1 Standard for
loop syntax
Loops are used to execute a piece of code a number of times. JavaScript supports several types of loops. The most useful kind of loop within the scope of this book is the for
loop.
The standard for
loop has the following syntax:
where:
- Statement 1 is executed once, before the loop starts.
- Statement 2 defines the condition to keep running the loop.
- Statement 3 is executed in each “round,” after the code block is executed.
For example:
Let’s try to locate the for
loop components in the above example:
- Statement 1 sets a variable before the loop starts (
var i=0
). - Statement 2 defines the condition for the loop to keep running (
i<5
must betrue
, i.e.,i
must be less than five). - Statement 3 increases the value of
i
(i++
) each time the code block in the loop has been executed, using the increment operator++
(Section 3.6.2.2).
As a result, the code block is executed five times, with i
values of 0
, 1
, 2
, 3
, and 4
. A loop is thus an alternative to repetitive code. For example, the above for
loop is an alternative to the following code section, which gives exactly the same result without using a loop:
var text = "";
text += "The number is " + 0 + "<br>";
text += "The number is " + 1 + "<br>";
text += "The number is " + 2 + "<br>";
text += "The number is " + 3 + "<br>";
text += "The number is " + 4 + "<br>";
- Execute the
for
loop from the above code section, then print the value of thetext
variable to see the effect of the loop.
Here is another example of a for
loop. In this example, the code will be executed 1000 times since i
gets the values of 0
, 1
, 2
, etc., up to 999
.
3.10.3.2 Iterative for
loop syntax
In addition to the standard for
loop syntax shown above, there is a special syntax to iterate over elements of arrays or objects. In this iterative syntax, instead having three statements, we define the loop with just one statement:
where i
is a variable name (of our choice) and object
is the object which we iterate over. In each iteration, i
is set to another object
element name. In case object
is an array, i
gets the array index values: "0"
, "1"
, "2"
, and so on. In case object
is an object, i
gets the property names. For example:
This loop runs three times, once for each property of the object obj
. Each time, the i
variable gets the next property name of obj
. Inside the code block, the current property name (i
) and property value (obj[i]
) are being printed, so that the following output appears in the console:
a 12
b 13
c 14
For the next for
loop example, we define an object named directory
:
var directory = {
musicians: [
{firstname: "Chuck", lastname: "Berry"},
{firstname: "Ray", lastname: "Charles"},
{firstname: "Buddy", lastname: "Holly"}
]
};
The directory
object has just one property, named musicians
, which is an array. Each element in the directory.musicians
array is an object, with firstname
and lastname
properties. Using a for
loop we can go over the musicians
array, printing the full name of each musician:
for(var i in directory.musicians) {
var musician = directory.musicians[i];
console.log(musician.firstname + " " + musician.lastname);
}
This time, since directory.musicians
is an array, i
gets the array indices "0"
, "1"
, and "2"
. These indices are used to select the current item in the array, with directory.musicians[i]
. As a result, the following output is printed in the console28:
Chuck Berry
Ray Charles
Buddy Holly
3.11 JavaScript Object Notation (JSON)
3.11.1 JSON
JavaScript Object Notation (JSON) (Bassett 2015) is a data format closely related to JavaScript objects. It is a plain text format, which means that a JSON instance is practically a character string, which can be saved in a plain text file (usually with the .json
file extension), in a database, or in computer memory29.
JSON and JavaScript objects are very similar and easily interchangeable. For that reason, JSON is the most commonly used format for exchanging data between the server and the client in web applications. The principal difference between JSON and JavaScript objects is as follows:
- A JavaScript object is a data type in the JavaScript environment. A JavaScript object does not make sense outside of the JavaScript environment.
- A JSON instance is a plain text string, formatted in a certain way according to the JSON standard. A JSON string is thus not limited to the JavaScript environment. It can exist in another programming language, or simply stored inside a plain text file or a database.
For example, we already saw that a JavaScript object can be created using an expression such as the following one:
The corresponding JSON string can be defined, and stored in a variable, as follows:
A notable difference between how the above two variables are defined is that in a JSON string the property names are enclosed in quotes: "a"
and "b"
(we will immediately explain why). The JSON standard requires double quotes ("
), so we need to enclose the entire string with single quotes ('
).
To make a JSON string useful within the JavaScript environment, the JSON string can be parsed to produce an object. The parsing process, JSON→object, is done with the JSON.parse
function. The JSON.parse
function is used to convert a JSON string (e.g., coming from a server) to a JavaScript object:
As we just saw, a JSON string should have quoted property names, as in '{"key": "value"}'
and NOT '{key: "value"}'
. The purpose of this convention is to avoid parsing errors in cases when a key name is a reserved JavaScript keyword. For example, the following expression gives an error, because while
is a reserved keyword in JavaScript:
The following expression, however, will work fine, because the word while
has been enclosed in quotes:
The opposite conversion, object→JSON, is done with JSON.stringify
:
The JSON.stringify
function is commonly used when sending an object from the JavaScript environment to a server. Since, like we said, JavaScript objects cannot exist outside of the JavaScript environment, we need to convert the object to a string with JSON.stringify
before the data are sent elsewhere. For example, we are going to use JSON.stringify
in Chapter 13 when sending spatial layers to permanent storage in a database (Section 13.6).
Finally, keep in mind that JSON is limited in that it cannot store undefined
values or functions. JSON can store all of the other JavaScript data types (Section 3.6.1)30:
- Strings
- Numbers
- Booleans
null
- Arrays
- Objects
3.11.2 GeoJSON
GeoJSON is a spatial vector layer format based on JSON. Since GeoJSON is a special case of JSON, it can be easily processed in the JavaScript environment using the same methods as any other JSON string, such as JSON.parse
and JSON.stringify
(Section 3.11.1). For this reason, GeoJSON is the most common data format for exchanging spatial (vector) data on the web.
Here is an example of a GeoJSON string:
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [125.6, 10.1]
},
"properties": {
"name": "Dinagat Islands"
}
}
This particular GeoJSON string represents a point layer with one attribute called name
. The layer has just one feature, a point at coordinates [125.6, 10.1]
. Don’t worry about the details of the GeoJSON format at this stage. We will cover the syntax of the GeoJSON format in Chapter 7.
A variable containing the above GeoJSON string can be created in a JavaScript environment with the following expression:
var pnt = '{' +
'"type": "Feature",' +
'"geometry": {' +
'"type": "Point",' +
'"coordinates": [125.6, 10.1]' +
'},' +
'"properties": {' +
'"name": "Dinagat Islands"' +
'}' +
'}';
Note that the string is defined piece by piece, concatenating with the +
operator, to make the code more readable. We could likewise define pnt
in a single line, using a long string and without needing +
.
GeoJSON can be parsed with JSON.parse
just like any other JSON:
Now that pnt
is a JavaScript object, we can access its contents using the dot (or bracket) notation just like with any other object:
pnt.type; // Returns "Feature"
pnt.geometry.coordinates; // Returns [125.6, 10.1]
pnt.geometry.coordinates[0]; // Returns 125.6
pnt.properties; // Returns {name: "Dinagat Islands"}
Going back to a GeoJSON string is done with JSON.stringify
:
The above expression gives the following result31:
Note that JSON.stringify
takes further arguments to control the formatting of the resulting string. For example, JSON.stringify(pnt, null, 4)
will create the following indented, multi-line string—much like the one we began with. This is much easier to read than the default one-line result shown above:
3.12 Exercise
- Write a short JavaScript code, as follows.
- The code starts with defining two arrays:
- The first array represents a single two-dimensional coordinate
A
, such as:[100, 200]
. - The second array is an array of coordinate pairs
B
, such as:[[0, 3], [0, 4], [1, 5], [2, 5]]
.
- The first array represents a single two-dimensional coordinate
- The code you write should create a new array, where the individual coordinate
A
is attached to each of the coordinates inB
, so that we get an array of coordinate pairs, such as:[[[100, 200], [0, 3]], [[100, 200], [0, 4]], [[100, 200], [1, 5]], [[100, 200], [2, 5]]]
32. - Hint: create an empty array
result
, then run a loop that goes over the second arrayB
, each time “pushing” (Section 3.8.2) theA
element plus the currentB
element intoresult
.
References
Bassett, Lindsay. 2015. Introduction to Javascript Object Notation: A to-the-Point Guide to Json. Sebastopol, CA, USA: O’Reilly Media, Inc.
Crockford, Douglas. 2008. JavaScript: The Good Parts: The Good Parts. Sebastopol, CA, USA: O’Reilly Media, Inc.
Node.js (https://nodejs.org/en/) is a prominent example of a server-side environment for executing JavaScript code.↩
More information on
+=
, and other assignment operators, can be found in the Assignment Operators reference (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Assignment_Operators) by Mozilla.↩For more information on strings, see the Strings reference (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps/Strings) by Mozilla.↩
For more information on numbers, see the Numbers and Operators reference (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps/Math) by Mozilla.↩
Note the distinction between
&&
and&
, and between||
and|
. The latter,&
and|
, are known as bitwise operators and are not intended for combining comparison expressions.↩For more information on arrays, see the Arrays article (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps/Arrays) by Mozilla.↩
JavaScript objects are comparable, for example, to dictionaries in Python or to lists in R.↩
For more information on objects, see the Objects reference (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/Basics) by Mozilla.↩
As mentioned above, a function with no
return
statement returns the default value ofundefined
.↩For more information on functions, see the Functions article (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Functions) by Mozilla.↩
The mechanism which makes this happen is beyond the scope of this book.↩
For more information on conditionals, see the Making decisions in your code—conditionals article (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/conditionals) by Mozilla.↩
For more information on loops, see the Looping code article (https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building_blocks/Looping_code) by Mozilla.↩
Other well-known plain text data formats are, for instance, Comma-Separated Values (CSV) (https://en.wikipedia.org/wiki/Comma-separated_values) and Extensible Markup Language (XML) (https://en.wikipedia.org/wiki/XML).↩
For more details on the difference between a JavaScript object and a JSON string, check out the StackOverflow question on this matter (https://stackoverflow.com/questions/6489783/whats-the-difference-between-javascript-object-and-json-object).↩
The last part of the string is omitted and replaced with
[...]
to fit on the page.↩The resulting array can be useful for drawing line segments between a single point
A
and a second set of pointsB
(Figure 11.8).↩