pivote / Pivote / PivotDefinition

Interfaz: PivotDefinition

Un enriquecimiento ejecutable: cómo se llama, con qué se ejecuta, cómo anunciarlo qué hay ahí fuera y cómo conseguirlo.

Un pivote son dos funciones y algunos metadatos. PivotDefinition.resumir es la llamada barata "lo que hay ahí afuera" cuyas facetas se convierten en la controles; PivotDefinition.fetch es el verdadero. Los resultados son candidatos – preparados para selección, nunca en la lona – a menos que el pivote declara PivotDefinition.autoIngest.

Propiedades

appliesTo()?

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

Definido en: interfaces/Pivot.ts:54

Si este pivote se aplica a un origen determinado y en qué medida. Vuelva a leer Cada cambio de origen, por lo que debe ser sincrónico y barato. Omitirlo y el pivote. se aplica a todo. No consultado cuando origin es 'none'.

Devuelve un booleano para una regla sobre el origen en su conjunto - "sólo con dos o más elegido", "nunca en una nota". Devuelve los nodos a los que se aplica para una regla que lee un nodo a la vez, que es el caso normal de enriquecimiento: un La selección que combina un dominio y una IP todavía ofrece a los proveedores de solo dominio, solo contra el dominio. Una matriz vacía significa lo mismo que false.

Lo que mantiene es el origen con el que se llama al proveedor: summarize y fetch nunca veo un nodo tan rechazado.

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

Parámetros

nodes

Node[]

Devoluciones

boolean | Node[]

autoIngest?

optional autoIngest: boolean

Definido en: interfaces/Pivot.ts:96

Obtenga los resultados directamente en lugar de prepararlos para su clasificación. Para pequeños y confiables resultados (expandir un evento en sus objetos) no por nada un analista querría elegir. El límite todavía se aplica.

true y false son respuestas y ambas se mantienen sin importar cómo se inició la ejecución. Dejarlo sin configurar es no lo mismo que false: dice que el pivote no tiene vista, por lo que una ejecución con un solo clic puede decidir solo el tamaño; consulte PivotRunOptions.autoIngestUpTo. Las carreras realizadas de otra manera siguen siendo escenario.

Predeterminado

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

autoSave?

optional autoSave: boolean

Definido en: interfaces/Pivot.ts:129

Escribe cada carrera en el momento en que aterriza, sin ningún gesto. Para un pivote cuyos resultados ya son datos propios del sistema fuente: expandir un evento a su objetos, donde guardar es una actualización más que una decisión.

El guardado se ejecuta después de que se resuelve la ingesta en lugar de dentro de ella, por lo que una operación lenta el backend nunca sostiene el lienzo; su resultado es informado por el notificante.

Predeterminado

false

fetch()

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

Definido en: interfaces/Pivot.ts:84

El alcance real, limitado por lo que eligió el analista.

Parámetros

icon?

optional icon: string

Definido en: interfaces/Pivot.ts:27

SVG hilo, inyectado con innerHTML y no desinfectado: se debe confiar en él.

id

id: string

Definido en: interfaces/Pivot.ts:23

Identidad estable: cuáles son las claves de registro y la etiqueta de procedencia escrita en la ingesta.

label

label: string

Definido en: interfaces/Pivot.ts:25

Etiqueta, usada palabra por palabra (para que pueda traducirse).

maxCandidates?

optional maxCandidates: number

Definido en: interfaces/Pivot.ts:104

Negarse a buscar mientras el recuento anunciado exceda este límite. Un conteo que hace el proveedor No sé (total: null) nunca se rechaza. no hay biblioteca predeterminado: un pivote que declara que no hay límite nunca es cerrado por uno (el valor absoluto El límite máximo de PivotManagerLike.candidateCeiling todavía se aplica a lo que fetch devoluciones).

menuChoices()?

optional menuChoices: (nodes) => PivotMenuChoice[]

Definido en: interfaces/Pivot.ts:72

Opciones para el menú contextual. Con cualquiera, la fila del pivote abre un submenú con una fila por elección, cada uno ejecutando el pivote en el lugar con ese estrechamiento, y una última fila abriendo el panel pivotante. Recibe los nodos a los que se aplica el pivote. sincrónico y barato, como appliesTo: se ejecuta cada vez que se abre el menú.

Regrese [] u omita el gancho para obtener una fila simple que corra sin estrecharse.

Parámetros

nodes

Node[]

Devoluciones

PivotMenuChoice[]

Ejemplo

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

Definido en: interfaces/Pivot.ts:34

Sobre qué se ejecuta este pivote. 'selection' los pivotes necesitan un origen: los nodos analista señaló; 'none' los pivotes no necesitan ningún nodo (buscar, importar, bandeja de preparación) y reciba [].

Predeterminado

'selection'

save()?

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

Definido en: interfaces/Pivot.ts:119

Escribe el resultado de una ejecución ingerida en el sistema fuente: la mitad de la contrato que no es de sólo lectura.

Omítelo y los resultados de este pivote serán no se pueden guardar: nunca ingresan al libro mayor, nunca se cuentan como no guardados y no aparece ningún Guardar para ellos. Un giro sobre Los datos derivados que no se pueden escribir en ninguna parte deben omitirlos en lugar de declarar uno que falla.

Nunca llamado por la biblioteca por sí solo: un explícito PivotManagerLike.save, o PivotDefinition.autoSave. el el consumidor realiza la escritura; la biblioteca sólo lo solicita y registra el respuesta.

Parámetros

payload

PivotSavePayload

ctx

PivotSaveContext

Devoluciones

PivotSaveOutcome | Promise<PivotSaveOutcome>

summarize()?

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

Definido en: interfaces/Pivot.ts:82

Barato "lo que hay por ahí". Llamado con {} antes de que exista cualquier estrechamiento, y volver a ejecutar cuando cambie el origen o el estrechamiento; sus facetas se convierten en el estrechamiento controles y su total es el número con el que se juzga el límite.

Si se omite, el pivote no ofrecerá ningún recuento anunciado ni limitación: es legal, pero entonces PivotDefinition.fetch debe ser seguro para llamar a ciegas, ya que nada puede cerrarlo.

Parámetros

nodes

Node[]

narrowing

PivotNarrowing

ctx

PivotContext

Devoluciones

PivotSummary | Promise<PivotSummary>

Interfaz: PivotDefinition ​

Propiedades ​

appliesTo()? ​

Parámetros ​

nodes ​

Devoluciones ​

autoIngest? ​

Predeterminado ​

autoSave? ​

Predeterminado ​

fetch() ​

Parámetros ​

nodes ​

narrowing ​

ctx ​

Devoluciones ​

icon? ​

id ​

label ​

maxCandidates? ​

menuChoices()? ​

Parámetros ​

nodes ​

Devoluciones ​

Ejemplo ​

origin? ​

Predeterminado ​

save()? ​

Parámetros ​

payload ​

ctx ​

Devoluciones ​

summarize()? ​

Parámetros ​

nodes ​

narrowing ​

ctx ​

Devoluciones ​

Interfaz: PivotDefinition

Propiedades

appliesTo()?

Parámetros

nodes

Devoluciones

autoIngest?

Predeterminado

autoSave?

Predeterminado

fetch()

Parámetros

nodes

narrowing

ctx

Devoluciones

icon?

id

label

maxCandidates?

menuChoices()?

Parámetros

nodes

Devoluciones

Ejemplo

origin?

Predeterminado

save()?

Parámetros

payload

ctx

Devoluciones

summarize()?

Parámetros

nodes

narrowing

ctx

Devoluciones