pivotic / ModeStore
Interfaz: ModeStore
Definido en: ui/ModeStore.ts:84
Un pequeño observable que contiene el estado del ferrocarril modal. El carril, panel de herramientas contextual y los menús laterales de configuración se suscriben a él; se envían clics/combinaciones de teclas. Los establecedores son idempotentes (solo notifican cuando el valor realmente cambia) y cada notificación lleva una instantánea nueva para que un oyente no pueda mutar la Estado interno de la tienda.
Los cuatro modos integrados siempre están presentes. Modos registrados a través de addRailMode se agregan con registerMode y mantienen el estado exactamente como lo hace un integrado.
subscribe se activa en solo cambios; renderizar el estado inicial de getState primero, luego suscríbete para recibir actualizaciones.
Métodos
armTool()
armTool(
mode,tool):void
Definido en: ui/ModeStore.ts:193
Arma una herramienta en modo puntero (la ranura del riel lo refleja). Idempotente.
Parámetros
mode
string
tool
string | null
Devoluciones
void
dispose()
dispose():
void
Definido en: ui/ModeStore.ts:218
Elimina a todos los suscriptores (llamado en el desmontaje de la interfaz de usuario).
Devoluciones
void
getArmedTool()
getArmedTool(
mode):string|null
Definido en: ui/ModeStore.ts:162
La herramienta armada para un modo de puntero ('pointer'/null = predeterminado).
Parámetros
mode
string
Devoluciones
string | null
getDefaultTool()
getDefaultTool(
mode):string|null
Definido en: ui/ModeStore.ts:118
La herramienta en la que se basa un modo cuando no hay nada especial armado.
Parámetros
mode
string
Devoluciones
string | null
getMode()
getMode():
string
Definido en: ui/ModeStore.ts:103
Devoluciones
string
getState()
getState():
Readonly<ModeState>
Definido en: ui/ModeStore.ts:172
Una copia del estado actual (segura de leer; las mutaciones no se filtran).
Devoluciones
Readonly<ModeState>
hasMode()
hasMode(
mode):boolean
Definido en: ui/ModeStore.ts:113
Si un modo está registrado actualmente (los cuatro integrados siempre lo están).
Parámetros
mode
string
Devoluciones
boolean
isFlyoutActive()
isFlyoutActive(
mode):boolean
Definido en: ui/ModeStore.ts:147
Si un menú lateral está abierto (es decir, su modo es el activo).
Parámetros
mode
string
Devoluciones
boolean
isPanelOpen()
isPanelOpen(
mode):boolean
Definido en: ui/ModeStore.ts:167
Si el panel de herramientas del modo puntero está actualmente expandido.
Parámetros
mode
string
Devoluciones
boolean
isPointerMode()
isPointerMode(
mode):boolean
Definido en: ui/ModeStore.ts:108
Si un modo es propietario del panel de herramientas. Los modos desconocidos no son modos de puntero.
Parámetros
mode
string
Devoluciones
boolean
isViewActive()
isViewActive():
boolean
Definido en: ui/ModeStore.ts:152
Devoluciones
boolean
Deprecated
use isFlyoutActive('view'): el riel ahora tiene más de un menú lateral.
registerMode()
registerMode(
mode,kind,defaultTool,panelOpen):void
Definido en: ui/ModeStore.ts:127
Agregue el estado de un modo a la tienda. Convocado por el registro del modo ferroviario; los cuatro Los elementos incorporados ya están presentes. Volver a registrar una identificación sobrescribe su registro pero se mantiene cualquier estado de herramienta/panel que ya tuviera.
Parámetros
mode
string
kind
defaultTool
string | null
panelOpen
boolean = true
Devoluciones
void
setMode()
setMode(
mode):void
Definido en: ui/ModeStore.ts:180
Parámetros
mode
string
Devoluciones
void
setPanelOpen()
setPanelOpen(
mode,open):void
Definido en: ui/ModeStore.ts:200
Expandir/contraer el panel de herramientas de un modo de puntero. Idempotente.
Parámetros
mode
string
open
boolean
Devoluciones
void
subscribe()
subscribe(
listener): () =>void
Definido en: ui/ModeStore.ts:212
Suscríbete a los cambios de estado. Devuelve una función de cancelación de suscripción (pasar a UIComponent.track).
Parámetros
listener
ModeListener
Devoluciones
():
void
Devoluciones
void
toggleFlyout()
toggleFlyout(
mode):void
Definido en: ui/ModeStore.ts:188
Abra un modo flotante o ciérrelo hasta el último modo de puntero.
Parámetros
mode
string
Devoluciones
void
toggleToolPanel()
toggleToolPanel(
mode):void
Definido en: ui/ModeStore.ts:207
Alternar entre abrir y cerrar el panel de herramientas de un modo de puntero.
Parámetros
mode
string
Devoluciones
void
toggleView()
toggleView():
void
Definido en: ui/ModeStore.ts:157
Devoluciones
void
Deprecated
use toggleFlyout('view'): el riel ahora tiene más de un menú lateral.
unregisterMode()
unregisterMode(
mode):void
Definido en: ui/ModeStore.ts:138
Elimina el estado de un modo. La persona que llama es responsable de salir primero: la tienda. no decidirá qué activar en su lugar.
Parámetros
mode
string
Devoluciones
void