Pivotick / Pivot / PivotDefinition

Interface: PivotDefinition

Eine ausführbare Bereicherung: wie sie heißt, worauf sie läuft, wie man ankündigt, was da draußen ist, und wie man es abruft.

Ein Pivot besteht aus zwei Funktionen und einigen Metadaten. PivotDefinition.summarize ist der billige „Was ist da draußen“-Aufruf, dessen Facetten zu den einschränkenden Kontrollen werden; PivotDefinition.fetch ist das echte. Die Ergebnisse sind Kandidaten – zur Triage bereitgestellt, niemals auf der Arbeitsfläche – es sei denn, der Pivot deklariert PivotDefinition.autoIngest.

Eigenschaften

appliesTo()?

optional appliesTo: (nodes) => boolean | Node[]

Definiert in: interfaces/Pivot.ts:54

Ob dieser Pivot auf einen bestimmten Ursprung zutrifft und für wie viel davon. Bei jeder Ursprungsänderung erneut lesen, daher muss es synchron und kostengünstig sein. Wenn Sie es weglassen, gilt der Dreh- und Angelpunkt für alles. Wird nicht herangezogen, wenn origin 'none' ist.

Gibt einen boolean für eine Regel über den Ursprung als Ganzes zurück – „nur bei zwei oder mehr ausgewählten“, „nie auf einer Notiz“. Geben Sie die Knoten zurück, auf die sie angewendet wird für eine Regel, die jeweils einen Knoten liest, was der Normalfall für die Anreicherung ist: Eine Auswahl, die eine Domäne und eine IP mischt, bietet immer noch die reinen Domänenanbieter gegenüber der Domäne allein an. Ein leeres Array bedeutet dasselbe wie false.

Was auch immer beibehalten wird, ist der Ursprung, mit dem der Anbieter aufgerufen wird – summarize und fetch. Es wird nie ein Knoten angezeigt, der so abgelehnt wurde.

appliesTo: nodes => nodes.length >= 2                          // whole origin
appliesTo: nodes => nodes.filter(n => accepted.has(typeOf(n))) // per node

Parameter

nodes

Node[]

Rückgabewert

boolean | Node[]

autoIngest?

optional autoIngest: boolean

Definiert in: interfaces/Pivot.ts:96

Landen Sie die Ergebnisse direkt, anstatt sie zur Triage bereitzustellen. Für kleine, vertrauenswürdige Ergebnisse – die Erweiterung eines Ereignisses in seine Objekte – und nicht für irgendetwas, das ein Analyst durchsuchen möchte. Die Obergrenze gilt weiterhin.

true und false sind beide Antworten, und beide gelten unabhängig davon, wie der Lauf gestartet wurde. Es nicht eingestellt zu lassen ist nicht dasselbe wie false: Es heißt, dass der Pivot keine Ansicht hat, sodass ein Ein-Klick-Durchlauf allein über die Größe entscheiden kann – siehe PivotRunOptions.autoIngestUpTo. Läuft auf andere Weise noch Bühne.

Standardwert

undefined — stages, unless the run itself sets a size to land under

autoSave?

optional autoSave: boolean

Definiert in: interfaces/Pivot.ts:129

Schreiben Sie jeden Lauf in dem Moment auf, in dem er landet, ohne Geste. Für einen Pivot, dessen Ergebnisse bereits die eigenen Daten des Quellsystems sind – die Erweiterung eines Ereignisses in seine Objekte –, bei dem das Speichern eher eine Aktualisierung als eine Entscheidung ist.

Der Speichervorgang wird nach der Auflösung der Aufnahme ausgeführt und nicht innerhalb dieser, sodass ein langsames Backend die Arbeitsfläche nie aufhält; das Ergebnis wird vom Anmelder gemeldet.

Standardwert

false

fetch()

fetch: (nodes, narrowing, ctx) => PivotResult | Promise<PivotResult>

Definiert in: interfaces/Pivot.ts:84

Die tatsächliche Reichweite, eingegrenzt durch die Auswahl des Analysten.

Parameter

icon?

optional icon: string

Definiert in: interfaces/Pivot.ts:27

SVG-String, mit innerHTML injiziert und nicht bereinigt – es muss vertrauenswürdig sein.

id

id: string

Definiert in: interfaces/Pivot.ts:23

Stabile Identität: die Registrierungsschlüssel und das bei der Aufnahme geschriebene Herkunftskennzeichen.

label

label: string

Definiert in: interfaces/Pivot.ts:25

Bezeichnung, wörtlich verwendet (damit sie übersetzt werden kann).

maxCandidates?

optional maxCandidates: number

Definiert in: interfaces/Pivot.ts:104

Den Abruf verweigern, solange die angekündigte Anzahl diesen Wert überschreitet. Eine Zählung, die der Anbieter nicht kennt (total: null), wird niemals abgelehnt. Es gibt keine Bibliotheksvorgabe: Ein Pivot, der keine Obergrenze angibt, wird niemals durch eine begrenzt (die absolute Obergrenze von PivotManagerLike.candidateCeiling gilt weiterhin für das, was fetch zurückgibt).

menuChoices()?

optional menuChoices: (nodes) => PivotMenuChoice[]

Definiert in: interfaces/Pivot.ts:72

Auswahlmöglichkeiten für das Kontextmenü. Bei „any“ öffnet die Zeile des Pivots ein Untermenü mit einer Zeile pro Auswahl, wobei jede Zeile den Pivot auf der Stelle mit dieser Verengung ausführt und eine letzte Zeile das Pivot-Panel öffnet. Empfängt die Knoten, auf die der Pivot angewendet wird. Synchron und günstig, wie appliesTo: Es wird jedes Mal ausgeführt, wenn das Menü geöffnet wird.

Geben Sie [] zurück oder lassen Sie den Haken weg, um eine einfache Reihe zu erhalten, die ohne Verengung verläuft.

Parameter

nodes

Node[]

Rückgabewert

PivotMenuChoice[]

Beispiel

// Enrich an object through one of its attributes.
menuChoices: ([object]) => attributesOf(object).map(a => ({
    label: `${a.type}: ${a.value}`,
    narrowing: { attribute: [a.id] },
}))

origin?

optional origin: "none" | "selection"

Definiert in: interfaces/Pivot.ts:34

Worauf dieser Pivot läuft. 'selection' Pivots benötigen einen Ursprung – die Knoten, auf die der Analyst gezeigt hat; 'none' Pivots benötigen überhaupt keine Knoten (Suche, Import, ein Staging-Tray) und empfangen [].

Standardwert

'selection'

save()?

optional save: (payload, ctx) => PivotSaveOutcome | Promise<PivotSaveOutcome>

Definiert in: interfaces/Pivot.ts:119

Schreiben Sie das Ergebnis eines aufgenommenen Laufs zurück in das Quellsystem – die eine Vertragshälfte, die nicht schreibgeschützt ist.

Wenn Sie es weglassen, sind die Ergebnisse dieses Pivots nicht speicherbar: Sie gelangen nie in das Hauptbuch, werden nie ungespeichert gezählt und für sie wird keine Speicherung angezeigt. Ein Pivot über abgeleitete Daten, die nirgendwo geschrieben werden konnten, sollte ihn weglassen, anstatt einen Pivot zu deklarieren, der fehlschlägt.

Wird nie von der Bibliothek alleine aufgerufen – ein explizites PivotManagerLike.save oder PivotDefinition.autoSave. Der Verbraucher führt den Schreibvorgang durch; Die Bibliothek fragt nur danach und zeichnet die Antwort auf.

Parameter

payload

PivotSavePayload

ctx

PivotSaveContext

Rückgabewert

PivotSaveOutcome | Promise<PivotSaveOutcome>

summarize()?

optional summarize: (nodes, narrowing, ctx) => PivotSummary | Promise<PivotSummary>

Definiert in: interfaces/Pivot.ts:82

Billig „was da draußen ist“. Wird mit {} aufgerufen, bevor eine Verengung vorliegt, und erneut ausgeführt, wenn sich der Ursprung oder die Verengung ändert. Seine Facetten werden zu den einschränkenden Kontrollen und seine total ist die Zahl, anhand derer die Obergrenze beurteilt wird.

Wenn Sie es weglassen, bietet der Pivot keine angekündigte Anzahl und keine Einengung – legal, aber dann muss PivotDefinition.fetch sicher sein, blind zu callen, da nichts es toren kann.

Parameter

nodes

Node[]

narrowing

PivotNarrowing

ctx

PivotContext

Rückgabewert

PivotSummary | Promise<PivotSummary>

Interface: PivotDefinition ​

Eigenschaften ​

appliesTo()? ​

Parameter ​

nodes ​

Rückgabewert ​

autoIngest? ​

Standardwert ​

autoSave? ​

Standardwert ​

fetch() ​

Parameter ​

nodes ​

narrowing ​

ctx ​

Rückgabewert ​

icon? ​

id ​

label ​

maxCandidates? ​

menuChoices()? ​

Parameter ​

nodes ​

Rückgabewert ​

Beispiel ​

origin? ​

Standardwert ​

save()? ​

Parameter ​

payload ​

ctx ​

Rückgabewert ​

summarize()? ​

Parameter ​

nodes ​

narrowing ​

ctx ​

Rückgabewert ​

Interface: PivotDefinition

Eigenschaften

appliesTo()?

Parameter

nodes

Rückgabewert

autoIngest?

Standardwert

autoSave?

Standardwert

fetch()

Parameter

nodes

narrowing

ctx

Rückgabewert

icon?

id

label

maxCandidates?

menuChoices()?

Parameter

nodes

Rückgabewert

Beispiel

origin?

Standardwert

save()?

Parameter

payload

ctx

Rückgabewert

summarize()?

Parameter

nodes

narrowing

ctx

Rückgabewert