charton API / @chart-on/ui / index / FavoritesList
Interface: FavoritesList
Defined in: ui/src/favorites.ts:93
Starred references of one kind (e.g. 'interval', 'symbol'), from ShellFavorites.of(kind). Every kind shares the favourites' stored record; of('tool') is the same list the tool methods edit.
Properties
kind
readonlykind:string
Defined in: ui/src/favorites.ts:94
limit
readonlylimit:number
Defined in: ui/src/favorites.ts:96
Most references the list holds (FavoritesKind.limit).
Methods
activate()
activate(
ref):boolean
Defined in: ui/src/favorites.ts:117
Use a reference through its kind's activate; returns false when the kind has none or the reference cannot be used.
Parameters
ref
string
Returns
boolean
add()
add(
ref):boolean
Defined in: ui/src/favorites.ts:111
Append a reference. Returns false, changing nothing, when it is already starred, unknown (tools) or the list is full (limit fires then).
Parameters
ref
string
Returns
boolean
clear()
clear():
void
Defined in: ui/src/favorites.ts:120
Returns
void
get()
get():
string[]
Defined in: ui/src/favorites.ts:101
The starred references, in order, including ones that cannot be used now (e.g. a tool this chart does not register): those stay starred.
Returns
string[]
has()
has(
ref):boolean
Defined in: ui/src/favorites.ts:113
Parameters
ref
string
Returns
boolean
isAvailable()
isAvailable(
ref):boolean
Defined in: ui/src/favorites.ts:115
Whether a starred reference can be used now; see FavoritesKind.isAvailable.
Parameters
ref
string
Returns
boolean
move()
move(
from,to):void
Defined in: ui/src/favorites.ts:119
Move the entry at index from to index to (clamped).
Parameters
from
number
to
number
Returns
void
on()
on(
event,listener): () =>void
Defined in: ui/src/favorites.ts:122
Subscribe to changes of this kind's list or order; returns an unsubscribe function.
Parameters
event
"change"
listener
(payload) => void
Returns
() => void
remove()
remove(
ref):void
Defined in: ui/src/favorites.ts:112
Parameters
ref
string
Returns
void
set()
set(
refs):void
Defined in: ui/src/favorites.ts:106
Replace the list; empty strings and repeats are skipped (and, for 'tool', unknown tool types that are not starred already). Past the limit the rest is skipped and limit fires.
Parameters
refs
readonly string[]
Returns
void