pivotick v3.0.0

---

pivotic / GraphUI / RailModeDefinition

Interfaz: RailModeDefinition

Definido en: interfaces/GraphUI.ts:440

Un modo registrado en el carril modal: la puerta que un integrador construye por su cuenta Modo Explorar o Enriquecer mediante.

Los modos registrados se muestran debajo de un divisor, después de los cuatro modos integrados, ordenados por orden. Registre uno en cualquier momento de la vida del gráfico con graph.UIManager.addRailMode(), o desde el install de un complemento a través de ctx.addRailMode(). O devuelve un triturador.

Un modo 'pointer' posee el panel de herramientas contextual: declara tools, y puede agregue cualquier otra cosa a través de render. En cambio, un modo 'flyout' proporciona un flyout fábrica cuyo panel se abre mientras el modo está activo.

Ejemplo

const dispose = graph.UIManager.addRailMode({
    id: 'explore', label: 'Explore', icon: compassSvg, shortcut: 'E',
    tools: [{ id: 'expand', label: 'Expand', icon: plusSvg, kind: 'action', run: () => … }],
})

Propiedades

defaultTool?

optional defaultTool: string | null

Definido en: interfaces/GraphUI.ts:469

La herramienta en la que se basa este modo cuando no hay nada armado.

Predeterminado

null

---

flyout()?

optional flyout: (ui) => Flyout

Definido en: interfaces/GraphUI.ts:515

Crea el panel desplegable de este modo. Requerido para kind: 'flyout' e ignorado de lo contrario. El panel se monta en la ranura desplegable y se desmonta con el modo; el mode propio de la subclase debe ser igual al id de esta definición.

Parámetros

ui

UIManager

Devoluciones

Flyout

---

icon

icon: string

Definido en: interfaces/GraphUI.ts:449

Un hilo SVG, inyectado con innerHTML y no desinfectado: debe ser confiable. CSS lo ajusta a 20px en el riel.

---

id

id: string

Definido en: interfaces/GraphUI.ts:442

Identidad estable: lo que tiene la tienda y el data-mode en el botón del carril.

---

keepPanelOpen?

optional keepPanelOpen: boolean

Definido en: interfaces/GraphUI.ts:499

Mantenga el panel abierto cuando una de las herramientas de este modo esté armada. Armando normalmente colapsa el panel para que el lienzo quede claro: correcto para Select's Lasso, incorrecto para un modo cuyo panel es el espacio de trabajo y cuyas herramientas solo dicen cómo alimentarlo.

Predeterminado

false

---

kind?

optional kind: "pointer" | "flyout"

Definido en: interfaces/GraphUI.ts:455

'pointer' los modos poseen el panel de herramientas; Los modos 'flyout' abren una superposición de configuración y no tener herramientas.

Predeterminado

'pointer'

---

label

label: string

Definido en: interfaces/GraphUI.ts:444

La etiqueta del botón del carril, usada textualmente.

---

onEnter()?

optional onEnter: () => void

Definido en: interfaces/GraphUI.ts:517

Se llama cuando el modo se activa.

Devoluciones

void

---

onExit()?

optional onExit: () => void

Definido en: interfaces/GraphUI.ts:523

Se llama cuando se sale del modo y cuando se da de baja mientras está activo. Desarmar cualquiera que sea el modo armado aquí. No se solicita el desmontaje de la interfaz de usuario: use los trituradores que tenga El complemento ya rastrea eso.

Devoluciones

void

---

order?

optional order: number

Definido en: interfaces/GraphUI.ts:467

Orden de visualización entre modos registrados, ascendente. Pedidos iguales mantienen registro orden. No afecta a los modos integrados, que siempre son lo primero.

Predeterminado

0

---

panelOpen?

optional panelOpen: boolean

Definido en: interfaces/GraphUI.ts:475

Si el panel de herramientas se expande la primera vez que se ingresa al modo. El valor predeterminado es abierto para que las herramientas del modo sean detectables.

Predeterminado

true

---

panelResizable?

optional panelResizable: boolean

Definido en: interfaces/GraphUI.ts:492

Deje que el analista arrastre el panel de este modo más ancho o más estrecho por su borde derecho.

Desactivado de forma predeterminada: un panel de filas de iconos tiene un ancho derecho y un controlador en él es un control sin nada que hacer. Un modo cuyo panel es el espacio de trabajo: un formulario, una lista, un conjunto de resultados: es donde vale la pena ofrecer la elección. El ancho se recuerda. por modo para la sesión y no persiste, por lo que una recarga comienza desde panelWidth nuevamente.

Predeterminado

false

---

panelWidth?

optional panelWidth: number

Definido en: interfaces/GraphUI.ts:481

Qué ancho tiene el panel de herramientas de este modo, en píxeles. El ancho incorporado se adapta a una fila de icono + etiqueta; un modo cuya ranura render contiene un formulario o una lista necesita más.

Predeterminado

216

---

render()?

optional render: () => HTMLElement

Definido en: interfaces/GraphUI.ts:509

Contenido adicional del panel, adjunto debajo de las filas de herramientas: un control deslizante, un cuadro de búsqueda, cualquier cosa que las filas no puedan expresar. Se vuelve a invocar cada vez que se reconstruye el panel.

Devoluciones

HTMLElement

---

shortcut?

optional shortcut: string

Definido en: interfaces/GraphUI.ts:461

Una sola tecla que activa el modo, o alterna su panel cuando ya está activo. Registrado a través del administrador de combinación de teclas normal, por lo que una clave ya enlazada es sombreado (con una advertencia) hasta que se elimine este modo.

---

tools?

optional tools: RailTool[] | () => RailTool[]

Definido en: interfaces/GraphUI.ts:504

Las herramientas del modo, como filas en su panel. Pasar una función cuando el conjunto depende de la selección o los datos actuales; se vuelve a leer en cada render.