fileReader

geo. fileReader

new fileReader(argopt) → {geo.fileReader}

Description:

  • Create a new instance of class fileReader.

Source:
Parameters:
Name Type Attributes Description
arg geo.fileReader.spec <optional>
Returns:
Type
geo.fileReader

Extends

Members

idle

Description:

  • Getter for the idle state. Read only.

Source:
Inherited From:
Properties:
Name Type Description
idle boolean

true if the object is idle (onIdle would call a handler immediately).

Getter for the idle state. Read only.

Methods

addPromise(promise) → {this}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Description
promise Promise

A promise object.
Returns:
Type
this

canRead(file) → {boolean}

Description:

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

Source:
Parameters:
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:

true if this reader can read a file.

Type
boolean

geoIsOn(event, handleropt) → {boolean}

Description:

  • Report if an event handler is bound to this object.

Source:
Inherited From:
Parameters:
Name Type Attributes 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:

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

Type
boolean

geoOff(eventopt, argopt, nullable) → {this}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Attributes 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
this

geoOn(event, handler) → {this}

Description:

  • Bind an event handler to this object.

Source:
Inherited From:
Parameters:
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
this

geoOnce(event, handler) → {function}

Description:

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

Source:
Inherited From:
Parameters:
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:

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

Type
function

geoTrigger(event, argsopt) → {this}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Attributes 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
this

layer() → {geo.featureLayer}

Description:

  • Get the feature layer attached to the reader.

Source:
Returns:

The layer associated with the reader.

Type
geo.featureLayer

modified() → {this}

Description:

  • Update the timestamp to the next global timestamp value.

Source:
Inherited From:
Returns:
Type
this

onIdle(handler) → {this}

Description:

  • 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.

Source:
Inherited From:
Parameters:
Name Type Description
handler function

A function taking no arguments.
Returns:
Type
this

read(file, doneopt, progressopt) → {Promise}

Description:

  • Reads the file and optionally calls a function when finished. The done function is called with a value that is truthy if the read was a success. Depending on the specific reader, this value may be an object with details of the read operation.

Source:
Parameters:
Name Type Attributes 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 the object that was read and parsed by the reader.
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:

A Promise that resolves with object parsed by the reader or is rejected if the reader fails.

Type
Promise

removePromise(promise) → {this}

Description:

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

Source:
Inherited From:
Parameters:
Name Type Description
promise Promise

A promise object.
Returns:
Type
this

timestamp() → {number}

Description:

  • Get time.

Source:
Inherited From:
Returns:

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

Type
number

(inner) newFileReader(done, progressopt) → {FileReader}

Description:

  • Return a FileReader with handlers attached.

Source:
Parameters:
Name Type Attributes Description
done function

A callback that receives either the string read from the file or a DOMException with an error.
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:

The FileReader with done and progress handles attached to it.

Type
FileReader

Type Definitions

spec

Description:

  • Object specification for a fileReader.

Source:
Properties:
Name Type Attributes Description
layer geo.featureLayer <optional>

The target feature layer.

Object specification for a fileReader.

Type:
  • object