Ir al contenido

pivotick v3.0.0


pivotic / Pivotick

clase: Pivotick ​

Definido en: Graph.ts:26

Constructores ​

Constructor ​

new Pivotick(container, data?, options?): Graph

Definido en: Graph.ts:87

Inicializa un gráfico dentro del contenedor especificado utilizando los datos y las opciones proporcionados.

Parámetros ​

container ​

HTMLElement

El HTMLElement que servirá como contenedor principal del gráfico.

data? ​

RelaxedGraphData

Los datos del gráfico, incluidos los nodos y los bordes, que se van a representar.

options? ​

Partial<GraphOptions>

Configuración opcional para el comportamiento del gráfico, UI, estilo, simulación, etc.

Devoluciones ​

Graph

Métodos ​

addEdge() ​

addEdge(e): Edge

Definido en: Graph.ts:1000

Agrega un borde al gráfico.

Tanto el nodo de origen (from) como el de destino (to) ya deben existir en el gráfico. Genera un error si ya existe un borde con el mismo ID.

Parámetros ​

e ​

La ventaja para agregar.

Edge | RawEdge

Devoluciones ​

Edge

Lanza ​

Error si el ID de borde ya existe o si alguno de los nodos no existe. Se activa onChange después de que el borde se agrega correctamente.


addNode() ​

addNode(n): Node

Definido en: Graph.ts:902

Agrega un nodo al gráfico.

Parámetros ​

n ​

Node | RawNode

Devoluciones ​

Node

Lanza ​

Error si ya existe un nodo con el mismo id. Se activa onChange después de que el nodo se agrega correctamente.


addNote() ​

addNote(n): Note | undefined

Definido en: Graph.ts:1265

Agrega una nota al gráfico y lo dibuja. Toma las mismas opciones que data.notes (lo que devuelve Nota.toJSON), o un Note. Emite noteAdd.

Parámetros ​

n ​

Note | NoteOptions

Devoluciones ​

Note | undefined

la nota, o undefined mientras UI.notes.enabled es false.

Lanza ​

Error si ya existe una nota con el mismo id.


addToSelection() ​

addToSelection(nodes): void

Definido en: Graph.ts:1637

Agrega nodos a la selección actual, dejando lo que ya está seleccionado en su lugar. Los nodos ya seleccionados se ignoran.

Solo nodos: la capa de interacción no tiene un definidor aditivo para los bordes, que solo puede seleccionarse como un conjunto completo mediante selectElements.

Parámetros ​

nodes ​

Node[]

Los Nodes para sumar.

Devoluciones ​

void


clearEmphasis() ​

clearEmphasis(): void

Definido en: Graph.ts:1726

Finalice el énfasis emphasiseElements iniciado: el lienzo vuelve a leerse normalmente.

Devoluciones ​

void


clearForecast() ​

clearForecast(): void

Definido en: Graph.ts:1745

Baja el pronóstico.

Devoluciones ​

void


clearHighlightedElements() ​

clearHighlightedElements(): void

Definido en: Graph.ts:1707

Elimine cualquier clase resaltada de cualquier nodo o borde

Devoluciones ​

void


closeTable() ​

closeTable(): void

Definido en: Graph.ts:1669

Cierra la base de datos.

Devoluciones ​

void


deselectAll() ​

deselectAll(): void

Definido en: Graph.ts:1681

Deseleccionar todo

Devoluciones ​

void


destroy() ​

destroy(): void

Definido en: Graph.ts:1444

Destruye todos los componentes de la interfaz de usuario.

Devoluciones ​

void


edgeVisibilityChanged() ​

edgeVisibilityChanged(): void

Definido en: Graph.ts:1388

Repintar después de un cambio de capa de borde. Deliberadamente no onChange: capas No toque la fuerza del enlace (ver Simulation.getActiveEdges), por lo que reiniciar el La simulación movería el gráfico sin ningún motivo.

Devoluciones ​

void


emphasiseElements() ​

emphasiseElements(elements): void

Definido en: Graph.ts:1721

Elija un conjunto de elementos del gráfico: mantienen el aspecto que ya tienen mientras todo lo demás en el lienzo se oscurece, hasta clearEmphasis. esto es cómo al pasar el cursor sobre una entrada de leyenda se lee su categoría fuera del lienzo.

Donde highlightElement apunta a un elemento, esto describe un grupo. Los elementos que no están dibujados en este momento se omiten y un conjunto vacío no atenúa nada.

Parámetros ​

elements ​

(Node | Edge)[]

Los Nodes y Edges para enfatizar.

Devoluciones ​

void


focusElement() ​

focusElement(element): void

Definido en: Graph.ts:1583

Enfoca el nodo o borde especificado dentro de la vista del gráfico. Un nodo escondido en un grupo o grupo cerrado enfoca ese grupo o grupo.

Parámetros ​

element ​

El Node o Edge para enfocar.

Node | Edge | Note

Devoluciones ​

void


getAppID() ​

getAppID(): string

Definido en: Graph.ts:1456

El ID de la aplicación

Devoluciones ​

string


getConnectedNodes() ​

getConnectedNodes(node): Node[]

Definido en: Graph.ts:1241

Recupera todos los nodos conectados directamente desde el nodo dado.

Devuelve nodos clonados para evitar modificaciones externas.

Parámetros ​

node ​

El nodo o ID de nodo desde el que buscar conexiones.

string | Node

Devoluciones ​

Node[]

Una matriz de objetos Node conectados directamente desde el nodo dado.


getEdge() ​

getEdge(id): Edge | undefined

Definido en: Graph.ts:1036

Recupera una arista del gráfico por su ID.

Devuelve un clon profundo del borde para evitar mutaciones externas.

Parámetros ​

id ​

string

El ID del borde.

Devoluciones ​

Edge | undefined

Un Edge clonado si se encuentra, en caso contrario undefined.


getEdgeCount() ​

getEdgeCount(): number

Definido en: Graph.ts:1086

Devuelve el número de aristas actualmente en el gráfico.

Devoluciones ​

number

El recuento total de aristas.


getEdges() ​

getEdges(): Edge[]

Definido en: Graph.ts:1168

Recupera todos los bordes del gráfico.

Devuelve clones de los bordes para evitar modificaciones externas.

Devoluciones ​

Edge[]

Una serie de objetos Edge clonados.


getEdgesFromNode() ​

getEdgesFromNode(node): Edge[]

Definido en: Graph.ts:1211

Encuentra todos los bordes que se originan en un nodo determinado.

Devuelve bordes clonados para evitar modificaciones externas.

Parámetros ​

node ​

El nodo o ID de nodo desde el que buscar los bordes salientes.

string | Node

Devoluciones ​

Edge[]

Una matriz de Edge objetos cuyo nodo from coincide con la consulta.


getEdgesToNode() ​

getEdgesToNode(node): Edge[]

Definido en: Graph.ts:1226

Encuentra todos los bordes que apuntan a un nodo determinado.

Devuelve bordes clonados para evitar modificaciones externas.

Parámetros ​

node ​

El nodo o ID de nodo para buscar bordes entrantes.

string | Node

Devoluciones ​

Edge[]

Una matriz de Edge objetos cuyo nodo to coincide con la consulta.


getGraphDepth() ​

getGraphDepth(): number

Definido en: Graph.ts:1566

Devoluciones ​

number


getMutableEdge() ​

getMutableEdge(id): Edge | undefined

Definido en: Graph.ts:1052

Recupera una arista del gráfico por su ID.

Devuelve la instancia de borde real, lo que permite modificaciones directas.

Advertencia: La modificación directa de los bordes con este método puede provocar un comportamiento inesperado. Generalmente es más seguro usar getEdge, que devuelve una instancia clonada.

Parámetros ​

id ​

string

El ID del borde.

Devoluciones ​

Edge | undefined

El Edge si se encuentra, de lo contrario undefined.


getMutableEdges() ​

getMutableEdges(): Edge[]

Definido en: Graph.ts:1184

Recupera todos los bordes del gráfico.

Devuelve las instancias de borde reales, lo que permite modificaciones directas.

Devoluciones ​

Edge[]

Una serie de objetos Edge.

Observaciones ​

⚠️ Advertencia: La modificación directa de los bordes puede provocar un comportamiento inesperado. Utilice getEdges en su lugar para trabajar con clones seguros.


getMutableNode() ​

getMutableNode(id): Node | undefined

Definido en: Graph.ts:943

Recupera un nodo del gráfico por su ID.

Devuelve la instancia del nodo real, lo que permite modificaciones directas.

Advertencia: La modificación directa de los nodos mediante este método puede provocar un comportamiento inesperado. Generalmente es más seguro usar getNode, que devuelve una instancia clonada.

Parámetros ​

id ​

El ID del nodo o de un objeto Nodo.

string | Node

Devoluciones ​

Node | undefined

El Node si se encuentra, de lo contrario undefined.


getMutableNodes() ​

getMutableNodes(): Node[]

Definido en: Graph.ts:1114

Recupera todos los nodos del gráfico.

Devuelve las instancias de nodos reales, lo que permite modificaciones directas.

Devoluciones ​

Node[]

Una serie de objetos Node.

Observaciones ​

⚠️ Advertencia: La modificación directa de los nodos puede provocar un comportamiento inesperado. Generalmente es más seguro usar getNodes, que devuelve instancias clonadas.


getMutableVisibleEdges() ​

getMutableVisibleEdges(): Edge[]

Definido en: Graph.ts:1199

Recupera todos los bordes visibles en el gráfico.

Devuelve las instancias de borde reales, lo que permite modificaciones directas.

Devoluciones ​

Edge[]

Una serie de objetos Edge.

Observaciones ​

⚠️ Advertencia: La modificación directa de los bordes puede provocar un comportamiento inesperado. Utilice getEdges en su lugar para trabajar con clones seguros.


getMutableVisibleNodes() ​

getMutableVisibleNodes(): Node[]

Definido en: Graph.ts:1130

Recupera todos los nodos visibles en el gráfico. Agregar recursivamente niños visibles

Devuelve las instancias de nodos reales, lo que permite modificaciones directas.

Devoluciones ​

Node[]

Una serie de objetos Node.

Observaciones ​

⚠️ Advertencia: La modificación directa de los nodos puede provocar un comportamiento inesperado. Generalmente es más seguro usar getNodes, que devuelve instancias clonadas.


getNode() ​

getNode(id): Node | undefined

Definido en: Graph.ts:927

Recupera un nodo del gráfico por su ID.

Devuelve un clon profundo del nodo para evitar mutaciones externas.

Parámetros ​

id ​

El ID del nodo o de un objeto Nodo.

string | Node

Devoluciones ​

Node | undefined

Un Node clonado si se encuentra, en caso contrario undefined.


getNodeCount() ​

getNodeCount(): number

Definido en: Graph.ts:1077

Devuelve el número de nodos actualmente en el gráfico.

Devoluciones ​

number

El recuento total de nodos.


getNodes() ​

getNodes(): Node[]

Definido en: Graph.ts:1097

Recupera todos los nodos del gráfico.

Devuelve clones de los nodos para evitar modificaciones externas.

Devoluciones ​

Node[]

Una serie de objetos Node clonados.


getNote() ​

getNote(id): Note | undefined

Definido en: Graph.ts:1254

Parámetros ​

id ​

string

Devoluciones ​

Note | undefined


getNotes() ​

getNotes(): Note[]

Definido en: Graph.ts:1250

Devoluciones ​

Note[]


getOptions() ​

getOptions(): GraphOptions

Definido en: Graph.ts:693

Devuelve las opciones de configuración actuales del gráfico.

Devoluciones ​

GraphOptions


hideNode() ​

hideNode(node): void

Definido en: Graph.ts:1393

Parámetros ​

node ​

Node

Devoluciones ​

void


highlightElement() ​

highlightElement(element): void

Definido en: Graph.ts:1690

Agregue una clase resaltada al nodo o borde dado

Parámetros ​

element ​

El Node o Edge para resaltar.

Node | Edge

Devoluciones ​

void


nextTick() ​

nextTick(): void

Definido en: Graph.ts:1430

Activa la siguiente actualización de renderizado del gráfico.

Devoluciones ​

void


nextTickFor() ​

nextTickFor(nodes): void

Definido en: Graph.ts:1437

Activa la siguiente actualización de renderizado del gráfico para las materias aprobadas.

Parámetros ​

nodes ​

Node[]

Devoluciones ​

void


noteAdd() ​

noteAdd(note): void

Definido en: Graph.ts:422

Parámetros ​

note ​

Note

Devoluciones ​

void


noteChange() ​

noteChange(note): void

Definido en: Graph.ts:425

Parámetros ​

note ​

Note

Devoluciones ​

void


noteRemove() ​

noteRemove(note): void

Definido en: Graph.ts:428

Parámetros ​

note ​

Note

Devoluciones ​

void


off() ​

off<K>(event, handler): void

Definido en: Graph.ts:258

Tipo de parámetros ​

K ​

K extiende clave de GraphEvents

Parámetros ​

event ​

K

handler ​

GraphEvents[K]

Devoluciones ​

void


on() ​

on<K>(event, handler): void

Definido en: Graph.ts:251

Tipo de parámetros ​

K ​

K extiende clave de GraphEvents

Parámetros ​

event ​

K

handler ​

GraphEvents[K]

Devoluciones ​

void


openTable() ​

openTable(): void

Definido en: Graph.ts:1662

Abre la base de datos: las filas del gráfico como una cuadrícula seleccionable y ordenable se dividen la parte inferior del lienzo. modo full únicamente, y sólo cuando UI.table lo permita; De lo contrario, no se realizará ninguna operación.

El muelle ahora puede contener paneles además de la mesa, por lo que esto también trae la mesa panel al frente: la llamada tiene el nombre de la tabla y debería mostrarle una. alcanzar para UIManager.dock o activateDockTab() para conducir la región sin eso.

Devoluciones ​

void


removeBySource() ​

removeBySource(source): object

Definido en: Graph.ts:592

Elimine todo lo que avala una fuente. Un elemento que avalan varias fuentes sobrevive, un reclamo es más ligero: sigue la misma regla uniforme para deshacer, y el La única forma en que se elimina todo lo que trajo un pivote.

Es una operación directa y una entrada en historial: deshacerla devuelve lo que quedó y devuelve el reclamo de la fuente a lo que quedó.

Parámetros ​

source ​

string

Una identificación de pivote, o 'seed' para datos que nunca fueron pivotados.

Devoluciones ​

object

Lo que realmente fue eliminado.

edges ​

edges: Edge[]

nodes ​

nodes: Node[]


removeEdge() ​

removeEdge(id): void

Definido en: Graph.ts:1062

Elimina un borde del gráfico por su ID.

Parámetros ​

id ​

string

El ID del borde que se va a eliminar. Se activa onChange después de eliminar el borde.

Devoluciones ​

void


removeFromSelection() ​

removeFromSelection(nodes): void

Definido en: Graph.ts:1648

Elimina nodos de la selección actual y deja el resto en su lugar. Solo nodos, en los mismos términos que addToSelection.

Parámetros ​

nodes ​

Node[]

Los Nodes para eliminar.

Devoluciones ​

void


removeNode() ​

removeNode(id): void

Definido en: Graph.ts:969

Elimina un nodo del gráfico por su ID.

También elimina cualquier borde conectado al nodo.

Parámetros ​

id ​

string

El ID del nodo que se va a eliminar. Se activa onChange después de que se eliminan el nodo y sus bordes.

Devoluciones ​

void


selectElement() ​

selectElement(element): void

Definido en: Graph.ts:1593

Selecciona un nodo o borde determinado en el gráfico. Un nodo oculto en un clúster o grupo cerrado sigue siendo el seleccionado; el lienzo ilumina el racimo o grupo dibujado para él.

Parámetros ​

element ​

El Node o Edge para seleccionar.

Node | Edge

Devoluciones ​

void


selectElements() ​

selectElements(elements): void

Definido en: Graph.ts:1610

Selecciona varios nodos o varios bordes, reemplazando la selección actual: el plural selectElement, resolviendo el identificador renderizado de cada elemento por usted.

Los nodos y los bordes no se pueden seleccionar juntos (la capa de interacción borra un tipo cuando el otro está configurado), por lo que una matriz mixta selecciona los nodos y advierte.

Parámetros ​

elements ​

(Node | Edge)[]

Los Nodes o Edges para seleccionar. Una matriz vacía borra la selección.

Devoluciones ​

void


setData() ​

setData(nodes, edges, notes): void

Definido en: Graph.ts:852

Reemplaza todos los nodos y bordes actuales en el gráfico con los datos proporcionados. Borra los nodos y bordes existentes antes de configurar los nuevos. Activa la devolución de llamada onChange después de la actualización.

Parámetros ​

nodes ​

Node[] = []

Matriz de nodos para configurar. El valor predeterminado es una matriz vacía.

edges ​

Edge[] = []

Conjunto de bordes para configurar. El valor predeterminado es una matriz vacía.

notes ​

Note[] = []

Devoluciones ​

void


setLegend() ​

setLegend(config?): void

Definido en: Graph.ts:450

Reemplace la leyenda del lienzo en tiempo de ejecución, el gemelo imperativo de UI.legend. Un gráfico que comenzó sin uno se construye en el acto; false se vacía la leyenda y suelta su filtro, y true / undefined vuelve a caer derivando uno de render.nodeTypeAccessor. pasar un LegendGroupOptions para introducir el gráfico en varias dimensiones a la vez.

Parámetros ​

config? ​

La leyenda para mostrar, o false para eliminarla.

boolean | LegendOptions | LegendGroupOptions

Devoluciones ​

void


setNotes() ​

setNotes(notes): Note[]

Definido en: Graph.ts:1282

Reemplaza las notas del gráfico, dejando solos los nodos y los bordes. Las notas se corresponden con id: uno que ya está en el lienzo se actualiza en su lugar, por lo que su dibujo permanece vinculado a él, se elimina uno que no está en notes y se agrega uno nuevo.

Parámetros ​

notes ​

(Note | NoteOptions)[]

Devoluciones ​

Note[]

las notas ahora en el gráfico, en el orden dado.

Lanza ​

Error si dos entradas comparten una identificación. Entonces no se cambia nada.


setVisibleNodes() ​

setVisibleNodes(nodes, notify): boolean

Definido en: Graph.ts:1356

Devuelve si algo se movió, por lo que un cambio de filtro de solo borde puede volver a pintarse. notify está desactivado para el primer paso del motor de consulta, que se ejecuta antes de que se realice algo. dibujado: el simulation.update() / renderer.init() del constructor síguelo.

Parámetros ​

nodes ​

Node[]

notify ​

boolean = true

Devoluciones ​

boolean


showForecast() ​

showForecast(forecast): void

Definido en: Graph.ts:1740

Pinte lo que haría una acción ** y no cambie nada más: los elementos que haría quitar el drenaje en su lugar, los que escondería con ellos, y lo que sea traería de regreso se describe dónde aterrizaría.

Donde emphasiseElements lee un conjunto fuera del lienzo retrocediendo el resto, un pronóstico responde "¿qué sucede si hago clic?", por lo que el gráfico debe mantenerse leyendo normalmente sobre los pocos elementos que cambiarían. graph.history.preview(...) devuelve uno ya preparado.

Parámetros ​

forecast ​

GraphForecast

Devoluciones ​

void


showNode() ​

showNode(node): void

Definido en: Graph.ts:1404

Parámetros ​

node ​

Node

Devoluciones ​

void


toggleExpandNode() ​

toggleExpandNode(node): void

Definido en: Graph.ts:1415

Parámetros ​

node ​

Node

Devoluciones ​

void


toggleExpandNodes() ​

toggleExpandNodes(nodes): void

Definido en: Graph.ts:1420

Parámetros ​

nodes ​

Node[]

Devoluciones ​

void


toggleTable() ​

toggleTable(): void

Definido en: Graph.ts:1674

Abre la base de datos si está cerrada, la cierra si está abierta.

Devoluciones ​

void


unHighlightElement() ​

unHighlightElement(element): void

Definido en: Graph.ts:1699

Eliminar una clase resaltada al nodo o borde dado

Parámetros ​

element ​

El Node o Edge para seleccionar.

Node | Edge

Devoluciones ​

void


updateData() ​

updateData(newNodes?, newEdges?, triggerChangeEvent?): void

Definido en: Graph.ts:764

Actualiza el gráfico con nuevos nodos y/o aristas.

Una identificación que el gráfico ya contiene se actualiza en su lugar: cuál es el elemento es - sus datos, estilo y peso, se convierte en lo que entregaste, mientras que el objeto mantiene su identidad. Tiene que funcionar de esa manera. Sus aristas, la simulación. y el enlace DOM contiene ese objeto, al igual que todo lo que ha aprendido. desde su construcción: qué fuentes lo avalan, dónde se asienta, si está fijado. Una posición en el elemento entrante aún gana, por lo que updateData puede moverse algo además de actualizarlo. Se agregan identificadores desconocidos.

Los children de un contenedor no se reestructuran aquí: pase el contenedor a través removeNode y addNode para cambiar lo que contiene.

La llamada completa es un lote: uno dataBatchChanged que enumera cada adición y cambio en el orden dado, luego se vuelve a renderizar, por muchos elementos que lleve.

Parámetros ​

newNodes? ​

Node[]

Matriz opcional de nodos para actualizar o agregar.

newEdges? ​

Edge[]

Matriz opcional de bordes para actualizar o agregar.

triggerChangeEvent? ​

boolean = true

Anuncie los cambios implementados. Las adiciones se anuncian de cualquier manera.

Devoluciones ​

void


use() ​

use(plugin): this

Definido en: Graph.ts:246

Instale un PivotickPlugin. Se puede llamar en cualquier momento: el complemento Los elementos de la interfaz de usuario están actualizados hasta la fase actual del ciclo de vida. Devoluciones this para encadenar.

Parámetros ​

plugin ​

PivotickPlugin

Devoluciones ​

this

Propiedades ​

editing ​

readonly editing: GraphEditingManager

Definido en: Graph.ts:45


history ​

readonly history: GraphHistory

Definido en: Graph.ts:57

Qué contiene y muestra el lienzo, y cómo surgió: cada ingesta, eliminación, Piel duradera y elemento dibujado a mano, contiguamente reversible. Acotado y con alcance de sesión: no sobrevive a una recarga.


i18n ​

readonly i18n: I18n

Definido en: Graph.ts:68

El idioma en el que este gráfico escribe su propio texto, desde GraphOptions.i18n: mensaje formatos de búsqueda, plurales y números, listas y ordenaciones. Un gráfico anidado comparte su de los padres.


noteManager ​

noteManager: NoteManager

Definido en: Graph.ts:31


notifier ​

notifier: Notifier

Definido en: Graph.ts:32


pivots ​

readonly pivots: PivotManager

Definido en: Graph.ts:51

El tiempo de ejecución dinámico: registrar enriquecimientos, ejecutarlos, clasificar lo que devuelven, y deshacer una ejecución completa. Vive en Graph en lugar de en la interfaz de usuario porque gira produce data y porque tiene que existir antes de que se cree la interfaz de usuario.


queryEngine ​

queryEngine: GraphQueryEngine

Definido en: Graph.ts:35


renderer ​

renderer: GraphRenderer

Definido en: Graph.ts:33


simplify ​

readonly simplify: Simplification

Definido en: Graph.ts:62

Pliega los nodos que desempeñan el mismo papel en un grupo dibujado en su lugar. los grupos son el estado de vista: getNodes(), getEdges(), la tabla y el historial ven los miembros.


simulation ​

simulation: Simulation

Definido en: Graph.ts:34