Pular para o conteúdo

pivotick v3.0.0


pivotick / PivotManager

Interface: PivotManager ​

Definido em: PivotManager.ts:50

O tempo de execução do pivô: o registro, as duas chamadas de provedor com seu cancelamento e cache, a porta de estreitamento, os conjuntos de candidatos aguardando triagem e a ingestão com sua procedência. Recuar é trabalho de graph.history, junto com qualquer outra coisa que o analista pode reverter.

Não contém UI. Tudo aqui pode ser controlado a partir do console - um pivô com autoIngest: true é de ponta a ponta sem um único painel - e o painel de triagem e o modo Pivot rail são leitores deste estado, não proprietários dele.

Atingido como Graph.pivots.

Implementos ​

Acessores ​

rimBadge ​

Assinatura do getter ​

get rimBadge(): PivotRimBadge

Definido em: PivotManager.ts:111

O que a biblioteca desenha na borda de um nó para seus pivôs: um emblema por pivô que declarou potencial, um emblema para todos eles ou nada. Defina-o através de pivotRimBadge nas opções do gráfico ou aqui para alterá-lo mais tarde.

Atribuir marcas a cada nó como sujo, da mesma forma que setPotential faz para um - o aro é redesenhado na próxima renderização, então chame graph.renderer.update() se nada mais estiver para fazer.

Retorno ​

PivotRimBadge

Assinatura do setter ​

set rimBadge(mode): void

Definido em: PivotManager.ts:115

O que a biblioteca desenha na borda de um nó para seus pivôs.

Parâmetros ​
mode ​

PivotRimBadge

Retorno ​

void

Implementação de ​

PivotManagerLike.rimBadge


rimBadgeShown ​

Assinatura do getter ​

get rimBadgeShown(): boolean

Definido em: PivotManager.ts:142

Se os emblemas do aro estão desenhados agora.

Retorno ​

boolean


rimBadgeVisible ​

Assinatura do getter ​

get rimBadgeVisible(): PivotRimBadgeVisibility

Definido em: PivotManager.ts:131

Quando os emblemas do aro rimBadge são desenhados: somente enquanto o modo Pivot estiver aberto, sempre ou nunca. Defina-o através de pivotRimBadgeVisible nas opções do gráfico ou aqui para alterá-lo mais tarde.

Como rimBadge, atribuir marcas a cada nó como sujo.

Retorno ​

PivotRimBadgeVisibility

Assinatura do setter ​

set rimBadgeVisible(visibility): void

Definido em: PivotManager.ts:135

Quando esses emblemas de aro são desenhados.

Parâmetros ​
visibility ​

PivotRimBadgeVisibility

Retorno ​

void

Implementação de ​

PivotManagerLike.rimBadgeVisible


saveControls ​

Assinatura do getter ​

get saveControls(): boolean

Definido em: PivotManager.ts:90

Se o painel dinâmico e o painel de triagem oferecem seus próprios N não salvos · Salvar. Desativado, um consumidor responde apenas por meio de save, que, como o razão e unsavedCount, funciona de qualquer maneira. Defina-o através de pivotSaveControls nas opções do gráfico ou aqui para alterá-lo mais tarde.

Retorno ​

boolean

Assinatura do setter ​

set saveControls(shown): void

Definido em: PivotManager.ts:94

Se o painel Dinâmico e o painel de triagem oferecem seu próprio Salvar.

Parâmetros ​
shown ​

boolean

Retorno ​

void

Implementação de ​

PivotManagerLike.saveControls


size ​

Assinatura do getter ​

get size(): number

Definido em: PivotManager.ts:272

Quantos pivôs estão registrados — o que o gate do modo trilho pivô lê.

Retorno ​

number

Métodos ​

all() ​

all(): PivotDefinition[]

Definido em: PivotManager.ts:267

Cada pivô cadastrado, na ordem de registro.

Retorno ​

PivotDefinition[]

Implementação de ​

PivotManagerLike.all


applicableCount() ​

applicableCount(node): number

Definido em: PivotManager.ts:301

Quantos pivôs se aplicam a um nó — o que o emblema do aro 'summary' conta quando nada foi declarado para ele.

Memoised, porque o rim pede isso para cada nó em cada renderização e a resposta é uma chamada appliesTo por pivô registrado: em cem provedores e mil nós, perguntar a cada vez são cem mil chamadas por quadro. O memorando é eliminado sempre que o registro ou os nós do gráfico mudam, portanto, um predicado lendo qualquer coisa else pode ficar obsoleto - aceitável para uma dica na borda, e o painel é sempre a resposta exata.

Parâmetros ​

node ​

Node

Retorno ​

number

Implementação de ​

PivotManagerLike.applicableCount


cachedSummary() ​

cachedSummary(id, nodes, narrowing): PivotSummary | undefined

Definido em: PivotManager.ts:379

O resumo em cache exatamente para esta pergunta, se houver. Permite que uma superfície pinte um número que já conhece sem perguntar novamente.

Parâmetros ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

Retorno ​

PivotSummary | undefined


cancel() ​

cancel(pivotId?, kind?): void

Definido em: PivotManager.ts:409

Abortar chamadas de provedor em voo: um pivô ou todos os pivôs e, opcionalmente, apenas um tipo.

O kind é o que permite que uma superfície interrompa as perguntas que ela estava fazendo sem cancelar o trabalho que encomendou - um fetch já tem um conjunto de candidatos próprio e um painel mostrando-o, então abandonar isso silenciosamente jogaria fora resultados que ninguém pediu para perder.

Parâmetros ​

pivotId? ​

string

kind? ​

"summarize" | "fetch"

Retorno ​

void

Implementação de ​

PivotManagerLike.cancel


cancelFetch() ​

cancelFetch(pivotId): void

Definido em: PivotManager.ts:631

Cancele uma busca em voo. O conjunto de candidatos acompanha isso; nada é encenado.

Parâmetros ​

pivotId ​

string

Retorno ​

void


candidates() ​

candidates(pivotId): PivotCandidateSet | undefined

Definido em: PivotManager.ts:701

Os candidatos disputaram um pivô, se houver.

Parâmetros ​

pivotId ​

string

Retorno ​

PivotCandidateSet | undefined


canonicalId() ​

canonicalId(element): string | undefined

Definido em: PivotManager.ts:1254

O id que o sistema de origem atribuiu a este elemento, quando atribuiu um.

Parâmetros ​

element ​

Node | Edge

Retorno ​

string | undefined

Implementação de ​

PivotManagerLike.canonicalId


discard() ​

discard(pivotId): void

Definido em: PivotManager.ts:846

Abandone um cenário encenado sem rejeitar nada. Fechar um painel não é um veredicto: tudo o que nunca foi rejeitado é oferecido novamente na próxima execução.

Parâmetros ​

pivotId ​

string

Retorno ​

void


dismissPending() ​

dismissPending(pivotId): void

Definido em: PivotManager.ts:833

Faça uma repetição de espera e continue com o que está em exibição. Nada é rejeitado: a próxima corrida volta a oferecer esses candidatos.

Parâmetros ​

pivotId ​

string

Retorno ​

void

Implementação de ​

PivotManagerLike.dismissPending


for() ​

for(nodes): PivotDefinition[]

Definido em: PivotManager.ts:285

O que se aplica a esta origem. Uma origem vazia produz os pivôs sem origem — pesquisa, importação, preparação — e nada mais, porque um pivô orientado por seleção sem seleção não tem nada para executar.

Um pivô que se aplica apenas a parte da origem está em: uma seleção que mistura um domínio e um IP oferece também os provedores somente de domínio, e cada um é executado nos nós que manteve.

Parâmetros ​

nodes ​

Node[]

Retorno ​

PivotDefinition[]

Implementação de ​

PivotManagerLike.for


get() ​

get(id): PivotDefinition | undefined

Definido em: PivotManager.ts:262

Parâmetros ​

id ​

string

Retorno ​

PivotDefinition | undefined

Implementação de ​

PivotManagerLike.get


ingest() ​

ingest(pivotId, trigger, options): Promise<PivotRunOutcome>

Definido em: PivotManager.ts:864

Confirme os candidatos marcados de um conjunto encenado.

Puramente aditivo: um id que já esteja na tela é ignorado, nunca sobrescrito e a remoção só acontece através de graph.history ou graph.removeBySource. O lote inteiro passa por onBeforeIngest uma vez e chega como um dataBatchChanged.

group dobra o patamar em grupos, um por tipo (graph.simplify.groupLanding), e o padrão é ingestGrouped.

Parâmetros ​

pivotId ​

string

trigger ​

"auto" | "triage"

options ​
group? ​

boolean

Retorno ​

Promise<PivotRunOutcome>


invalidate() ​

invalidate(pivotId?, nodes?): void

Definido em: PivotManager.ts:389

Elimine resumos armazenados em cache: todos eles, um pivô ou apenas aqueles questionados sobre nós específicos. A biblioteca armazena em cache porque um resumo de seleção múltipla é um agregado que nada pode decompor, mas apenas o consumidor sabe quando seu back-end foi alterado.

Parâmetros ​

pivotId? ​

string

nodes? ​

Node[]

Retorno ​

void

Implementação de ​

PivotManagerLike.invalidate


isSavable() ​

isSavable(element): boolean

Definido em: PivotManager.ts:1247

Se este elemento veio de uma execução cujo pivô declara save.

Parâmetros ​

element ​

Node | Edge

Retorno ​

boolean

Implementação de ​

PivotManagerLike.isSavable


isSaved() ​

isSaved(element): boolean

Definido em: PivotManager.ts:1242

Gravado no sistema de origem. false tanto para um elemento ainda esperando quanto para aquele cujo pivô nunca pode escrevê-lo em lugar nenhum — isSavable é a pergunta que diferencia os dois.

Parâmetros ​

element ​

Node | Edge

Retorno ​

boolean

Implementação de ​

PivotManagerLike.isSaved


mark() ​

mark(pivotId, id, marked): void

Definido em: PivotManager.ts:715

Marque ou desmarque um candidato para ingestão. Deliberadamente silencioso: com centenas de linhas, renderizar novamente o painel a cada tick perde o lugar do analista, então o chamador atualiza a linha que acabou de alterar.

Parâmetros ​

pivotId ​

string

id ​

string

marked ​

boolean = true

Retorno ​

void


markAll() ​

markAll(pivotId, marked): void

Definido em: PivotManager.ts:722

Marque todos os candidatos possíveis - o que "selecionar todos" resolve.

Parâmetros ​

pivotId ​

string

marked ​

boolean = true

Retorno ​

void


on() ​

on(listener): () => void

Definido em: PivotManager.ts:1581

Assine as mudanças de estado dinâmico – o registro, um resumo, os candidatos preparados, a pilha de execução. Retorna um triturador.

Parâmetros ​

listener ​

(change) => void

Retorno ​

(): void

Retorno ​

void


originFor() ​

originFor(id, nodes): Node[]

Definido em: PivotManager.ts:313

A quanto de nodes um pivô se aplica. Vazio quando não se aplica, e vazio para um pivô sem origem, que não é questionado por definição.

Parâmetros ​

id ​

string

nodes ​

Node[]

Retorno ​

Node[]

Implementação de ​

PivotManagerLike.originFor


register() ​

register(definition): () => void

Definido em: PivotManager.ts:229

Registre um pivô. Retorna um triturador; ligar duas vezes é um ambiente autônomo. Um ID duplicado é ignorado com um aviso, como em qualquer outro lugar da biblioteca.

Parâmetros ​

definition ​

PivotDefinition

Retorno ​

(): void

Retorno ​

void

Implementação de ​

PivotManagerLike.register


reject() ​

reject(pivotId, ids): void

Definido em: PivotManager.ts:741

Rejeite os candidatos explicitamente. Lembrado para a sessão, digitado por pivô: um candidato rejeitado em um pivô ainda é oferecido por outro, que o questiona em um contexto analítico diferente.

Parâmetros ​

pivotId ​

string

ids ​

string[]

Retorno ​

void


rejectedCount() ​

rejectedCount(pivotId): number

Definido em: PivotManager.ts:791

Quantos candidatos foram rejeitados para este pivô nesta sessão.

Parâmetros ​

pivotId ​

string

Retorno ​

number


rejectedIds() ​

rejectedIds(pivotId): string[]

Definido em: PivotManager.ts:796

Os identificadores de candidatos rejeitados para esse pivô — o que o painel revela sob demanda.

Parâmetros ​

pivotId ​

string

Retorno ​

string[]


rejectedRows() ​

rejectedRows(pivotId): PivotRejection[]

Definido em: PivotManager.ts:804

As próprias rejeições, brigas e tudo, as mais recentes ficam por último. O que uma superfície listando-os mostra: um id não nomeia nada quando a execução que o carregava termina.

Parâmetros ​

pivotId ​

string

Retorno ​

PivotRejection[]


rejectRemaining() ​

rejectRemaining(pivotId): void

Definido em: PivotManager.ts:769

Rejeite tudo que ainda não foi triado neste conjunto – como fazer a triagem de 1.800 até 12 e descartar o resto permanece um gesto.

Parâmetros ​

pivotId ​

string

Retorno ​

void


run() ​

run(id, nodes, narrowing, options): Promise<PivotRunOutcome>

Definido em: PivotManager.ts:428

Execute um pivô: compare a contagem anunciada com seu limite, busque e, em seguida, obtenha os resultados (autoIngest) ou prepare-os para triagem.

Resolve na transferência – uma execução encenada não espera pelo analista. O runId do resultado é o ID sob o qual a ingestão resultante é registrada, portanto, é o identificador para graph.history.undo.

Parâmetros ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

options ​

PivotRunOptions = {}

Retorno ​

Promise<PivotRunOutcome>

Implementação de ​

PivotManagerLike.run


save() ​

save(target?, options?): Promise<PivotSaveReport>

Definido em: PivotManager.ts:1105

Escreva as execuções ingeridas de volta aos sistemas com os quais seus pivôs se comunicam: uma execução ou todas as execuções salváveis com algo ainda não salvo.

A biblioteca contribui com a contabilidade, não com o transporte – quais elementos uma execução criou, quais deles foram escritos e o que uma nova tentativa deve conter. A gravação em si é PivotDefinition.save's, e um pivô que declara nenhum é totalmente ignorado em vez de ser considerado como falhado.

As execuções acontecem uma de cada vez: um back-end no qual está sendo gravado não é auxiliado por seis lotes paralelos, e uma passagem sequencial torna o relatório exato.

Parâmetros ​

target? ​

Um ID de execução para uma execução, um ID de pivô para cada execução não salva desse pivô, { elements } apenas para esses ou nada para todos eles.

string | PivotSaveSelection

options? ​

PivotSaveOptions = {}

interactive: true quando um analista solicitou, para que um salvamento possa ser solicitado.

Retorno ​

Promise<PivotSaveReport>

Implementação de ​

PivotManagerLike.save


showPending() ​

showPending(pivotId): void

Definido em: PivotManager.ts:820

Promova uma repetição de espera: seus candidatos tornam-se o conjunto em exposição, e as notas daquele que ele substitui acompanham-no. Um ambiente autônomo enquanto a nova execução ainda está sendo buscada - trocar um conjunto sem nada ainda seria o descarte silencioso que todo esse mecanismo existe para evitar.

Parâmetros ​

pivotId ​

string

Retorno ​

void

Implementação de ​

PivotManagerLike.showPending


staged() ​

staged(): PivotCandidateSet[]

Definido em: PivotManager.ts:706

Cada conjunto de candidatos encenado — um por pivô que foi executado e ainda não foi liberado.

Retorno ​

PivotCandidateSet[]


summarize() ​

summarize(id, nodes, narrowing): Promise<PivotSummary | undefined>

Definido em: PivotManager.ts:347

Pergunte a um pivô o que há por aí. Fornece uma resposta em cache sem tocar no provedor e substitui qualquer resumo já em andamento para o mesmo pivô.

Resolve undefined quando a chamada foi substituída ou cancelada — nada para renderizar e nunca um erro. Um provedor que lança rejeições, para que uma superfície possa mostrar a falha e oferecer uma nova tentativa.

Parâmetros ​

id ​

string

nodes ​

Node[] = []

narrowing ​

PivotNarrowing = {}

Retorno ​

Promise<PivotSummary | undefined>


unregister() ​

unregister(id): void

Definido em: PivotManager.ts:254

Cancele o registro de um pivô, descartando seus resumos armazenados em cache e seus candidatos encenados.

Parâmetros ​

id ​

string

Retorno ​

void

Implementação de ​

PivotManagerLike.unregister


unreject() ​

unreject(pivotId, id): void

Definido em: PivotManager.ts:758

Aceite uma rejeição de volta. Atinge a memória da sessão, independentemente de o candidato ainda estar preparado ou não — uma rejeição de uma execução anterior suprime a linha em vez de mostrá-la, e retirá-la é a única maneira pela qual essa linha é oferecida novamente.

Parâmetros ​

pivotId ​

string

id ​

string

Retorno ​

void


unrejectAll() ​

unrejectAll(pivotId): void

Definido em: PivotManager.ts:779

Aceite todas as rejeições que esse pivô retém. A saída para um Reject all remaining que foi longe demais, mas a restauração um por um não é.

Parâmetros ​

pivotId ​

string

Retorno ​

void


unsaved() ​

unsaved(): PivotRun[]

Definido em: PivotManager.ts:1220

Execuções salváveis com elementos ainda na tela e ainda não escritos.

Retorno ​

PivotRun[]

Implementação de ​

PivotManagerLike.unsaved


unsavedCount() ​

unsavedCount(pivotId?): object

Definido em: PivotManager.ts:1225

O que um Save enviaria - em cada corrida salvável ou em um pivô.

Parâmetros ​

pivotId? ​

string

Retorno ​

object

edges ​

edges: number

nodes ​

nodes: number

Implementação de ​

PivotManagerLike.unsavedCount

Propriedades ​

candidateCeiling ​

candidateCeiling: number = 10_000

Definido em: PivotManager.ts:57

Teto absoluto sobre o que um fetch pode encenar. Um provedor que retorna mais é recusado — nada é encenado, nada é truncado e o analista recebe o número. Trata-se de memória para objetos candidatos, não da tabela, que é virtualizada. Substitua-o por pivotCandidateCeiling nas opções do gráfico.

Implementação de ​

PivotManagerLike.candidateCeiling


ingestGrouped ​

ingestGrouped: boolean = false

Definido em: PivotManager.ts:73

Se uma ingestão chega dobrada em grupos, um por tipo, quando seu chamador não diz. Defina-o através de pivotIngestGrouped nas opções do gráfico ou aqui para alterá-lo mais tarde. Não faz nada enquanto o gráfico não simplifica.


markUnsaved ​

markUnsaved: boolean = false

Definido em: PivotManager.ts:80

Se um nó criado por uma execução e não escrito de volta carrega uma classe pvt-node-unsaved. Defina-o através de pivotMarkUnsaved nas opções do gráfico ou aqui para alterá-lo mais tarde.


quickIngestLimit ​

quickIngestLimit: number = 50

Definido em: PivotManager.ts:66

Quantos novos candidatos um pivô de um clique chega sem triagem. O número é sobre a tela e não sobre o clique: desfazer leva de volta, mas não o layout que a simulação fez em torno dele, então o limite é aproximadamente o que um gráfico pode absorver e ainda ser o gráfico que o analista estava lendo. Substitua-o por pivotQuickIngestLimit nas opções do gráfico.

Implementação de ​

PivotManagerLike.quickIngestLimit