Ir al contenido

pivotick v3.0.0


pivotic / Nodo

clase: Node ​

Definido en: Node.ts:42

Representa un solo nodo (vértice) en un gráfico.

Accesorios ​

isGroup ​

Obtener firma ​

get isGroup(): boolean

Definido en: Node.ts:441

Cierto para un grupo dibujado por graph.simplify: un sustituto de sus miembros, nunca parte de los datos.

Devoluciones ​

boolean

Constructores ​

Constructor ​

new Node(id, data?, style?, domID?, children?): Node

Definido en: Node.ts:108

Cree una nueva instancia de nodo.

Parámetros ​

id ​

string

Identificador único para el nodo.

data? ​

NodeData

Carga útil de datos opcional asociada con el nodo

style? ​

Partial<NodeStyle>

domID? ​

string = ...

children? ​

Node[] = []

Devoluciones ​

Node

Métodos ​

ancestorChain() ​

ancestorChain(): Node[]

Definido en: Node.ts:400

Los grupos de nodos, primero los más externos: vacíos para un nodo del gráfico raíz.

Devoluciones ​

Node[]


canvasRepresentative() ​

canvasRepresentative(): Node

Definido en: Node.ts:419

El nodo que el lienzo realmente dibuja para este: él mismo cuando cada grupo encima de él de lo contrario, el grupo colapsado más externo (el cuadro que lo oculta) y en en cualquier caso, el grupo cerrado en el que se pliega el punto, si lo hay.

Esto responde "qué punto en la pantalla representa este nodo", no "es visible": un El clúster expandido genera un subgrafo separado construido a partir de datos toDict(), por lo que un Este gráfico nunca dibuja el nodo anidado, incluso cuando su grupo está abierto.

Devoluciones ​

Node


clone() ​

clone(): Node

Definido en: Node.ts:284

Devoluciones ​

Node


collapse() ​

collapse(): void

Definido en: Node.ts:388

Devoluciones ​

void


degree() ​

degree(): number

Definido en: Node.ts:395

Devoluciones ​

number


descendants() ​

descendants(): Node[]

Definido en: Node.ts:709

Cada nodo debajo de este, primero la profundidad.

Devoluciones ​

Node[]


expand() ​

expand(): void

Definido en: Node.ts:381

Devoluciones ​

void


freeze() ​

freeze(): void

Definido en: Node.ts:335

Devoluciones ​

void


getBorderBox() ​

getBorderBox(outset): NodeBorderBox | undefined

Definido en: Node.ts:513

El borde rectangular del nodo crece en outset, o undefined cuando el El nodo está anclado como un círculo.

Parámetros ​

outset ​

number = 0

Devoluciones ​

NodeBorderBox | undefined


getBorderDistance() ​

getBorderDistance(dirX, dirY, outset): number

Definido en: Node.ts:525

Distancia desde el centro del nodo hasta su borde a lo largo de la dirección de la unidad (dirX, dirY), crecido por outset - donde un borde sale en esa dirección debería comenzar. Rectangular para un nodo medido, el radio del círculo en caso contrario. Resolución deliberadamente libre de estilo: esto se ejecuta en ambos extremos de cada ventaja en cada tic.

Parámetros ​

dirX ​

number

dirY ​

number

outset ​

number = 0

Devoluciones ​

number


getCircleRadius() ​

getCircleRadius(): number

Definido en: Node.ts:465

Devoluciones ​

number


getCircleRadiusCollapsed() ​

getCircleRadiusCollapsed(): number

Definido en: Node.ts:473

Devoluciones ​

number


getConnectedNodes() ​

getConnectedNodes(): Node[]

Definido en: Node.ts:184

Devoluciones ​

Node[]


getConnectingNodes() ​

getConnectingNodes(): Node[]

Definido en: Node.ts:190

Devoluciones ​

Node[]


getData() ​

getData(): NodeData

Definido en: Node.ts:129

Obtenga los datos del nodo.

Devoluciones ​

NodeData


getEdgesIn() ​

getEdgesIn(): Edge[]

Definido en: Node.ts:200

Devoluciones ​

Edge[]


getEdgesOut() ​

getEdgesOut(): Edge[]

Definido en: Node.ts:196

Devoluciones ​

Edge[]


getGraphElement() ​

getGraphElement(): SVGGElement | null

Definido en: Node.ts:230

Devoluciones ​

SVGGElement | null


getLayoutRadius() ​

getLayoutRadius(): number

Definido en: Node.ts:496

El radio por el que el diseño espacia este nodo: su huella declarada donde la tenga, y en caso contrario cualquiera que sea la medida del dibujo. Cada fuerza lee esto; los cajones leen getCircleRadius, que es el tamaño dibujado.

Devoluciones ​

number


getLayoutSize() ​

getLayoutSize(): number | undefined

Definido en: Node.ts:487

El medio ancho de la huella declarada, o undefined cuando el dibujo posee el espaciado.

Devoluciones ​

number | undefined


getPotential() ​

getPotential(pivotId): number | undefined

Definido en: Node.ts:647

El potencial declarado para un pivote o, sin argumentos, el total declarado. sin ningún pivote en particular. undefined cuando no había ninguno.

Parámetros ​

pivotId ​

string = SUMMARY_POTENTIAL

Devoluciones ​

number | undefined


getPotentials() ​

getPotentials(): Map<string, number>

Definido en: Node.ts:652

Cada potencial declarado en este nodo, codificado por ID de pivote.

Devoluciones ​

Map<string, number>


getSources() ​

getSources(): string[]

Definido en: Node.ts:538

Las fuentes que respaldan este nodo: identificadores de pivote, más 'seed' para los datos que estaba aquí para empezar. Un nodo puede ser avalado por varios pivotes a la vez, y graph.removeBySource lo elimina solo cuando desaparece el último.

Devoluciones ​

string[]


getStyle() ​

getStyle(): Partial<NodeStyle>

Definido en: Node.ts:207

Obtenga los datos del nodo.

Devoluciones ​

Partial<NodeStyle>


hasChildren() ​

hasChildren(): boolean

Definido en: Node.ts:723

Devoluciones ​

boolean


hasSource() ​

hasSource(source): boolean

Definido en: Node.ts:543

Si source responde por este nodo. 'seed' es cierto para datos no dinamizados.

Parámetros ​

source ​

string

Devoluciones ​

boolean


hide() ​

hide(): void

Definido en: Node.ts:360

Devoluciones ​

void


markAsChild() ​

markAsChild(parentNode, childrenDepth): void

Definido en: Node.ts:727

Parámetros ​

parentNode ​

Node

childrenDepth ​

number

Devoluciones ​

void


markAsParent() ​

markAsParent(): void

Definido en: Node.ts:733

Devoluciones ​

void


removeChildById() ​

removeChildById(id): Node | undefined

Definido en: Node.ts:698

Suelte un hijo y su propio subárbol con él. Devuelve el niño eliminado para que el la persona que llama puede limpiar los restos de sus descendientes.

Parámetros ​

id ​

string

Devoluciones ​

Node | undefined


setBorderBox() ​

setBorderBox(width, height): void

Definido en: Node.ts:505

Declare que el borde del nodo es el rectángulo width×height centrado. en realidad se representa como, por lo que los bordes se detienen en él en lugar de en el círculo delimitador. Llámelo después setCircleRadius, lo que lo borra.

Parámetros ​

width ​

number

height ​

number

Devoluciones ​

void


setChildren() ​

setChildren(children): void

Definido en: Node.ts:656

Parámetros ​

children ​

Node[]

Devoluciones ​

void


setCircleRadius() ​

setCircleRadius(radius): void

Definido en: Node.ts:460

Establezca el radio del círculo del nodo. También elimina cualquier borde rectangular medido: el radio es un hecho más aproximado, por lo que cada persona que llama y cambia el tamaño de un nodo mantiene anclaje correcto por defecto, y sólo los cajones que conocen el renderizado forma opte por volver a través de setBorderBox.

Parámetros ​

radius ​

number

Devoluciones ​

void


setCircleRadiusCollapsed() ​

setCircleRadiusCollapsed(radius): void

Definido en: Node.ts:469

Parámetros ​

radius ​

number

Devoluciones ​

void


setData() ​

setData(newData): void

Definido en: Node.ts:137

Actualice los datos del nodo.

Parámetros ​

newData ​

NodeData

Nuevos datos para configurar

Devoluciones ​

void


setLayoutSize() ​

setLayoutSize(halfWidth): void

Definido en: Node.ts:482

Declare el cuadro que este nodo reserva en el diseño, como medio ancho en unidades de gráfico. A diferencia de setCircleRadius esto es constante: el dibujo puede cambiar dentro de él sin que nada se mueva.

Parámetros ​

halfWidth ​

number | undefined

Devoluciones ​

void


setPotential() ​

Firma de llamada ​

setPotential(count): void

Definido en: Node.ts:627

Declare cuánto más hay para este nodo, sin pedir nada. lo que muestra la insignia del borde. 0 borra la declaración.

Con una identificación de pivote, es el número de ese pivote y su insignia abre ese pivote. con un conteo solo es el total de todo, que es el número que 'summary' prefiere la insignia de llanta: la que se declara cuando hay más proveedores de lo que una llanta podría jamás nombrar.

Marca el nodo como sucio como cualquier otro configurador aquí, por lo que la insignia aparece en el próximo renderizado: llame a graph.renderer.update() si no hay nada más a punto de hacerlo.

ts
node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much
Parámetros ​
count ​

number

Devoluciones ​

void

Firma de llamada ​

setPotential(pivotId, count): void

Definido en: Node.ts:628

Declare cuánto más hay para este nodo, sin pedir nada. lo que muestra la insignia del borde. 0 borra la declaración.

Con una identificación de pivote, es el número de ese pivote y su insignia abre ese pivote. con un conteo solo es el total de todo, que es el número que 'summary' prefiere la insignia de llanta: la que se declara cuando hay más proveedores de lo que una llanta podría jamás nombrar.

Marca el nodo como sucio como cualquier otro configurador aquí, por lo que la insignia aparece en el próximo renderizado: llame a graph.renderer.update() si no hay nada más a punto de hacerlo.

ts
node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much
Parámetros ​
pivotId ​

string

count ​

number

Devoluciones ​

void


setStyle() ​

setStyle(newStyle): void

Definido en: Node.ts:215

Actualice los datos del nodo.

Parámetros ​

newStyle ​

Partial<NodeStyle>

Nuevos datos para configurar

Devoluciones ​

void


show() ​

show(): void

Definido en: Node.ts:356

Devoluciones ​

void


toDict() ​

toDict(dataOnly): Record<string, unknown>

Definido en: Node.ts:239

Convierta el nodo en una representación de objeto JSON simple.

Parámetros ​

dataOnly ​

boolean = false

predeterminado: falso

Devoluciones ​

Record<string, unknown>


toggleExpand() ​

toggleExpand(expanded?): void

Definido en: Node.ts:364

Parámetros ​

expanded? ​

boolean

Devoluciones ​

void


toggleVisibility() ​

toggleVisibility(visible): void

Definido en: Node.ts:347

Parámetros ​

visible ​

boolean

Devoluciones ​

void


toSimulationDTO() ​

toSimulationDTO(): SimulationNodeDTO

Definido en: Node.ts:267

Carga útil clonable estructurada para el trabajador de simulación (sin padres/hijos vivos/_subgrafo árbitros, a diferencia de clone()). El estilo está despojado de funciones: cada canal resoluble puede mantenga uno, y ninguna fuerza los lee, por lo que enviarlos solo corre el riesgo de un DataCloneError.

Devoluciones ​

SimulationNodeDTO


unfreeze() ​

unfreeze(): void

Definido en: Node.ts:341

Devoluciones ​

void


unionChildren() ​

unionChildren(children): Node[]

Definido en: Node.ts:674

Fusionar children por id: se agregan nuevos, se dejan los coincidentes intactos (sus propios hijos se fusionaron a su vez) y ninguno es eliminado jamás. el unión es cómo un pivote que redescubre un contenedor agrega lo que encontró sin perturbando lo que ya está ahí.

Parámetros ​

children ​

Node[]

Devoluciones ​

Node[]

cada nodo recién agregado, en cualquier profundidad, para que la persona que llama pueda registrarse y etiquetarlos.


updateData() ​

updateData(partialData): void

Definido en: Node.ts:147

Fusionar datos parciales con los datos del nodo actual. Útil para actualizar solo partes de los datos.

Parámetros ​

partialData ​

Partial<NodeData>

Objeto de datos parcial para fusionar

Devoluciones ​

void


updateStyle() ​

updateStyle(partialStyle): void

Definido en: Node.ts:225

Fusionar datos parciales con los datos del nodo actual. Útil para actualizar solo partes de los datos.

Parámetros ​

partialStyle ​

Partial<NodeStyle>

Objeto de datos parcial para fusionar

Devoluciones ​

void

Propiedades ​

children ​

children: Node[]

Definido en: Node.ts:45


childrenDepth ​

childrenDepth: number

Definido en: Node.ts:64


defaultCircleRadius ​

defaultCircleRadius: number = 10

Definido en: Node.ts:49


domID ​

readonly domID: string

Definido en: Node.ts:101


expanded? ​

optional expanded: boolean

Definido en: Node.ts:61


frozen? ​

optional frozen: boolean

Definido en: Node.ts:59


fx? ​

optional fx: number

Definido en: Node.ts:56


fy? ​

optional fy: number

Definido en: Node.ts:57


id ​

readonly id: string

Definido en: Node.ts:43


isChild ​

isChild: boolean

Definido en: Node.ts:63

Verdadero si este nodo es secundario dentro de un clúster colapsado


isParent ​

isParent: boolean

Definido en: Node.ts:66

Verdadero si este nodo tiene nodos secundarios


parentNode? ​

optional parentNode: Node

Definido en: Node.ts:68

Referencia al nodo del clúster principal (si este nodo es secundario)


visible ​

visible: boolean

Definido en: Node.ts:60


vx? ​

optional vx: number

Definido en: Node.ts:54


vy? ​

optional vy: number

Definido en: Node.ts:55


weight? ​

optional weight: number

Definido en: Node.ts:58


x? ​

optional x: number

Definido en: Node.ts:52


y? ​

optional y: number

Definido en: Node.ts:53