pivotick v3.0.0

---

pivotick / Nó

Classe: Node

Definido em: Node.ts:42

Representa um único nó (vértice) em um gráfico.

Acessores

isGroup

Assinatura do getter

get isGroup(): boolean

Definido em: Node.ts:441

Verdadeiro para um grupo desenhado por graph.simplify: um substituto para seus membros, nunca parte dos dados.

Retorno

boolean

Construtores

Construtor

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

Definido em: Node.ts:108

Crie uma nova instância do Node.

Parâmetros

id

string

Identificador exclusivo do nó

data?

NodeData

Carga útil de dados opcional associada ao nó

style?

Partial<NodeStyle>

domID?

string = ...

children?

Node[] = []

Retorno

Node

Métodos

ancestorChain()

ancestorChain(): Node[]

Definido em: Node.ts:400

Os clusters do nó, os mais externos primeiro - vazios para um nó do gráfico raiz.

Retorno

Node[]

---

canvasRepresentative()

canvasRepresentative(): Node

Definido em: Node.ts:419

O nó que a tela realmente desenha para este: ele mesmo quando cada cluster acima dele é expandido, caso contrário, o cluster mais externo colapsado — a caixa que o esconde — e em ambos os casos o grupo fechado no qual o ponto é dobrado, se houver.

Isso responde "qual ponto na tela representa este nó", e não "é visível": um cluster expandido renderiza um subgráfico separado construído a partir de dados toDict(), portanto, um nó aninhado nunca é desenhado por este gráfico, mesmo quando seu cluster está aberto.

Retorno

Node

---

clone()

clone(): Node

Definido em: Node.ts:284

Retorno

Node

---

collapse()

collapse(): void

Definido em: Node.ts:388

Retorno

void

---

degree()

degree(): number

Definido em: Node.ts:395

Retorno

number

---

descendants()

descendants(): Node[]

Definido em: Node.ts:709

Cada nó abaixo deste, profundidade primeiro.

Retorno

Node[]

---

expand()

expand(): void

Definido em: Node.ts:381

Retorno

void

---

freeze()

freeze(): void

Definido em: Node.ts:335

Retorno

void

---

getBorderBox()

getBorderBox(outset): NodeBorderBox | undefined

Definido em: Node.ts:513

A borda retangular do nó aumentada em outset ou undefined quando o nó está ancorado como um círculo.

Parâmetros

outset

number = 0

Retorno

NodeBorderBox | undefined

---

getBorderDistance()

getBorderDistance(dirX, dirY, outset): number

Definido em: Node.ts:525

Distância do centro do nó até sua borda ao longo da direção da unidade (dirX, dirY), aumentada por outset — onde uma aresta saindo nessa direção deve começar. Retangular para um nó medido; caso contrário, o raio do círculo. Deliberadamente livre de resolução de estilo: isso é executado em ambas as extremidades de cada aresta em cada tick.

Parâmetros

dirX

number

dirY

number

outset

number = 0

Retorno

number

---

getCircleRadius()

getCircleRadius(): number

Definido em: Node.ts:465

Retorno

number

---

getCircleRadiusCollapsed()

getCircleRadiusCollapsed(): number

Definido em: Node.ts:473

Retorno

number

---

getConnectedNodes()

getConnectedNodes(): Node[]

Definido em: Node.ts:184

Retorno

Node[]

---

getConnectingNodes()

getConnectingNodes(): Node[]

Definido em: Node.ts:190

Retorno

Node[]

---

getData()

getData(): NodeData

Definido em: Node.ts:129

Obtenha os dados do nó.

Retorno

NodeData

---

getEdgesIn()

getEdgesIn(): Edge[]

Definido em: Node.ts:200

Retorno

Edge[]

---

getEdgesOut()

getEdgesOut(): Edge[]

Definido em: Node.ts:196

Retorno

Edge[]

---

getGraphElement()

getGraphElement(): SVGGElement | null

Definido em: Node.ts:230

Retorno

SVGGElement | null

---

getLayoutRadius()

getLayoutRadius(): number

Definido em: Node.ts:496

O raio pelo qual o layout espaça este nó: sua pegada declarada onde houver e, caso contrário, qualquer que seja o desenho medido. Cada força lê isto; as gavetas dizem getCircleRadius, que é o tamanho desenhado.

Retorno

number

---

getLayoutSize()

getLayoutSize(): number | undefined

Definido em: Node.ts:487

A meia largura declarada da pegada, ou undefined quando o desenho possui o espaçamento.

Retorno

number | undefined

---

getPotential()

getPotential(pivotId): number | undefined

Definido em: Node.ts:647

O potencial declarado para um pivô ou — sem argumento — o total declarado para nenhum pivô específico. undefined quando não havia nenhum.

Parâmetros

pivotId

string = SUMMARY_POTENTIAL

Retorno

number | undefined

---

getPotentials()

getPotentials(): Map<string, number>

Definido em: Node.ts:652

Cada potencial declarado neste nó, codificado pelo ID do pivô.

Retorno

Map<string, number>

---

getSources()

getSources(): string[]

Definido em: Node.ts:538

As fontes que atestam este nó - IDs de pivô, mais 'seed' para dados que estavam aqui para começar. Um nó pode ser garantido por vários pivôs ao mesmo tempo, e graph.removeBySource o exclui somente quando o último vai embora.

Retorno

string[]

---

getStyle()

getStyle(): Partial<NodeStyle>

Definido em: Node.ts:207

Obtenha os dados do nó.

Retorno

Partial<NodeStyle>

---

hasChildren()

hasChildren(): boolean

Definido em: Node.ts:723

Retorno

boolean

---

hasSource()

hasSource(source): boolean

Definido em: Node.ts:543

Se source atesta este nó. 'seed' é verdadeiro para dados não dinâmicos.

Parâmetros

source

string

Retorno

boolean

---

hide()

hide(): void

Definido em: Node.ts:360

Retorno

void

---

markAsChild()

markAsChild(parentNode, childrenDepth): void

Definido em: Node.ts:727

Parâmetros

parentNode

Node

childrenDepth

number

Retorno

void

---

markAsParent()

markAsParent(): void

Definido em: Node.ts:733

Retorno

void

---

removeChildById()

removeChildById(id): Node | undefined

Definido em: Node.ts:698

Elimine um filho e sua própria subárvore com ele. Retorna o filho removido para que o chamador possa limpar seus descendentes.

Parâmetros

id

string

Retorno

Node | undefined

---

setBorderBox()

setBorderBox(width, height): void

Definido em: Node.ts:505

Declare que a borda do nó é o retângulo width×height centralizado como ele realmente é renderizado, de modo que as bordas parem nele em vez de no círculo delimitador. Chame-o de depois setCircleRadius, o que o limpa.

Parâmetros

width

number

height

number

Retorno

void

---

setChildren()

setChildren(children): void

Definido em: Node.ts:656

Parâmetros

children

Node[]

Retorno

void

---

setCircleRadius()

setCircleRadius(radius): void

Definido em: Node.ts:460

Defina o raio do círculo do nó. Também descarta qualquer borda retangular medida: o raio é o fato mais grosseiro, então cada chamador que redimensiona um nó mantém a ancoragem correta por padrão, e apenas as gavetas que conhecem a forma renderizada optam por voltar através de setBorderBox.

Parâmetros

radius

number

Retorno

void

---

setCircleRadiusCollapsed()

setCircleRadiusCollapsed(radius): void

Definido em: Node.ts:469

Parâmetros

radius

number

Retorno

void

---

setData()

setData(newData): void

Definido em: Node.ts:137

Atualize os dados do nó.

Parâmetros

newData

NodeData

Novos dados para definir

Retorno

void

---

setLayoutSize()

setLayoutSize(halfWidth): void

Definido em: Node.ts:482

Declare a caixa que este nó reserva no layout, como meia largura em unidades gráficas. Ao contrário de setCircleRadius isso é constante: o desenho pode mudar dentro dele sem que nada se mova.

Parâmetros

halfWidth

number | undefined

Retorno

void

---

setPotential()

Assinatura de chamada

setPotential(count): void

Definido em: Node.ts:627

Declare quanto mais há para este nó, sem pedir nada - o que mostra o emblema do aro. 0 limpa a declaração.

Com um ID de pivô é o número desse pivô, e seu emblema abre esse pivô. Somente com uma contagem, é o total de tudo, que é o número que o emblema do aro 'summary' prefere - aquele a ser declarado quando há mais provedores do que um aro poderia nomear.

Marca o nó como sujo como qualquer outro setter aqui, então o emblema aparece na próxima renderização - chame graph.renderer.update() se nada mais estiver prestes a aparecer.

node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much

Parâmetros

count

number

Retorno

void

Assinatura de chamada

setPotential(pivotId, count): void

Definido em: Node.ts:628

Declare quanto mais há para este nó, sem pedir nada - o que mostra o emblema do aro. 0 limpa a declaração.

Com um ID de pivô é o número desse pivô, e seu emblema abre esse pivô. Somente com uma contagem, é o total de tudo, que é o número que o emblema do aro 'summary' prefere - aquele a ser declarado quando há mais provedores do que um aro poderia nomear.

Marca o nó como sujo como qualquer outro setter aqui, então o emblema aparece na próxima renderização - chame graph.renderer.update() se nada mais estiver prestes a aparecer.

node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much

Parâmetros

pivotId

string

count

number

Retorno

void

---

setStyle()

setStyle(newStyle): void

Definido em: Node.ts:215

Atualize os dados do nó.

Parâmetros

newStyle

Partial<NodeStyle>

Novos dados para definir

Retorno

void

---

show()

show(): void

Definido em: Node.ts:356

Retorno

void

---

toDict()

toDict(dataOnly): Record<string, unknown>

Definido em: Node.ts:239

Converta o nó em uma representação simples de objeto JSON.

Parâmetros

dataOnly

boolean = false

padrão: falso

Retorno

Record<string, unknown>

---

toggleExpand()

toggleExpand(expanded?): void

Definido em: Node.ts:364

Parâmetros

expanded?

boolean

Retorno

void

---

toggleVisibility()

toggleVisibility(visible): void

Definido em: Node.ts:347

Parâmetros

visible

boolean

Retorno

void

---

toSimulationDTO()

toSimulationDTO(): SimulationNodeDTO

Definido em: Node.ts:267

Carga útil clonável estruturada para o trabalhador de simulação (sem referências de pai/filhos/_subgrafo vivos, ao contrário de clone()). O estilo é desprovido de funções: todo canal resolvível pode conter uma, e nenhuma força os lê, portanto, enviá-los apenas arrisca um DataCloneError.

Retorno

SimulationNodeDTO

---

unfreeze()

unfreeze(): void

Definido em: Node.ts:341

Retorno

void

---

unionChildren()

unionChildren(children): Node[]

Definido em: Node.ts:674

Mesclar children por id: novos são adicionados, os correspondentes são deixados intactos - seus próprios filhos são mesclados por sua vez - e nenhum é removido. A união é como um pivô redescobrindo um contêiner adiciona o que encontrou sem perturbar o que já está lá.

Parâmetros

children

Node[]

Retorno

Node[]

cada nó recém-adicionado, em qualquer profundidade, para que o chamador possa registrá-lo e marcá-lo.

---

updateData()

updateData(partialData): void

Definido em: Node.ts:147

Mesclar dados parciais nos dados do nó atual. Útil para atualizar apenas partes dos dados.

Parâmetros

partialData

Partial<NodeData>

Objeto de dados parciais a ser mesclado

Retorno

void

---

updateStyle()

updateStyle(partialStyle): void

Definido em: Node.ts:225

Mesclar dados parciais nos dados do nó atual. Útil para atualizar apenas partes dos dados.

Parâmetros

partialStyle

Partial<NodeStyle>

Objeto de dados parciais a ser mesclado

Retorno

void

Propriedades

children

children: Node[]

Definido em: Node.ts:45

---

childrenDepth

childrenDepth: number

Definido em: Node.ts:64

---

defaultCircleRadius

defaultCircleRadius: number = 10

Definido em: Node.ts:49

---

domID

readonly domID: string

Definido em: Node.ts:101

---

expanded?

optional expanded: boolean

Definido em: Node.ts:61

---

frozen?

optional frozen: boolean

Definido em: Node.ts:59

---

fx?

optional fx: number

Definido em: Node.ts:56

---

fy?

optional fy: number

Definido em: Node.ts:57

---

id

readonly id: string

Definido em: Node.ts:43

---

isChild

isChild: boolean

Definido em: Node.ts:63

Verdadeiro se este nó for filho de um cluster recolhido

---

isParent

isParent: boolean

Definido em: Node.ts:66

Verdadeiro se este nó tiver nós filhos

---

parentNode?

optional parentNode: Node

Definido em: Node.ts:68

Referência ao nó do cluster pai (se este nó for filho)

---

visible

visible: boolean

Definido em: Node.ts:60

---

vx?

optional vx: number

Definido em: Node.ts:54

---

vy?

optional vy: number

Definido em: Node.ts:55

---

weight?

optional weight: number

Definido em: Node.ts:58

---

x?

optional x: number

Definido em: Node.ts:52

---

y?

optional y: number

Definido em: Node.ts:53