CustomAPIElement

MMO.elements · 1 symbol · generated 5 Oct 2026

mixin

CustomAPIElement

CustomAPIElement.js:11

API element WARNING: It is a class mixin. Meaning you extend it with a parameter

class MMO.elements.CustomAPIElement extends MMO.elements.CustomShadowElement(ClassElement)

Namespace: MMO.elements
Extends: CustomShadowElement(ClassElement)

Index

	data accessor	The entities of the last response, indexed by uid.
	url accessor	Point the element at some data, which starts loading as soon as it is visible.
	schema accessor
	constructor()
	setAPI(api)	Attach a requester and load it once the element becomes visible.
	reload()	Re-run the query, carrying the `loading` class for the duration and dispatching `load` when it settles.

Properties3

data

accessorCustomAPIElement.js:22

The entities of the last response, indexed by uid.

get data() set data(value)

Type: ?MMO.core.Map

url

accessorCustomAPIElement.js:36

Point the element at some data, which starts loading as soon as it is visible.

get url() set url(value)

Type: ?URL

schema

accessorCustomAPIElement.js:62

get schema() set schema(value)

Type: Promise<?MMO.schemas.Schema>

Methods3

constructor()

CustomAPIElement.js:12

constructor()

setAPI(api)

CustomAPIElement.js:81

Attach a requester and load it once the element becomes visible.

setAPI(api)

A requester pointing at the same url is ignored; a different one aborts the request still in flight.

api	MMO.core.APIRequester
throws	`MMO.TypeError`	on anything else

reload()

CustomAPIElement.js:97

Re-run the query, carrying the loading class for the duration and dispatching load when it settles.

reload()

returns Promise<Object> the entities