pivotick v3.0.0

---

pivotick / Pivot / PivotManagerLike

Interface: PivotManagerLike

Definido em: interfaces/Pivot.ts:621

A forma Graph.pivots expõe. Declarado como uma interface para que a superfície voltada para o consumidor seja documentada em um só lugar e a implementação possa permanecer interna.

Métodos

all()

all(): PivotDefinition[]

Definido em: interfaces/Pivot.ts:640

Cada pivô cadastrado, na ordem de registro.

Retorno

PivotDefinition[]

---

applicableCount()

applicableCount(node): number

Definido em: interfaces/Pivot.ts:653

Quantos pivôs se aplicam a um nó — o que o emblema do aro 'summary' conta. Realizado entre alterações no gráfico, por isso é barato perguntar por nó por renderização.

Parâmetros

node

Node

Retorno

number

---

cancel()

cancel(pivotId?, kind?): void

Definido em: interfaces/Pivot.ts:661

Abortar chamadas em andamento — um pivô ou todos e, opcionalmente, apenas um tipo.

Parâmetros

pivotId?

string

kind?

"summarize" | "fetch"

Retorno

void

---

canonicalId()

canonicalId(element): string | undefined

Definido em: interfaces/Pivot.ts:695

O id que o sistema de origem atribuiu a este elemento quando foi salvo, quando atribuiu um. O elemento mantém seu próprio id - redigitando alcances em bordas, clusters, seleção, mecanismo de consulta e histórico - então graph.getNode(canonicalId) ainda falha e esta é a leitura que não falha.

Parâmetros

element

Node | Edge

Retorno

string | undefined

---

dismissPending()

dismissPending(pivotId): void

Definido em: interfaces/Pivot.ts:658

Abandone uma repetição de espera e continue fazendo a triagem do que está em exibição.

Parâmetros

pivotId

string

Retorno

void

---

for()

for(nodes): PivotDefinition[]

Definido em: interfaces/Pivot.ts:642

O que se aplica a esta origem. Uma origem vazia produz os pivôs sem origem.

Parâmetros

nodes

Node[]

Retorno

PivotDefinition[]

---

get()

get(id): PivotDefinition | undefined

Definido em: interfaces/Pivot.ts:638

Parâmetros

id

string

Retorno

PivotDefinition | undefined

---

invalidate()

invalidate(pivotId?, nodes?): void

Definido em: interfaces/Pivot.ts:659

Parâmetros

pivotId?

string

nodes?

Node[]

Retorno

void

---

isSavable()

isSavable(element): boolean

Definido em: interfaces/Pivot.ts:688

Se este elemento pertence a uma execução cujo pivô pode escrevê-lo em qualquer lugar.

Parâmetros

element

Node | Edge

Retorno

boolean

---

isSaved()

isSaved(element): boolean

Definido em: interfaces/Pivot.ts:686

Gravado no sistema de origem. false para os não salvos, * e * para os não salvos.

Parâmetros

element

Node | Edge

Retorno

boolean

---

originFor()

originFor(id, nodes): Node[]

Definido em: interfaces/Pivot.ts:648

A quanto de nodes um pivô se aplica — a origem com a qual ele realmente seria executado. Vazio quando não se aplica e sempre vazio para um pivô sem origem. O que uma superfície diz "3 dos 5 que você escolheu".

Parâmetros

id

string

nodes

Node[]

Retorno

Node[]

---

register()

register(definition): () => void

Definido em: interfaces/Pivot.ts:636

Parâmetros

definition

PivotDefinition

Retorno

(): void

Retorno

void

---

run()

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

Definido em: interfaces/Pivot.ts:654

Parâmetros

id

string

nodes?

Node[]

narrowing?

PivotNarrowing

options?

PivotRunOptions

Retorno

Promise<PivotRunOutcome>

---

save()

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

Definido em: interfaces/Pivot.ts:677

Gravar execuções ingeridas de volta aos seus sistemas de origem. As corridas acontecem uma de cada vez, e uma corrida cujo pivô declara não save nunca está entre elas.

Cada execução é enviada apenas o que ainda não foi salvo, portanto, uma nova tentativa é a mesma chamada.

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ô, um PivotSaveSelection apenas para esses elementos ou nada para todos eles.

string | PivotSaveSelection

options?

PivotSaveOptions

interactive: true quando um analista pediu para salvar, então PivotSaveContext.promptData pode abrir seu modal.

Retorno

Promise<PivotSaveReport>

---

showPending()

showPending(pivotId): void

Definido em: interfaces/Pivot.ts:656

Promova uma reprise de espera ao set em exibição.

Parâmetros

pivotId

string

Retorno

void

---

unregister()

unregister(id): void

Definido em: interfaces/Pivot.ts:637

Parâmetros

id

string

Retorno

void

---

unsaved()

unsaved(): PivotRun[]

Definido em: interfaces/Pivot.ts:679

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

Retorno

PivotRun[]

---

unsavedCount()

unsavedCount(pivotId?): object

Definido em: interfaces/Pivot.ts:684

O que um Save enviaria é exato e não consultivo. Limitado às execuções de um pivô quando recebe um ID - o que a própria linha do painel de triagem conta.

Parâmetros

pivotId?

string

Retorno

object

edges

edges: number

nodes

nodes: number

Propriedades

candidateCeiling

candidateCeiling: number

Definido em: interfaces/Pivot.ts:623

Teto absoluto sobre o que um fetch pode encenar. Recusa em vez de truncar.

---

quickIngestLimit

quickIngestLimit: number

Definido em: interfaces/Pivot.ts:629

Quantos novos candidatos um pivô de um clique chega sem triagem - o que o quickPivot do gerenciador de UI passa como PivotRunOptions.autoIngestUpTo. Uma corrida feita de qualquer outra forma não é afetada.

---

rimBadge

rimBadge: PivotRimBadge

Definido em: interfaces/Pivot.ts:631

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

---

rimBadgeVisible

rimBadgeVisible: PivotRimBadgeVisibility

Definido em: interfaces/Pivot.ts:633

Quando esses emblemas de aro são desenhados.

---

saveControls

saveControls: boolean

Definido em: interfaces/Pivot.ts:635

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