Spyral.Metadata(config) → {Spyral.Metadata}

A class for storing Notebook metadata

new Metadata(config) → {Spyral.Metadata}
src/main/webapp/resources/spyral/src/metadata.js, line 5

The metadata constructor.

Parameters:
Name Type Description
config Object

The metadata config object

Properties
Name Type Description
title String

The title of the Notebook
userId String

The user ID of the author of the Notebook
author String

The name of the author of the Notebook
catalogue Boolean

Whether to include the Notebook in the Catalogue
description String

The description of the Notebook
keywords Array

The keywords for the Notebook
created String

When the Notebook was created
language String

The language of the Notebook
license String

The license for the Notebook
Returns:
Spyral.Metadata

Methods

clone() → {Spyral.Metadata}
src/main/webapp/resources/spyral/src/metadata.js, line 115

Returns a clone of this Metadata

Returns:
Spyral.Metadata

getHeaders() → {String}
src/main/webapp/resources/spyral/src/metadata.js, line 93

Gets the fields as a set of HTML meta tags.

Returns:
String

set(config)
src/main/webapp/resources/spyral/src/metadata.js, line 64

Set metadata properties.

Parameters:
Name Type Description
config Object

A config object

setDateNow(field)
src/main/webapp/resources/spyral/src/metadata.js, line 76

Sets the specified field to the current date and time.

Parameters:
Name Type Description
field String

shortDate(field) → {String|undefined}
src/main/webapp/resources/spyral/src/metadata.js, line 85

Gets the specified field as a short date.

Parameters:
Name Type Description
field String
Returns:
String | undefined