انتقل إلى المحتوى

pivotick v3.0.0


محورية / محورية / PivotDefinition

واجهة: PivotDefinition ​

محدد في: interfaces/Pivot.ts:21

أحد التخصيب القابل للتشغيل: ما اسمه، وما الذي يعمل عليه، وكيفية الإعلان عنه ما هو هناك وكيفية جلبه.

المحور عبارة عن وظيفتين وبعض البيانات الوصفية. PivotDefinition.تلخيص هي الدعوة الرخيصة "ما هو موجود" والتي أصبحت جوانبها تضيق الضوابط؛ PivotDefinition.fetch هو الحقيقي. النتائج هي المرشحون — تم تنظيمهم للفرز، وليس على القماش أبدًا — إلا إذا كان المحور يعلن PivotDefinition.autoIngest.

خصائص ​

appliesTo()? ​

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

محدد في: interfaces/Pivot.ts:54

ما إذا كان هذا المحور ينطبق على أصل معين، وإلى أي مدى منه. أعد القراءة كل أصل يتغير، لذلك يجب أن يكون متزامنًا ورخيصًا. حذفها والمحور ينطبق على كل شيء. لا يتم استشارتك عندما يكون origin هو 'none'.

قم بإرجاع boolean لقاعدة حول الأصل ككل - "فقط مع اثنين أو أكثر اختيارا"، "أبدًا في ملاحظة". قم بإرجاع العقد التي تنطبق على للحصول على قاعدة التي تقرأ عقدة واحدة في كل مرة، وهي الحالة الطبيعية للتخصيب: أ لا يزال الاختيار الذي يمزج بين النطاق وعنوان IP يقدم موفري المجال فقط، ضد المجال وحده. المصفوفة الفارغة تعني نفس false.

كل ما يحتفظ به هو الأصل الذي يتم استدعاء المزود به - summarize و fetch لا ترى أبدًا عقدة تم رفضها.

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

المعلمات ​

nodes ​

Node[]

المرتجعات ​

boolean | Node[]


autoIngest? ​

optional autoIngest: boolean

محدد في: interfaces/Pivot.ts:96

نتائج الأراضي مباشرة بدلا من تنظيمها للفرز. للصغيرة والموثوقة النتائج - توسيع الحدث إلى أهدافه - ليس من أجل أي شيء محلل سوف ترغب في اختيار من خلال. الحد الأقصى لا يزال ساريا.

true و false كلاهما إجابتان، وكلاهما ثابت على الرغم من بدء السباق. تركه بدون ضبط هو not نفس false: يقول أن المحور ليس له رؤية، لذلك قد يحدد التشغيل بنقرة واحدة الحجم وحده - راجع PivotRunOptions.autoIngestUpTo. يتم تشغيل أي طريقة أخرى لا تزال مرحلة.

الافتراضي ​

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

autoSave? ​

optional autoSave: boolean

محدد في: interfaces/Pivot.ts:129

اكتب كل جولة لحظة هبوطها، دون أي إشارة. لمحور الذي نتائجه هي البيانات الخاصة بالنظام المصدر بالفعل - مما يؤدي إلى توسيع الحدث إلى داخله الأشياء - حيث يكون الحفظ تحديثًا وليس قرارًا.

يتم تشغيل عملية الحفظ بعد حل عملية الاستيعاب وليس داخلها، لذا فهي بطيئة الواجهة الخلفية لا تحمل اللوحة القماشية أبدًا؛ ويتم الإبلاغ عن نتائجها من قبل المخطر.

الافتراضي ​

ts
false

fetch() ​

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

محدد في: interfaces/Pivot.ts:84

الجلب الحقيقي، يضيق بما اختاره المحلل.

المعلمات ​

nodes ​

Node[]

narrowing ​

PivotNarrowing

ctx ​

PivotContext

المرتجعات ​

PivotResult | Promise<PivotResult>


icon? ​

optional icon: string

محدد في: interfaces/Pivot.ts:27

خيط SVG محقون بـ innerHTML وغير معقم – يجب الوثوق به.


id ​

id: string

محدد في: interfaces/Pivot.ts:23

الهوية المستقرة: ما هي مفاتيح التسجيل وعلامة المصدر المكتوبة عند الاستيعاب.


label ​

label: string

محدد في: interfaces/Pivot.ts:25

التسمية، تستخدم حرفيا (حتى يمكن ترجمتها).


maxCandidates? ​

optional maxCandidates: number

محدد في: interfaces/Pivot.ts:104

رفض الجلب بينما العدد المعلن عنه يتجاوز هذا. عدد يفعله المزود لا أعرف (total: null) لا يتم رفضه أبدًا. لا توجد مكتبة الافتراضي: المحور الذي يعلن عن عدم وجود حد أقصى لا يتم بوابته أبدًا بواحد (المطلق سقف PivotManagerLike.candidateCeiling لا يزال ينطبق على ماذا fetch عوائد).


optional menuChoices: (nodes) => PivotMenuChoice[]

محدد في: interfaces/Pivot.ts:72

خيارات لقائمة السياق. مع أي صف، يفتح الصف المحوري قائمة فرعية تحتوي على صف واحد لكل اختيار، كل تشغيل المحور على الفور مع ذلك التضييق، والصف الأخير فتح اللوحة المحورية. يتلقى العقد التي ينطبق عليها المحور. متزامن و رخيص، مثل appliesTo: يتم تشغيله في كل مرة تفتح فيها القائمة.

ارجع []، أو احذف الخطاف، لصف عادي يسير بلا تضييق.

المعلمات ​

nodes ​

Node[]

المرتجعات ​

PivotMenuChoice[]

مثال ​

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

محدد في: interfaces/Pivot.ts:34

ما الذي يعمل عليه هذا المحور. 'selection' المحاور تحتاج إلى أصل — العقد وأشار المحلل إلى؛ 'none' لا تحتاج المحاور إلى عقد على الإطلاق (بحث، استيراد، أ صينية التدريج) واحصل على [].

الافتراضي ​

ts
'selection'

save()? ​

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

محدد في: interfaces/Pivot.ts:119

قم بكتابة نتيجة التشغيل المبتلع مرة أخرى إلى النظام المصدر - نصف الملف العقد الذي ليس للقراءة فقط.

احذفها وستكون نتائج هذا المحور غير قابلة للحفظ: لا تدخل أبدًا دفتر الأستاذ، لا يتم اعتبارهم غير محفوظين أبدًا، ولا يظهر لهم حفظ. محور أكثر البيانات المشتقة التي لا يمكن كتابتها في أي مكان يجب حذفها بدلاً من ذلك أعلن واحدة التي فشلت.

لم يتم استدعاؤها من قبل المكتبة من تلقاء نفسها - وهو أمر صريح PivotManagerLike.حفظ أو PivotDefinition.autoSave. ال يقوم المستهلك بالكتابة؛ المكتبة تطلب ذلك فقط وتسجل إجابة.

المعلمات ​

payload ​

PivotSavePayload

ctx ​

PivotSaveContext

المرتجعات ​

PivotSaveOutcome | Promise<PivotSaveOutcome>


summarize()? ​

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

محدد في: interfaces/Pivot.ts:82

رخيصة "ما هو هناك". يتم الاتصال بـ {} قبل وجود أي تضييق، و إعادة التشغيل مع تغير الأصل أو التضييق؛ جوانبها تصبح التضييق الضوابط وtotal هو الرقم الذي يتم الحكم على الحد الأقصى وفقًا له.

احذفه ولن يقدم المحور أي عدد معلن عنه أو تضييق - قانوني، ولكن ثم PivotDefinition.fetch يجب أن يكون آمنًا للاتصال بالمكفوفين، حيث لا يوجد شيء يمكن بوابة ذلك.

المعلمات ​

nodes ​

Node[]

narrowing ​

PivotNarrowing

ctx ​

PivotContext

المرتجعات ​

PivotSummary | Promise<PivotSummary>