Classes

Storage

Spyral.Util.Storage

Methods

static blobToDataUrl(blob) → {Promise.<String>}

voyantjs/src/util.js, line 80

Take a Blob and convert it to a data URL.

Parameters:

Name	Type	Description
blob	Blob

Returns:

Promise.<String> -

a Promise for a data URL

static blobToString(blob) → {Promise.<String>}

voyantjs/src/util.js, line 101

Take a Blob and convert it to a String.

Parameters:

Name	Type	Description
blob	Blob

Returns:

Promise.<String> -

a Promise for a String

static dataUrlToBlob(dataUrl) → {Blob}

voyantjs/src/util.js, line 60

Take a data URL and convert it to a Blob.

Parameters:

Name	Type	Description
dataUrl	String

Returns:

Blob

static getFileExtensionFromMimeType(mimeType) → {String}

voyantjs/src/util.js, line 330

Takes a MIME type and returns the related file extension. Only handles file types supported by Voyant.

Parameters:

Name	Type	Description
mimeType	String

Returns:

String

static getVoyantDocumentFormatFromFileExtension(fileExtension) → {String}

voyantjs/src/util.js, line 388

Takes a file extension and returns the corresponding Voyant Document Format name.

Parameters:

Name	Type	Description
fileExtension	String

Returns:

String

static id(len) → {String}

voyantjs/src/util.js, line 14

Generates a random ID of the specified length.

Parameters:

Name	Type	Default	Description
len	Number	8	The length of the ID to generate?

Returns:

String

static isArray(val) → {Boolean}

voyantjs/src/util.js, line 254

Returns true if the value is an Array.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isBlob(val) → {Boolean}

voyantjs/src/util.js, line 319

Returns true if the value is a Blob.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isBoolean(val) → {Boolean}

voyantjs/src/util.js, line 234

Returns true if the value is a Boolean.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isFunction(val) → {Boolean}

voyantjs/src/util.js, line 294

Returns true if the value is a Function.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isNode(val) → {Boolean}

voyantjs/src/util.js, line 284

Returns true if the value is a Node.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isNull(val) → {Boolean}

voyantjs/src/util.js, line 274

Returns true if the value is Null.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isNumber(val) → {Boolean}

voyantjs/src/util.js, line 224

Returns true if the value is a Number.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isObject(val) → {Boolean}

voyantjs/src/util.js, line 264

Returns true if the value is an Object.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isPromise(val) → {Boolean}

voyantjs/src/util.js, line 305

Returns true if the value is a Promise.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isString(val) → {Boolean}

voyantjs/src/util.js, line 214

Returns true if the value is a String.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static isUndefined(val) → {Boolean}

voyantjs/src/util.js, line 244

Returns true if the value is Undefined.

Parameters:

Name	Type	Description
val	*

Returns:

Boolean

static loadScript(scriptUrl) → {Promise}

voyantjs/src/util.js, line 194

Loads an external script for use with your notebook.

Parameters:

Name	Type	Description
scriptUrl	String	The URL of the script to load.

Returns:

Promise

static more(before, more, after)

voyantjs/src/util.js, line 49

Parameters:

Name	Type	Description
before	String
more	String
after	String

static show(contents, lenopt, modeopt)

src/main/webapp/resources/spyral/src/show.js, line 1

Show contents in the results area. Will try to intelligently handle most types of content.

Parameters:

Name	Type	Attributes	Default	Description
contents	*			The contents to show
len	Number	<optional>		A maximum length to trim the contents to
mode	String	<optional>	info	A CSS class to apply to the shown contents

static showError(error, moreopt)

src/main/webapp/resources/spyral/src/show.js, line 54

Show an error in the results area.

Parameters:

Name	Type	Attributes	Description
error	*		An Error to display
more	*	<optional>	Additional Error details

static toString(contents) → {String}

voyantjs/src/util.js, line 32

Parameters:

Name	Type	Description
contents	Array | Object | String

Returns:

String

static transformXml(xmlDoc, xslStylesheet, returnDocopt) → {Document}

voyantjs/src/util.js, line 125

Takes an XML document and XSL stylesheet and returns the resulting transformation.

Parameters:

Name	Type	Attributes	Default	Description
xmlDoc	Document | String			The XML document to transform
xslStylesheet	Document | String			The XSL to use for the transformation
returnDoc	Boolean	<optional>	false	True to return a Document, false to return a DocumentFragment

Returns:

Document