Class: geojsonReader

Extends

• geo.fileReader

Type Definitions

geo.geojsonReader.specgeo.fileReader.spec

Object specification for a geojsonReader.

Properties:

Name	Type	Argument	Description
pointStyle	geo.pointFeature.styleSpec	<optional>	Default style for points.
lineStyle	geo.pointFeature.styleSpec	<optional>	Default style for lines.
polygonStyle	geo.pointFeature.styleSpec	<optional>	Default style for polygons.
layer	geo.featureLayer	<optional>	The target feature layer.

Members

inherited idle

Getter for the idle state. Read only.

Properties:

Name	Type	Description
idle	boolean	true if the object is idle (onIdle would call a handler immediately).

Methods

inherited addPromise(promise){this}

object.js, line 80

Add a new promise object preventing idle event handlers from being called until it is resolved.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

canRead(file){boolean}

geojsonReader.js, line 83

Tells the caller if it can handle the given file by returning a boolean.

Name	Type	Description
file	File | Blob | string | object	This is either a File object, a Blob object, a string representation of a file, or an object representing data from a file.

Returns:

Type	Description
boolean	true if this reader can read a file.

inherited geoIsOn(event, handler){boolean}

object.js, line 187

Report if an event handler is bound to this object.

Name	Type	Description
event	string | Array.<string>	An event or list of events to check.
handler	function	optional A function that might be bound. If undefined, this will report true if there is any handler for the specified event.

Returns:

Type	Description
boolean	true if any of the specified events are bound to the specified handler.

inherited geoOff(event, arg){this}

object.js, line 246

Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.

Name	Type	Description
event	string | Array.<string>	optional An event or a list of events from geo.event or defined by the user, or undefined to remove all events (in which case arg is ignored).
arg	function | Array.<function()>	optional nullable A function or array of functions to remove from the events or a falsy value to remove all handlers from the events.

Returns:

Type	Description
this

inherited geoOn(event, handler){this}

object.js, line 139

Bind an event handler to this object.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
this

inherited geoOnce(event, handler){function}

object.js, line 168

Bind an event handler to this object that will fire once and then deregister itself.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
function	The actual bound handler. This is a wrapper around the handler that was passed to the function.

inherited geoTrigger(event, args){this}

object.js, line 207

Trigger an event (or events) on this object and call all handlers.

Name	Type	Description
event	string | Array.<string>	An event or list of events from geo.event or defined by the user.
args	object	optional Additional information to add to the geo.event object passed to the handlers.

Returns:

Type	Description
this

inherited layer(){geo.featureLayer}

fileReader.js, line 44

Get the feature layer attached to the reader.

Returns:

Type	Description
geo.featureLayer	The layer associated with the reader.

inherited modified(){this}

timestamp.js, line 25

Update the timestamp to the next global timestamp value.

Returns:

Type	Description
this

inherited onIdle(handler){this}

object.js, line 36

Bind a handler that will be called one time when all internal promises are resolved. If there are no outstanding promises, this is invoked synchronously.

Name	Type	Description
handler	function	A function taking no arguments.

Returns:

Type	Description
this

read(file, done, progress){Promise}

geojsonReader.js, line 312

Reads the file and optionally calls a function when finished. The done function is called with a list of geo.feature on success or false on failure.

Name	Type	Description
file	File | Blob | string | object	This is either a File object, a Blob object, a string representation of a file, or an object representing data from a file.
done	function	optional An optional callback function when the read is complete. This is called with false on error or a list of geo.feature on success.
progress	function	optional A function which is passed ProgressEvent information from a FileReader. This includes loaded and total each with a number of bytes.

Returns:

Type	Description
Promise	A Promise that resolves with a list of geo.feature or is rejected if the reader fails.

inherited removePromise(promise){this}

object.js, line 116

Mark a promise as no longer required to resolve before the idle state is reached.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

inherited timestamp(){number}

timestamp.js, line 37

Get time.

Returns:

Type	Description
number	The timestamp. This is 0 if the timestamp has never been modified.