GedcomX FS JS Class: ArtifactMetadata

new ArtifactMetadata( [json])

A representation of metadata about an artifact such as a memory.

Parameters:

Name	Type	Argument	Description
`json`	Object	<optional>

Extends

Base

Methods

addQualifier(qualifier)

Add a qualifier

Parameters:

Name	Type	Description
`qualifier`	Qualifier

Returns:

this

Type: ArtifactMetadata

getEditable()

Get the editable flag

Returns:

editable

Type: Boolean

getFilename()

Get the filename

Returns:

filename

Type: String

getHeight()

Get the height

Returns:

height

Type: Number

getQualifiers()

Get the qualifiers

Returns:

Type: Array.<Qualifier>

getScreeningState()

Get the screeningState

Returns:

screeningState

Type: String

getSize()

Get the size

Returns:

size

Type: Number

getWidth()

Get the width

Returns:

width

Type: Number

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

Base#init

Returns:

ArtifactMetadata this

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setEditable(editable)

Set the editable

Parameters:

Name	Type	Description
`editable`	Boolean

Returns:

this

Type: ArtifactMetadata

setFilename(filename)

Set the filename

Parameters:

Name	Type	Description
`filename`	String

Returns:

this

Type: ArtifactMetadata

setHeight(height)

Set the height

Parameters:

Name	Type	Description
`height`	Number

Returns:

this

Type: ArtifactMetadata

setQualifiers(qualifiers)

Set the qualifiers

Parameters:

Name	Type	Description
`qualifiers`	Array.<Qualifier>

Returns:

this

Type: ArtifactMetadata

setScreeningState(screeningState)

Set the screeningState

Parameters:

Name	Type	Description
`screeningState`	String

Returns:

this

Type: ArtifactMetadata

setSize(size)

Set the size

Parameters:

Name	Type	Description
`size`	Number

Returns:

this

Type: ArtifactMetadata

setWidth(width)

Set the width

Parameters:

Name	Type	Description
`width`	Number

Returns:

this

Type: ArtifactMetadata

toJSON()

Export the object as JSON

Overrides:

Base#toJSON

Returns:

JSON object

Type: Object