charton

Appearance

charton API

charton API / @chart-on/ui / index / FavoritesKind

Interface: FavoritesKind ​

Defined in: ui/src/favorites.ts:57

A kind of favourites (see ShellFavorites.of): how many it keeps, which starred references can be used now, and how to use one. Built-in kinds are tool, interval, chart-style, indicator and symbol; give one of those ids to change its limit.

Properties ​

id ​

id: string

Defined in: ui/src/favorites.ts:59

A non-empty string other than __proto__, constructor or prototype.

limit? ​

optional limit?: number

Defined in: ui/src/favorites.ts:61

Most references the list holds; starring past it is refused (limit event), nothing is evicted. Default 30.

Methods ​

activate()? ​

optional activate(ref): void

Defined in: ui/src/favorites.ts:69

Use a starred reference, e.g. switch to it; see FavoritesList.activate.

Parameters ​

ref ​

string

Returns ​

void

isAvailable()? ​

optional isAvailable(ref): boolean

Defined in: ui/src/favorites.ts:67

Whether a starred reference can be used now, e.g. a symbol that is still listed. Surfaces grey out or skip the others, and keep them starred. Default: every reference can.

Parameters ​

ref ​

string

Returns ​

boolean