インターフェース: PivotDefinition
1 つの実行可能なエンリッチメント: その名前、実行対象、宣伝方法 そこに何があるのか、そしてそれをどのように取得するのか。
ピボットは 2 つの関数といくつかのメタデータです。 PivotDefinition.まとめ それは安っぽい「そこにあるもの」の呼びかけであり、その側面が狭まるものである コントロール; PivotDefinition.fetch が本物です。結果は 候補者 — トリアージのためにステージングされ、ピボットしない限り決してキャンバスには表示されません PivotDefinition.autoIngestを宣言します。
プロパティ
appliesTo()?
optionalappliesTo: (nodes) =>boolean|Node[]
このピボットが特定の原点に適用されるかどうか、またその範囲がどの程度適用されるか。再読してください すべてのオリジンが変更されるため、同期的で安価でなければなりません。それとピボットを省略します すべてに当てはまります。 originが'none'の場合は参照されません。
原点全体に関するルールに対して ブール値 を返します — 「2 つまたは 「もっと選ばれる」、「メモには決して乗らない」。ルールに適用されるノードを返します これは一度に 1 つのノードを読み取ります。これはエンリッチメントの通常のケースです。 ドメインと IP を混合した選択では、引き続きドメインのみのプロバイダーが提供されます。 ドメインのみに対して。空の配列は false と同じ意味です。
保持されているものは、プロバイダーが呼び出されるオリジン (summarize) です。 fetch これが拒否されたノードは決して表示されません。
appliesTo: nodes => nodes.length >= 2 // whole origin
appliesTo: nodes => nodes.filter(n => accepted.has(typeOf(n))) // per nodeパラメータ
nodes
Node[]
返品
boolean | Node[]
autoIngest?
optionalautoIngest:boolean
結果をトリアージのためにステージングするのではなく、直接着陸させます。小規模で信頼できる 結果 — イベントをそのオブジェクトに拡張 — アナリストのためではありません 選び抜きたいと思うでしょう。キャップは引き続き適用されます。
true と false は両方とも答えであり、実行が開始されたかどうかにかかわらず、どちらも成立します。 未設定のままにすることは、not は false と同じです。ピボットにはビューがないと表示されるため、 ワンクリックの実行ではサイズのみが決定される場合があります - を参照してください。 PivotRunOptions.autoIngestUpTo。他の方法で実行された場合は、まだステージが終了します。
デフォルト
undefined — stages, unless the run itself sets a size to land underautoSave?
optionalautoSave:boolean
それぞれのランを着地の瞬間にジェスチャーなしで書きます。結果が得られるピボットの場合 すでにソース システム独自のデータである - イベントをそのシステムに拡張する オブジェクト — 保存は決定ではなく更新です。
保存は取り込み内ではなく、取り込みが解決された後に実行されるため、時間がかかります バックエンドがキャンバスを保持することはありません。その結果は通知者によって報告されます。
デフォルト
falsefetch()
fetch: (
nodes,narrowing,ctx) =>PivotResult|Promise<PivotResult>
アナリストが選択したものによって絞り込まれた実際のフェッチ。
パラメータ
nodes
Node[]
narrowing
ctx
返品
PivotResult | Promise<PivotResult>
icon?
optionalicon:string
SVG 文字列、innerHTML が注入され、サニタイズされていない — 信頼される必要があります。
id
id:
string
安定したアイデンティティ: レジストリ キーの対象となるもの、および取り込み時に書き込まれた来歴タグ。
label
label:
string
ラベル、そのまま使用されます（翻訳できるように）。
maxCandidates?
optionalmaxCandidates:number
通知された数がこれを超えている間はフェッチを拒否します。プロバイダーが行うカウント わからない(total: null)は決して拒否されません。図書館はありません デフォルト: キャップなしを宣言するピボットは、キャップによってゲートされることはありません (絶対 PivotManagerLike.candidateCeiling の上限は引き続き何に適用されますか fetch が戻ります)。
menuChoices()?
optionalmenuChoices: (nodes) =>PivotMenuChoice[]
コンテキスト メニューの選択肢。 any を使用すると、ピボットの行によって 1 行のサブメニューが開きます 選択肢ごとに、それぞれが狭くなった場所でピボットを実行し、最後の行を実行します ピボットパネルを開けたところ。ピボットが適用されるノードを受け取ります。同期と appliesTo のような安いもの: メニューが開くたびに実行されます。
細くならないプレーンな行の場合は、[] を返すか、フックを省略します。
パラメータ
nodes
Node[]
返品
例
// Enrich an object through one of its attributes.
menuChoices: ([object]) => attributesOf(object).map(a => ({
label: `${a.type}: ${a.value}`,
narrowing: { attribute: [a.id] },
}))origin?
optionalorigin:"none"|"selection"
このピボットが実行されるもの。 'selection' ピボットには原点、つまりノードが必要です。 アナリストは指摘した。 'none' ピボットにはノードがまったく必要ありません (検索、インポート、 ステージングトレイ)、[]を受け取ります。
デフォルト
'selection'save()?
optionalsave: (payload,ctx) =>PivotSaveOutcome|Promise<PivotSaveOutcome>
取り込まれた実行結果をソース システムに書き戻します (実行結果の半分)。 読み取り専用ではない契約。
これを省略すると、このピボットの結果は 保存不可 になります。 元帳は未保存としてカウントされることはなく、保存は表示されません。ピボットオーバー どこにも書き込むことができない派生データは、省略する必要があります。 失敗したものを宣言します。
ライブラリによって単独で呼び出されることはありません - 明示的 PivotManagerLike.保存、または PivotDefinition.autoSave。の 消費者が書き込みを実行します。図書館はそれを要求し、記録するだけです 答えてください。
パラメータ
payload
ctx
返品
PivotSaveOutcome | Promise<PivotSaveOutcome>
summarize()?
optionalsummarize: (nodes,narrowing,ctx) =>PivotSummary|Promise<PivotSummary>
安い「そこにあるもの」。絞り込みが存在する前に {} で呼び出され、 原点または絞り込みの変更として再実行します。その面は狭くなります コントロールであり、その total はキャップが判断される番号です。
これを省略すると、ピボットは広告カウントも絞り込みも提供しません。合法ではありますが、 そうすると、PivotDefinition.fetch はブラインドと呼んでも安全でなければなりません。 それをゲートすることができます。
パラメータ
nodes
Node[]
narrowing
ctx
返品
PivotSummary | Promise<PivotSummary>