draaipunt / Pivot / PivotDefinition

Interface: PivotDefinition

Eén uitvoerbare verrijking: hoe het heet, waar het op draait, hoe je moet adverteren wat er is en hoe je het kunt ophalen.

Een draaipunt bestaat uit twee functies en enkele metadata. PivotDefinition.samenvatten is de goedkope 'wat is daarbuiten'-oproep waarvan de facetten de vernauwing worden controles; PivotDefinition.fetch is de echte. Resultaten zijn kandidaten — geënsceneerd voor triage, nooit op het canvas — tenzij de spil declareert PivotDefinition.autoIngest.

Eigenschappen

appliesTo()?

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

Gedefinieerd in: interfaces/Pivot.ts:54

Of deze spil van toepassing is op een bepaalde oorsprong, en op hoeveel ervan. Lees verder elke oorsprongsverandering, dus het moet synchroon en goedkoop zijn. Laat het weg en het draaipunt geldt voor alles. Niet geraadpleegd als origin 'none' is.

Retourneert een boolean voor een regel over de oorsprong als geheel — "alleen met twee of meer geplukt", "nooit op een briefje". Retourneer de nodes waarop deze van toepassing is voor een regel dat één knooppunt tegelijk leest, wat normaal is bij verrijking: selectie die een domein en een IP combineert, biedt nog steeds de providers die alleen domeinen gebruiken, alleen tegen het domein. Een lege array betekent hetzelfde als false.

Wat het ook bewaart, het is de oorsprong waarmee de provider wordt aangeroepen — summarize en fetch zie nooit een knooppunt dat zo is afgewezen.

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

Parameters

nodes

Node[]

Retouren

boolean | Node[]

autoIngest?

optional autoIngest: boolean

Gedefinieerd in: interfaces/Pivot.ts:96

Landresultaten direct in plaats van ze voor triage te organiseren. Voor klein, vertrouwd resultaten – een gebeurtenis uitbreiden naar zijn objecten – niet voor niets een analist zou willen doornemen. De pet geldt nog steeds.

true en false zijn beide antwoorden, en beide gelden ongeacht de start van de run. Als je dit niet instelt, is niet hetzelfde als false: er staat dat het draaipunt geen weergave heeft, dus een run met één klik kan alleen de grootte bepalen - zie PivotRunOptions.autoIngestUpTo. Runs die op een andere manier worden gemaakt, zijn nog steeds een podium.

Standaard

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

autoSave?

optional autoSave: boolean

Gedefinieerd in: interfaces/Pivot.ts:129

Schrijf elke run op het moment dat deze landt, zonder gebaar. Voor een spil waarvan de resultaten zijn al de eigen gegevens van het bronsysteem en breiden een gebeurtenis uit naar zijn eigen gegevens objecten — waarbij opslaan een update is in plaats van een beslissing.

Het opslaan wordt uitgevoerd nadat de opname is opgelost in plaats van erin, dus langzaam backend houdt nooit het canvas omhoog; het resultaat ervan wordt door de kennisgever gerapporteerd.

Standaard

false

fetch()

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

Gedefinieerd in: interfaces/Pivot.ts:84

De echte opbrengst, beperkt door wat de analist heeft gekozen.

Parameters

icon?

optional icon: string

Gedefinieerd in: interfaces/Pivot.ts:27

SVG string, geïnjecteerd met innerHTML en niet opgeschoond — deze moet vertrouwd worden.

id

id: string

Gedefinieerd in: interfaces/Pivot.ts:23

Stabiele identiteit: waar het register op sleutelt, en de herkomsttag geschreven bij ingest.

label

label: string

Gedefinieerd in: interfaces/Pivot.ts:25

Label, woordelijk gebruikt (zodat het vertaald kan worden).

maxCandidates?

optional maxCandidates: number

Gedefinieerd in: interfaces/Pivot.ts:104

Weigeren om op te halen terwijl het geadverteerde aantal dit overschrijdt. Een telling die de aanbieder doet weet niet (total: null) wordt nooit geweigerd. Er is geen bibliotheek standaard: een pivot die geen limiet aangeeft, wordt nooit afgesloten door één (de absolute plafond van PivotManagerLike.candidateCeiling geldt nog steeds voor wat fetch retourneert).

menuChoices()?

optional menuChoices: (nodes) => PivotMenuChoice[]

Gedefinieerd in: interfaces/Pivot.ts:72

Keuzes voor het contextmenu. Bij any opent de rij van het draaipunt een submenu met één rij per keuze, waarbij elk het draaipunt op de plek met die vernauwing draait, en een laatste rij het draaipaneel openen. Ontvangt de knooppunten waarop het draaipunt van toepassing is. Synchrone en goedkoop, zoals appliesTo: het wordt elke keer uitgevoerd wanneer het menu wordt geopend.

Geef [] terug, of laat de haak weg, voor een gewone rij die zonder vernauwing loopt.

Parameters

nodes

Node[]

Retouren

PivotMenuChoice[]

Voorbeeld

// 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"

Gedefinieerd in: interfaces/Pivot.ts:34

Waar deze spil op draait. 'selection' draaipunten hebben een oorsprong nodig — de knooppunten de analist wees naar; 'none' pivots hebben helemaal geen knooppunten nodig (zoeken, importeren, a staging tray) en ontvang [].

Standaard

'selection'

save()?

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

Gedefinieerd in: interfaces/Pivot.ts:119

Schrijf het resultaat van een opgenomen run terug naar het bronsysteem: de ene helft van de contract dat niet alleen-lezen is.

Als u dit weglaat, zijn de resultaten van deze pivot not saveable: ze komen nooit in de grootboek, worden nooit als niet-opgeslagen meegeteld en er verschijnt geen Opslaan voor hen. Een draai om afgeleide gegevens die nergens kunnen worden geschreven, moeten deze liever weglaten verklaar er een die faalt.

Nooit zelf door de bibliotheek gebeld – een expliciete PivotManagerLike.save, of PivotDefinition.autoSave. De consument voert het schrijven uit; de bibliotheek vraagt er alleen om en registreert de antwoord.

Parameters

payload

PivotSavePayload

ctx

PivotSaveContext

Retouren

PivotSaveOutcome | Promise<PivotSaveOutcome>

summarize()?

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

Gedefinieerd in: interfaces/Pivot.ts:82

Goedkoop "wat is daar". Aangeroepen met {} voordat er sprake is van vernauwing, en opnieuw uitgevoerd als de oorsprong of de vernauwing verandert; de facetten ervan worden de vernauwing controleert en de total is het getal waartegen de limiet wordt beoordeeld.

Laat het weg en de spil biedt geen geadverteerde telling en geen vernauwing – legaal, maar dan moet PivotDefinition.fetch veilig zijn om blind te callen, aangezien er niets kan het poortje.

Parameters

nodes

Node[]

narrowing

PivotNarrowing

ctx

PivotContext

Retouren

PivotSummary | Promise<PivotSummary>

Interface: PivotDefinition ​

Eigenschappen ​

appliesTo()? ​

Parameters ​

nodes ​

Retouren ​

autoIngest? ​

Standaard ​

autoSave? ​

Standaard ​

fetch() ​

Parameters ​

nodes ​

narrowing ​

ctx ​

Retouren ​

icon? ​

id ​

label ​

maxCandidates? ​

menuChoices()? ​

Parameters ​

nodes ​

Retouren ​

Voorbeeld ​

origin? ​

Standaard ​

save()? ​

Parameters ​

payload ​

ctx ​

Retouren ​

summarize()? ​

Parameters ​

nodes ​

narrowing ​

ctx ​

Retouren ​

Interface: PivotDefinition

Eigenschappen

appliesTo()?

Parameters

nodes

Retouren

autoIngest?

Standaard

autoSave?

Standaard

fetch()

Parameters

nodes

narrowing

ctx

Retouren

icon?

id

label

maxCandidates?

menuChoices()?

Parameters

nodes

Retouren

Voorbeeld

origin?

Standaard

save()?

Parameters

payload

ctx

Retouren

summarize()?

Parameters

nodes

narrowing

ctx

Retouren