Class Asset

The Asset class represents an asset in Editor.

Hierarchy

Events
- Asset

Index

Constructors

constructor

new Asset(data?: any): Asset
Constructor
Parameters
- data: any = {}
  The asset data
Returns Asset
Overrides Events.constructor
- Defined in submodules/editor-api/src/asset.ts:37

Accessors

history

get history(): ObserverHistory
Gets observer history for this asset.

Returns ObserverHistory
- Defined in submodules/editor-api/src/asset.ts:327

observer

get observer(): AssetObserver
The observer object for this asset.

Returns AssetObserver
- Defined in submodules/editor-api/src/asset.ts:320

Methods

delete

delete(): Promise<void>
Deletes this asset.

Returns Promise<void>
- Defined in submodules/editor-api/src/asset.ts:288

get

get(path: string): any
Gets value at path. See the Asset overview for a full list of properties.
Parameters
- path: string
  The path
Returns any
The value
- Defined in submodules/editor-api/src/asset.ts:150

has

has(path: string): boolean
Checks if path exists. See the Asset overview for a full list of properties.
Parameters
- path: string
  The path
Returns boolean
True if path exists
- Defined in submodules/editor-api/src/asset.ts:140

insert

insert(path: any, value: any, index: any): boolean
Inserts value in array at path, at specified index. See the Asset overview for a full list of properties.
Parameters
- path: any
  The path
- value: any
  The value
- index: any
  The index (if undefined the value will be inserted in the end)
Returns boolean
Whether the value was inserted
- Defined in submodules/editor-api/src/asset.ts:184

instantiateTemplate

instantiateTemplate(
    parent: Entity,
    options?: {
        extraData?: object;
        history?: boolean;
        index?: number;
        select?: boolean;
    },
): Promise<Entity>
Creates an instance of this template asset. Assumes this asset is a template asset.
Parameters
- parent: Entity
  The parent entity
- options: { extraData?: object; history?: boolean; index?: number; select?: boolean } = {}
  - OptionalextraData?: object
    Extra data passed to the backend. Used by the Editor on specific cases.
  - Optionalhistory?: boolean
    Whether to record a history action.
  - Optionalindex?: number
    The desired index under the parent to instantiate the template.
  - Optionalselect?: boolean
    Whether to select the new entity.
Returns Promise<Entity>
The new entity.
- Defined in submodules/editor-api/src/asset.ts:302

json

json(): Record<string, any>
Returns JSON representation of entity data

Returns Record<string, any>
- The data
- Defined in submodules/editor-api/src/asset.ts:204

latest

latest(): Asset
Returns the latest version of the Asset from the Assets API.

Returns Asset
The asset
- Defined in submodules/editor-api/src/asset.ts:213

load

load(): Promise<void>
Loads asset from the server without subscribing to realtime changes.

Returns Promise<void>
- Defined in submodules/editor-api/src/asset.ts:220

loadAndSubscribe

loadAndSubscribe(): Promise<void>
Loads the asset's data from sharedb and subscribes to changes.

Returns Promise<void>
- Defined in submodules/editor-api/src/asset.ts:245

removeValue

removeValue(path: any, value: any): boolean
Remove value from array at path. See the Asset overview for a full list of properties.
Parameters
- path: any
  The path
- value: any
  The value
Returns boolean
Whether the value was removed
- Defined in submodules/editor-api/src/asset.ts:195

replace

replace(asset: Asset, options?: { history?: boolean }): void
Replaces any references to this asset with references to the new asset specified.
Parameters
- asset: Asset
  The new asset.
- options: { history?: boolean } = {}
  - Optionalhistory?: boolean
    Whether to record a history action.
Returns void
- Defined in submodules/editor-api/src/asset.ts:313

set

set(path: string, value: any): boolean
Sets value at path. See the Asset overview for a full list of properties.
Parameters
- path: string
  The path
- value: any
  The value
Returns boolean
Whether the value was set
- Defined in submodules/editor-api/src/asset.ts:161

unset

unset(path: string): boolean
Unsets value at path. See the Asset overview for a full list of properties.
Parameters
- path: string
  The path
Returns boolean
Whether the value was unset
- Defined in submodules/editor-api/src/asset.ts:171

`Static`getFileUrl

getFileUrl(id: number, filename: string): string
Gets the file URL for an asset file.
Parameters
- id: number
  The asset id
- filename: string
  The desired filename
Returns string
The file URL
- Defined in submodules/editor-api/src/asset.ts:338

Class Asset

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Asset

Accessors

history

Returns ObserverHistory

observer

Returns AssetObserver

Methods

delete

Returns Promise<void>

get

Parameters

Returns any

has

Parameters

Returns boolean

insert

Parameters

Returns boolean

instantiateTemplate

Parameters

OptionalextraData?: object

Optionalhistory?: boolean

Optionalindex?: number

Optionalselect?: boolean

Returns Promise<Entity>

json

Returns Record<string, any>

latest

Returns Asset

load

Returns Promise<void>

loadAndSubscribe

Returns Promise<void>

removeValue

Parameters

Returns boolean

replace

Parameters

Optionalhistory?: boolean

Returns void

set

Parameters

Returns boolean

unset

Parameters

Returns boolean

StaticgetFileUrl

Parameters

Returns string

Settings

On This Page

`Optional`extraData?: object

`Optional`history?: boolean

`Optional`index?: number

`Optional`select?: boolean

`Optional`history?: boolean

`Static`getFileUrl