Classe: Pivotick <a class="header-anchor" href="#class-pivotick" aria-label="Permalink to “Classe: Pivotick”">​

Lança

Erro se já existir um nó com o mesmo id. Aciona onChange após o nó ser adicionado com sucesso.

addNote()

addNote(n): Note | undefined

Definido em: Graph.ts:1265

Adiciona uma nota ao gráfico e desenha-a. Toma as mesmas opções que data.notes (o que Note.toJSON retorna) ou Note. Emite noteAdd.

Parâmetros

n

Note | NoteOptions

Retorno

Note | undefined

a nota, ou undefined enquanto UI.notes.enabled é false.

Lança

Erro se já existir uma nota com o mesmo id.

addToSelection()

addToSelection(nodes): void

Definido em: Graph.ts:1637

Adiciona nós à seleção atual, deixando o que já está selecionado no lugar. Os nós já selecionados são ignorados.

Apenas nós: a camada de interação não possui setter aditivo para arestas, que só podem ser selecionadas como um conjunto completo via selectElements.

Parâmetros

nodes

Os Nodes a serem adicionados.

Retorno

void

clearEmphasis()

clearEmphasis(): void

Definido em: Graph.ts:1726

Finalize a ênfase emphasiseElements iniciada: a tela lê normalmente novamente.

Retorno

void

clearForecast()

clearForecast(): void

Definido em: Graph.ts:1745

Anote a previsão.

Retorno

void

clearHighlightedElements()

clearHighlightedElements(): void

Definido em: Graph.ts:1707

Remova qualquer classe de destaque de quaisquer nós ou arestas

Retorno

void

closeTable()

closeTable(): void

Definido em: Graph.ts:1669

Fecha o dock de dados.

Retorno

void

deselectAll()

deselectAll(): void

Definido em: Graph.ts:1681

Desmarcar tudo

Retorno

void

destroy()

destroy(): void

Definido em: Graph.ts:1444

Destrua todos os componentes da IU.

Retorno

void

edgeVisibilityChanged()

edgeVisibilityChanged(): void

Definido em: Graph.ts:1388

Pinte novamente após uma mudança na camada de borda. Deliberadamente não onChange: as camadas não tocam a força do link (veja Simulation.getActiveEdges), então reiniciar a simulação moveria o gráfico sem motivo.

Retorno

void

emphasiseElements()

emphasiseElements(elements): void

Definido em: Graph.ts:1721

Escolha um set de elementos do gráfico: eles mantêm a aparência que já têm enquanto todo o resto na tela escurece, até clearEmphasis. É assim que passar o mouse sobre uma entrada de legenda lê sua categoria na tela.

Onde highlightElement aponta para um elemento, isso descreve um grupo. Os elementos que não estão desenhados no momento são ignorados e um conjunto vazio não escurece nada.

Parâmetros

elements

(Node | Edge)[]

Os Nodes e Edges para enfatizar.

Retorno

void

focusElement()

focusElement(element): void

Definido em: Graph.ts:1583

Coloca o nó ou aresta especificado em foco na visualização do gráfico. Um nó oculto em um cluster ou grupo fechado coloca esse cluster ou grupo em foco.

Parâmetros

element

O Node ou Edge para focar.

Node | Edge | Note

Retorno

void

getAppID()

getAppID(): string

Definido em: Graph.ts:1456

O ID do aplicativo

Retorno

string

getConnectedNodes()

getConnectedNodes(node): Node[]

Definido em: Graph.ts:1241

Recupera todos os nós conectados diretamente de um determinado nó.

Retorna nós clonados para evitar modificações externas.

Parâmetros

node

O nó ou ID do nó do qual localizar conexões.

string | Node

Retorno

Uma matriz de objetos Node conectados diretamente a partir de um determinado nó.

getEdge()

getEdge(id): Edge | undefined

Definido em: Graph.ts:1036

Recupera uma aresta do gráfico pelo seu ID.

Retorna um clone profundo da borda para evitar mutações externas.

Parâmetros

id

string

O ID da borda.

Retorno

Edge | undefined

Um Edge clonado se encontrado, caso contrário undefined.

getEdgeCount()

getEdgeCount(): number

Definido em: Graph.ts:1086

Retorna o número de arestas atualmente no gráfico.

Retorno

number

A contagem total de bordas.

getEdges()

getEdges(): Edge[]

Definido em: Graph.ts:1168

Recupera todas as arestas do gráfico.

Retorna clones das arestas para evitar modificações externas.

Retorno

Uma matriz de objetos Edge clonados.

getEdgesFromNode()

getEdgesFromNode(node): Edge[]

Definido em: Graph.ts:1211

Encontra todas as arestas originadas de um determinado nó.

Retorna arestas clonadas para evitar modificações externas.

Parâmetros

node

O nó ou ID do nó do qual localizar arestas de saída.

string | Node

Retorno

Uma matriz de objetos Edge cujo nó from corresponde à consulta.

getEdgesToNode()

getEdgesToNode(node): Edge[]

Definido em: Graph.ts:1226

Encontra todas as arestas apontando para um determinado nó.

Retorna arestas clonadas para evitar modificações externas.

Parâmetros

node

O nó ou ID do nó para o qual encontrar arestas de entrada.

string | Node

Retorno

Uma matriz de objetos Edge cujo nó to corresponde à consulta.

getGraphDepth()

getGraphDepth(): number

Definido em: Graph.ts:1566

Retorno

number

getMutableEdge()

getMutableEdge(id): Edge | undefined

Definido em: Graph.ts:1052

Recupera uma aresta do gráfico pelo seu ID.

Retorna a instância real da borda, permitindo modificações diretas.

Aviso: Modificar diretamente as arestas usando este método pode levar a um comportamento inesperado. Geralmente é mais seguro usar getEdge que retorna uma instância clonada.

Parâmetros

id

string

O ID da borda.

Retorno

Edge | undefined

O Edge se encontrado, caso contrário, undefined.

getMutableEdges()

getMutableEdges(): Edge[]

Definido em: Graph.ts:1184

Recupera todas as arestas do gráfico.

Retorna as instâncias reais do Edge, permitindo modificações diretas.

Retorno

Uma matriz de objetos Edge.

Observações

⚠️ Aviso: Modificar as bordas diretamente pode levar a um comportamento inesperado. Use getEdges para trabalhar com clones seguros.

getMutableNode()

getMutableNode(id): Node | undefined

Definido em: Graph.ts:943

Recupera um nó do gráfico pelo seu ID.

Retorna a instância real do nó, permitindo modificações diretas.

Aviso: Modificar diretamente os nós usando este método pode levar a um comportamento inesperado. Geralmente é mais seguro usar getNode que retorna uma instância clonada.

Parâmetros

id

O ID do nó ou de um objeto Node.

string | Node

Retorno

Node | undefined

O Node se encontrado, caso contrário, undefined.

getMutableNodes()

getMutableNodes(): Node[]

Definido em: Graph.ts:1114

Recupera todos os nós no gráfico.

Retorna as instâncias reais do nó, permitindo modificações diretas.

Retorno

Uma matriz de objetos Node.

Observações

⚠️ Aviso: Modificar nós diretamente pode levar a um comportamento inesperado. Geralmente é mais seguro usar getNodes, que retorna instâncias clonadas.

getMutableVisibleEdges()

getMutableVisibleEdges(): Edge[]

Definido em: Graph.ts:1199

Recupera todas as arestas visíveis no gráfico.

Retorna as instâncias reais do Edge, permitindo modificações diretas.

Retorno

Uma matriz de objetos Edge.

Observações

⚠️ Aviso: Modificar as bordas diretamente pode levar a um comportamento inesperado. Use getEdges para trabalhar com clones seguros.

getMutableVisibleNodes()

getMutableVisibleNodes(): Node[]

Definido em: Graph.ts:1130

Recupera todos os nós visíveis no gráfico. Adicionando recursivamente filhos visíveis

Retorna as instâncias reais do nó, permitindo modificações diretas.

Retorno

Uma matriz de objetos Node.

Observações

⚠️ Aviso: Modificar nós diretamente pode levar a um comportamento inesperado. Geralmente é mais seguro usar getNodes, que retorna instâncias clonadas.

getNode()

getNode(id): Node | undefined

Definido em: Graph.ts:927

Recupera um nó do gráfico pelo seu ID.

Retorna um clone profundo do nó para evitar mutações externas.

Parâmetros

id

O ID do nó ou de um objeto Node.

string | Node

Retorno

Node | undefined

Um Node clonado se encontrado, caso contrário undefined.

getNodeCount()

getNodeCount(): number

Definido em: Graph.ts:1077

Retorna o número de nós atualmente no gráfico.

Retorno

number

A contagem total de nós.

getNodes()

getNodes(): Node[]

Definido em: Graph.ts:1097

Recupera todos os nós no gráfico.

Retorna clones dos nós para evitar modificações externas.

Retorno

Uma matriz de objetos Node clonados.

getNote()

getNote(id): Note | undefined

Definido em: Graph.ts:1254

Parâmetros

id

string

Retorno

Note | undefined

getNotes()

getNotes(): Note[]

Definido em: Graph.ts:1250

Retorno

Note[]

getOptions()

getOptions(): GraphOptions

Definido em: Graph.ts:693

Retorna as opções de configuração atuais do gráfico.

Retorno

GraphOptions

hideNode()

hideNode(node): void

Definido em: Graph.ts:1393

Parâmetros

node

Retorno

void

highlightElement()

highlightElement(element): void

Definido em: Graph.ts:1690

Adicione uma classe de destaque ao determinado nó ou borda

Parâmetros

element

O Node ou Edge para destacar.

Node | Edge

Retorno

void

nextTick()

nextTick(): void

Definido em: Graph.ts:1430

Acione a próxima atualização de renderização do gráfico.

Retorno

void

nextTickFor()

nextTickFor(nodes): void

Definido em: Graph.ts:1437

Acione a próxima atualização de renderização do gráfico para os assuntos aprovados.

Parâmetros

nodes

Retorno

void

noteAdd()

noteAdd(note): void

Definido em: Graph.ts:422

Parâmetros

note

Note

Retorno

void

noteChange()

noteChange(note): void

Definido em: Graph.ts:425

Parâmetros

note

Note

Retorno

void

noteRemove()

noteRemove(note): void

Definido em: Graph.ts:428

Parâmetros

note

Note

Retorno

void

off()

off<K>(event, handler): void

Definido em: Graph.ts:258

Parâmetros de tipo

K

K estende chave de GraphEvents

Parâmetros

event

K

handler

GraphEvents[K]

Retorno

void

on()

on<K>(event, handler): void

Definido em: Graph.ts:251

Parâmetros de tipo

K

K estende chave de GraphEvents

Parâmetros

event

K

handler

GraphEvents[K]

Retorno

void

openTable()

openTable(): void

Definido em: Graph.ts:1662

Abre o data dock – as linhas do gráfico como uma grade classificável e selecionável dividida na parte inferior da tela. Somente modo full e somente quando UI.table permitir; caso contrário, um ambiente autônomo.

O dock agora pode conter outros painéis além da tabela, então isso também traz o painel da tabela para a frente: a chamada tem o nome da tabela e deve mostrar um. Alcance UIManager.dock ou activateDockTab() para dirigir pela região sem isso.

Retorno

void

removeBySource()

removeBySource(source): object

Definido em: Graph.ts:592

Remova tudo o que uma fonte garante. Um elemento que várias fontes atestam sobrevive, uma afirmação mais leve - a mesma regra uniforme de desfazer do pivô segue, e a única maneira de remover qualquer coisa que um pivô trouxe.

É uma operação direta e uma entrada no history: desfazê-la coloca de volta o que sobrou e devolve a reivindicação da fonte ao que ficou.

Parâmetros

source

string

Um ID de pivô ou 'seed' para dados que nunca foram dinamizados.

Retorno

object

O que foi realmente removido.

edges

edges: Edge[]

nodes

nodes: Node[]

removeEdge()

removeEdge(id): void

Definido em: Graph.ts:1062

Remove uma aresta do gráfico pelo seu ID.

Parâmetros

id

string

O ID da borda a ser removida. Aciona onChange após a borda ser removida.

Retorno

void

removeFromSelection()

removeFromSelection(nodes): void

Definido em: Graph.ts:1648

Remove nós da seleção atual, deixando o restante no lugar. Apenas nós, nos mesmos termos de addToSelection.

Parâmetros

nodes

Os Nodes a serem removidos.

Retorno

void

removeNode()

removeNode(id): void

Definido em: Graph.ts:969

Remove um nó do gráfico pelo seu ID.

Também remove quaisquer arestas conectadas ao nó.

Parâmetros

id

string

O ID do nó a ser removido. Aciona onChange após o nó e suas arestas serem removidos.

Retorno

void

selectElement()

selectElement(element): void

Definido em: Graph.ts:1593

Seleciona um determinado nó ou aresta no gráfico. Um nó oculto em um cluster ou grupo fechado ainda é aquele selecionado; a tela ilumina o cluster ou grupo desenhado para ela.

Parâmetros

element

O Node ou Edge para selecionar.

Node | Edge

Retorno

void

selectElements()

selectElements(elements): void

Definido em: Graph.ts:1610

Seleciona vários nós, ou várias arestas, substituindo a seleção atual — o plural selectElement, resolvendo o identificador renderizado de cada elemento para você.

Nós e arestas não podem ser selecionados juntos (a camada de interação limpa um tipo quando o outro é definido), então uma matriz mista seleciona os nodes e avisa.

Parâmetros

elements

(Node | Edge)[]

Os Nodes ou Edges para selecionar. Uma matriz vazia limpa a seleção.

Retorno

void

setData()

setData(nodes, edges, notes): void

Definido em: Graph.ts:852

Substitui todos os nós e arestas atuais no gráfico pelos dados fornecidos. Limpa nós e arestas existentes antes de definir os novos. Aciona o retorno de chamada onChange após a atualização.

Parâmetros

nodes

Node[] = []

Matriz de nós a serem definidos. O padrão é uma matriz vazia.

edges

Edge[] = []

Matriz de arestas a serem definidas. O padrão é uma matriz vazia.

notes

Note[] = []

Retorno

void

setLegend()

setLegend(config?): void

Definido em: Graph.ts:450

Substitua a legenda do canvas em tempo de execução — o gêmeo imperativo de UI.legend. Um gráfico que começou sem ele é construído na hora; false esvazia a legenda e descarta seu filtro, e true / undefined volta para derivar um de render.nodeTypeAccessor. Passe LegendGroupOptions para codificar o gráfico em várias dimensões ao mesmo tempo.

Parâmetros

config?

A legenda a ser mostrada ou false para removê-la.

boolean | LegendOptions | LegendGroupOptions

Retorno

void

setNotes()

setNotes(notes): Note[]

Definido em: Graph.ts:1282

Substitui as notas do gráfico, deixando nós e arestas sozinhos. As notas são correspondidas por id: uma que já esteja na tela é atualizada no local, então seu desenho permanece vinculado a ela, uma que não está em notes é removida e uma nova é adicionada.

Parâmetros

notes

(Note | NoteOptions)[]

Retorno

Note[]

as notas agora no gráfico, na ordem dada.

Lança

Erro se duas entradas compartilharem um ID. Nada mudou então.

setVisibleNodes()

setVisibleNodes(nodes, notify): boolean

Definido em: Graph.ts:1356

Retorna se alguma coisa foi movida, portanto, uma alteração de filtro somente de borda pode ser repintada. notify está desativado para a primeira passagem do mecanismo de consulta, que é executado antes de qualquer coisa ser desenhada - o próprio simulation.update() / renderer.init() do construtor o segue.

Parâmetros

nodes

notify

boolean = true

Retorno

boolean

showForecast()

showForecast(forecast): void

Definido em: Graph.ts:1740

Pinte o que uma ação faria e não mude mais nada: os elementos que ela removeria seriam drenados no lugar, aqueles que ela esconderia com eles e tudo o que traria de volta está delineado onde pousaria.

Onde emphasiseElements lê um conjunto fora da tela recuando o resto, uma previsão responde "o que acontece se eu clicar" - então o gráfico deve continuar lendo normalmente em torno dos poucos elementos que mudariam. graph.history.preview(...) retorna um pronto.

Parâmetros

forecast

GraphForecast

Retorno

void

showNode()

showNode(node): void

Definido em: Graph.ts:1404

Parâmetros

node

Retorno

void

toggleExpandNode()

toggleExpandNode(node): void

Definido em: Graph.ts:1415

Parâmetros

node

Retorno

void

toggleExpandNodes()

toggleExpandNodes(nodes): void

Definido em: Graph.ts:1420

Parâmetros

nodes

Retorno

void

toggleTable()

toggleTable(): void

Definido em: Graph.ts:1674

Abre o data dock se estiver fechado, fecha-o se estiver aberto.

Retorno

void

unHighlightElement()

unHighlightElement(element): void

Definido em: Graph.ts:1699

Remover uma classe de destaque para um determinado nó ou borda

Parâmetros

element

O Node ou Edge para selecionar.

Node | Edge

Retorno

void

updateData()

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

Definido em: Graph.ts:764

Atualiza o gráfico com novos nós e/ou arestas.

Um id que o gráfico já contém é atualizado no lugar: o que o elemento é — seus dados, estilo e peso — se torna o que você entregou, enquanto o próprio objeto mantém sua identidade. Tem que funcionar assim. Suas bordas, a simulação e a ligação do DOM mantêm esse objeto, assim como tudo o que ele aprendeu desde que foi construído: quais fontes atestam isso, onde ele fica, se está fixado. Uma posição no elemento recebido ainda vence, então updateData pode mover algo e também atualizá-lo. IDs desconhecidos são adicionados.

Os children de um contêiner não são reestruturados aqui - passe o contêiner por removeNode e addNode para alterar o que ele contém.

A chamada inteira é um lote: um dataBatchChanged listando cada adição e alteração na ordem dada, depois uma nova renderização, não importa quantos elementos ela carregue.

Parâmetros

newNodes?

Matriz opcional de nós para atualizar ou adicionar.

newEdges?