ErdEditorElement

المحرر عنصر HTMLElement عادي، هو الوسم <erd-editor> الذي يعرّفه استيراد @dineug/erd-editor/erd-editor.js.
ومنذ الإصدار 5.0.0 لا يعرّف استيراد جذر الحزمة أي وسم. يصدّر الجذر ErdEditorElement نوعًا للعنصر وفئةً له في آن واحد، وdefineErdEditor() الذي يعرّف الوسم في الموضع الذي تستدعيه فيه، راجع تسجيل العناصر.
وللصفحة التي تعرض مخططًا فحسب، يوجد <erd-viewer> وهو عنصر للقراءة فقط قائم بذاته.

import '@dineug/erd-editor/erd-editor.js';

const editor = document.createElement('erd-editor');

تعريف نوعه كما يلي.

interface ErdEditorElement extends HTMLElement {
  readonly: boolean;
  systemDarkMode: boolean; // system dark/light auto
  enableThemeBuilder: boolean;
  enableLocalePicker: boolean;
  enableWelcomeScreen: boolean;
  value: string;
  readonly runtimeValue: string;
  focus: () => void;
  blur: () => void;
  clear: () => void;
  destroy: () => void;
  setInitialValue: (value: string) => void;
  setPresetTheme: (themeOptions: Partial<ThemeOptions>) => void;
  setSystemAppearance: (appearance: 'dark' | 'light' | null) => void;
  setTheme: (theme: Partial<Theme>) => void;
  setLocale: (locale: LocaleOption) => void;
  setSystemLocale: (locale: string | null) => void;
  setKeyBindingMap: (
    keyBindingMap: Partial<
      Omit<
        KeyBindingMap,
        | 'edit'
        | 'stop'
        | 'undo'
        | 'redo'
        | 'zoomIn'
        | 'zoomOut'
        | 'zoomReset'
      >
    >
  ) => void;
  setSchemaSQL: SetSchema;
  setSchemaGraphQL: SetSchema;
  setSchemaDBML: SetSchema;
  setSchemaAML: SetSchema;
  setSchemaJSON: (
    value: string,
    options?: { mode?: 'replace' | 'append' }
  ) => void;
  getSchemaSQL: (
    databaseVendor?: DatabaseVendor,
    options?: SchemaSQLOptions
  ) => string;
  getSharedStore: (
    config?: SharedStoreConfig & {
      mouseTracker?: boolean;
      focusTracker?: boolean;
    }
  ) => SharedStore;
  setDiffValue: (value: string) => void;
}

يُعرَض المحرر داخل shadow root مغلق، لذا تكون قيمة editor.shadowRoot هي null، ولا تتسرب أنماط الصفحة إلى داخله ولا أنماطه إلى خارجه.
ولا يمكن الوصول إلى أي شيء بداخله بمُحدِّد CSS — بل نسّق مظهره عبر setTheme وخصائص CSS المخصصة --erd-editor-*.

السمات الوحيدة هي readonly وsystem-dark-mode وenable-theme-builder وenable-locale-picker وenable-welcome-screen، والقيمة الافتراضية للخمس كلها false. السمتان الأخيرتان جديدتان في الإصدار 4.0.0. وتقرأ كل منها قيمتها كما يصف قسم readonly.

منذ الإصدار 4.1.0، تحتوي علامة تبويب ERD على المستكشف، وهو شجرة للمخطط مثبتة على يسار لوحة الرسم، وفي أعلاها البحث والاستبدال. لا توجد سمة أو خاصية أو دالة أو حدث يفتحه أو يغلقه أو يُبلغ عن حالته: فهو يُفتح من الزر Explorer في شريط الأدوات، أو من Toggle Explorer في البحث السريع أو في قائمة السياق للوحة الرسم، أو باستخدام الاختصار findReplace.
يبدأ كل عنصر والمستكشف مغلق. وتبقى حالة فتحه وعرضه وحالة الطي فيه وبحثه ما دام العنصر موجودًا، عبر تبديل علامات التبويب وكل عملية تحميل، بما فيها setInitialValue، ولا تدخل أبدًا في value أو runtimeValue أو سجل التراجع أو أي مخزن مشترك.

منذ الإصدار 4.2.0، يمكن أن يكون للجداول والأعمدة أسماء منطقية بجانب أسمائها، ويحدد عرض الأسماء، وهو إعداد للمستند مثل علامة التبويب، ما إذا كانت لوحة الرسم ترسم أسماءها أو أسماءها المنطقية أو كليهما.
ويحتوي شريط الأدوات أيضًا على علامة تبويب القاموس، بين Code Generator وSettings، وفيها كلمات المستند ومصطلحاته ومجالاته والورقة Checks. وهي علامة تبويب مثل غيرها: يحمل قفل Canvas Type قيمة canvasType الخاصة بها، أي '@dineug/erd-editor/builtin-dictionary'، لذا فإن النص المحفوظ عليها يُفتح عليها عبر setInitialValue، ولا يُكتب التبديل إليها في value ولا يُطلِق change إلا ما دام ذلك القفل معطّلًا. ولا توجد سمة أو خاصية أو دالة أو حدث خاص بها يفتحها أو يُبلغ عن حالتها. وتعديلاتها تغييرات في المستند: فهي في value، وتُطلِق change، وتصل إلى المتعاونين، لكن التراجع عنها وإعادتها يجريان على السجل الخاص بكل ورقة، لا على سجل المستند.
أما حالة علامة التبويب نفسها — أي الورقة المعروضة، وهي Domains في البداية، وبحث كل ورقة وتحديدها وموضع تمريرها وعروض أعمدتها — فتبقى ما دام العنصر موجودًا، عبر تبديل علامات التبويب وكل عملية تحميل، ولا تدخل أبدًا في value أو runtimeValue أو أي سجل تراجع أو أي مخزن مشترك.
لا يُضاف أي عضو إلى الواجهة ErdEditorElement. وما تضيفه الواجهة البرمجية هو logicalNameAsComment في خيارات getSchemaSQL، و12 رمزًا من رموز النسق، والتصدير dictionaryRowChords.

readonly

يضبط إمكانية التحرير في المحرر.
أثناء ضبطه، يُتجاهل كل من إسناد قيمة إلى value وclear() وsetSchemaSQL() وsetSchemaGraphQL() وsetSchemaDBML() وsetSchemaAML() وsetSchemaJSON() والتراجع والإعادة، بما في ذلك منذ الإصدار 4.2.0 التراجع والإعادة في ورقة من أوراق القاموس، ولا يُطلَق الحدث change أبدًا. حمّل المستند باستخدام setInitialValue بدلًا من ذلك.
منذ الإصدار 5.0.0 يكون المحرر للقراءة فقط قارئًا لا محررًا عُطّلت عناصر التحكم فيه. فهو يحتفظ بعلامات تبويبه الست والمستكشف والخريطة المصغّرة والبحث السريع وخصائص الجدول وعارض الفروق وExport ووضع الزن ومؤشرات المتعاونين وتركيزهم وتحديداتهم، ويُحذف كل عنصر تحكم كان سيعدّل المخطط بدلًا من رسمه معطّلًا. وقبل 5.0.0 كان كثير من عناصر التحرير فيه لا يزال يُرسم، ويُسقط المحرر ما ترسله.

في علامة تبويب ERD يحرّك السحب العرض من أي موضع يبدأ فيه، على جدول أيضًا، ولا يحدد الضغط شيئًا ولا ينقله ولا يفتح شيئًا. ويُبرز المؤشر المستقر على جدول علاقاته، وتُبقي النقرة الثابتة على جدول أو على علاقة ذلك الإبراز، وتُزيله نقرة ثابتة في أي موضع آخر، كما في <erd-viewer>. والتحديد الوحيد هو الإطار الذي يتركه الانتقال: فالانتقال إلى صف في المستكشف أو إلى إحدى نتائج البحث فيه أو إلى نتيجة في البحث السريع بعد # أو @ أو : يحدد ما يصل إليه، وتمحوه النقرة الثابتة التالية. ويَنسخ النسخُ ما يحمله هذا التحديد.
يحتفظ شريط أدوات لوحة الرسم بـZoom out ومستوى التكبير (Reset zoom) وZoom in وقائمة عرض الأسماء وZen Mode والبوصلة، دون Hand أو Select، ودون New Table أو New Memo أو New Table Group، ودون أزرار العلاقات. وتحتفظ قائمة لوحة الرسم بـView Option وName View وExport وDiff Viewer، وتحتفظ قائمة الجدول بـTable Properties، ولا تُظهر الملاحظة أو العلاقة أو مجموعة الجداول أي قائمة. ولا يسرد البحث السريع في علامة تبويب ERD أي صف يكتب في المخطط: فهو يحتفظ بـTab وName View وDatabase وExport وToggle Explorer وصفَّي Theme وDisplay Language اللذين يفعّلهما enableThemeBuilder وenableLocalePicker، وعمليات البحث # و@ و:. وفي علامات التبويب الأخرى يسرد ما يسرده في المحرر القابل للتحرير. ويعرض شريط الأدوات اسم قاعدة البيانات نصًا، ولا يعرض أي زر من Undo أو Redo أو Time Travel.
لا شيء يتيح Import أو Import and Add أو Auto Layout أو صفًا لمجموعة جداول (راجع مجموعات الجداول) أو Map Columns، ولا تظهر شاشة ترحيب.
والاختصارات التي تضيف أو تزيل أو تعدّل لا تفعل شيئًا: edit وaddTable وaddColumn وaddMemo وaddTableGroup وgroupSelectedTables وremoveTable وremoveColumn وremoveSelection وprimaryKey وselectAllTable وselectAllColumn والاختصارات الأربعة للعلاقات وhandTool، وكلٌّ منها لا يزال يُمنع كما يقتضي خياره. واللصق وTab لا يفعلان شيئًا أيضًا ويصلان إلى الصفحة دون منع. وتظل اختصارات التكبير وzenMode وfocusView وtableProperties على الجدول الذي حدده انتقال وsearch وfindReplace والنسخ وEscape ومفاتيح الأسهم تعمل. ولا يُفتح محرر لاسم خلية أو ملاحظة أو مجموعة جداول، ولا تُرسم علاقة.

يبحث البحث والاستبدال في أعلى المستكشف ولا يستبدل، دون سهم Toggle Replace ودون صف الاستبدال. عنوان اللوحة Explorer، ونص تلميح زر شريط الأدوات Explorer (Ctrl + F) (Windows/Linux) أو Explorer (⌘ + F) (Mac) في كل محرر. يُفتح المستكشف في المحرر للقراءة فقط منذ الإصدار 4.1.0؛ ومن 3.10.0 حتى 4.0.0 كان البحث والاستبدال يُفتح فيه كلوحة عائمة للبحث فقط عنوانها Find.
تُفتح خصائص الجدول من قائمة الجدول أو من الاختصار tableProperties، ومنذ الإصدار 3.10.0 تعرض شارة Read only بجانب عنوانها، ولا تتيح علامة التبويب Indexes فيها أي تعديل، راجع خصائص الجدول.
تحمل علامة تبويب الإعدادات الشارة Read only نفسها وتعرض كل إعداد في عنصر تحكم لا يقبل الضغط: فمفتاحاها وحقل Maximum comment width وأزرار Lock السبعة معطّلة، ولا تُسحب صفوف Column Order. ولا يقبل السكربتان Before tables وAfter tables في علامة تبويب مخطط SQL كتابة. وتعمل علامة تبويب التصور المرئي كما في المحرر القابل للتحرير، إذ لا شيء فيها يعدّل المستند؛ ولا يزال التنقل خطوةً خطوة باستخدام Previous table وNext table في وضع التدفق يعمل، بزريهما أو بمفاتيح التراجع والإعادة.
ولا تزال علامة تبويب القاموس تُفتح: إذ يمكن التبديل بين أوراقها والبحث فيها والتحديد والتمرير فيها والنسخ منها، ولا يزال صف الورقة Checks ينتقل إلى ما يسمّيه. ولا تقبل أي خلية تعديلًا أو لصقًا أو مسحًا، ولا تعرض علامة التبويب أيًّا من الأدوات Add Row أو Delete Rows أو Import CSV أو Export CSV ولا أي قائمة على الشبكة، ولا تُدرج تركيبات مفاتيح الصفوف فيها شيئًا ولا تحذف شيئًا. ولا تتيح قائمة الجدول ولا قائمة لوحة الرسم ولا البحث السريع الأمر Derive Physical Names Again ولا Derive Physical Name Again.

ومنذ الإصدار 5.0.0 تبقى الإعدادات التي لا يزال بإمكان القارئ تغييرها على شاشة ذلك المحرر: التمرير والتكبير وعلامة التبويب وقاعدة البيانات ولغة مولّد الشيفرة وكلا نمطَي التسمية ونوع علامات الاقتباس وصفوف View Option وعرض الأسماء من كل منتقٍ من منتقياته، وهو ما يبقى على الشاشة منذ 4.2.0. وأيًّا كانت أقفالها، لا يصل أي منها إلى value أو runtimeValue أو تصدير json أو سجل التراجع أو الحدث change أو مخزن مشترك، لذا يحتفظ value بإعدادات المستند مهما نظر القارئ إلى المخطط. وتعنون لوحتا خيارات مخطط SQL ومولّد الشيفرة هذه الإعدادات بـThis window only ما دام readonly مضبوطًا، حيث يقرأ العنوان في المحرر القابل للتحرير Saved in the document. وما تعرضه علامتا التبويب هاتان وتنسخانه وتحفظانه يتبع الشاشة، وكذلك getSchemaSQL حين تُستدعى دون نظام قاعدة بيانات.
قبل 5.0.0 كانت عمليات التمرير والتكبير وتبديل علامات التبويب وقاعدة البيانات وإعدادات الشيفرة التي يجريها القارئ تصل إلى value ما دام لا قفل يحجزها، وهو ما لا تفعله قاعدة البيانات أبدًا، وكان المخزن المشترك يرسلها إلى المحررات الأخرى.
أما خيارات This window only في علامة تبويب مخطط SQL نفسها، وهي Statements وHeader، ومنذ الإصدار 4.2.0 Write logical names into empty comments، وTables، فلا تُحفظ أبدًا في أي محرر وتظل سارية، وكذلك مربع الحوار Export image ومنشئ النسق ومنتقي لغة العرض. ولا يزال الاختيار في منشئ النسق أو منتقي لغة العرض يُطلِق changePresetTheme أو changeLocale.

ما دام مضبوطًا، لا يدخل شيء في سجل التراجع، بما في ذلك التمرير والتكبير، ولا يرسل المخزن المشترك للمحرر أي تغيير: بل ما ترسله أدوات التتبع الخاصة به من مؤشر القارئ وتركيزه وتحديده ومربع سحبه فقط، والمسجّلات التي يطلبها محرر آخر حين ينضم (راجع التحرير التعاوني). ولا يزال يطبّق كل تغيير ترسله المحررات الأخرى. ويصل أي تغيير في قاعدة البيانات أو في أحد إعدادات منشئ التعليمات البرمجية أو في أحد صفوف View Option إلى المستند، وإلى الشاشة أيضًا ما لم يكن القارئ قد غيّر ذلك الإعداد فيها، ويظهر تبديل عرض الأسماء المشترك على الشاشة في الحالتين. ومنذ الإصدار 5.1.0، يبقى أي تغيير في لغة منشئ التعليمات البرمجية أو نمط التسمية أو نوع علامات الاقتباس يُجرى ما دام القفل الخاص بذلك الإعداد مفعّلًا على شاشة المحرر الذي غيّره ولا يُرسَل أبدًا، فلا يصل إلى مستند القارئ ولا إلى شاشته. أما التغيير الذي يُجرى والقفل معطّل، والقيمة التي يحملها إلغاء القفل، فيصلان إليه كما سبق.

يُنهي تفعيله ما كان مفتوحًا: محرر اسم خلية أو ملاحظة أو مجموعة جداول، وعلاقة قيد الرسم، وسحب جدول أو ملاحظة أو مجموعة جداول أو عمود، ونسخ سحب Alt، وتغيير حجم ملاحظة أو مجموعة جداول، ومعاينة التخطيط التلقائي أو توزيعًا لا يزال جاريًا، وMap Columns، والسفر عبر الزمن، ومنتقي الألوان. ويمسح التحديد ويضع أداة اليد، ويرسل أولًا ما يحتجزه كل مخزن مشترك من سحب أو تمرير، كما تفعل flushStreamBuffers. وتبقى خصائص الجدول، وقد صارت للقراءة فقط، وعارض الفروق، ومربع الحوار Export image مفتوحة، ويبقى التمرير والتكبير وعلامة التبويب وعرض الأسماء كما كانت. والعنصر الذي يكون للقراءة فقط حين يُركَّب أول مرة يبدأ بالطريقة نفسها، والعنصر الذي ينقله المضيف داخل الصفحة يحتفظ بالإطار الذي تركه الانتقال.
وتعطيله يعيد عناصر التحرير دون تحديد أو شيء مفتوح. ويعود كل من قاعدة البيانات ولغة منشئ التعليمات البرمجية وكلا نمطَي التسمية ونوع علامات الاقتباس وصفوف View Option التي غيّرها القارئ إلى ما كانت الشاشة تعرضه قبل أن يغيّره القارئ أول مرة: قيمة المستند، مع أي تغيير أرسلته المحررات الأخرى في الأثناء، أو قيمة عرضها هذا المحرر بنفسه ضمن قفل الإعداد ولم يحملها value قط. وتبقى مواضع التمرير والتكبير وعلامة التبويب وعرض الأسماء حيث تركها القارئ، ويحتفظ value بإعدادات المستند إلى أن تتغير مجددًا. ولا يُطلِق أي من التحولين change.
تُقرأ السمة بلا قيمة و="" و="true" كلها على أنها true. وتُقرأ ="false" على أنها false، وكذلك أي سلسلة نصية أخرى — بما في ذلك الصيغة المألوفة في HTML readonly="readonly".

editor.readonly = true;
// or
editor.setAttribute('readonly', 'true');

<erd-editor readonly></erd-editor>

systemDarkMode

يحدد ما إذا كان المحرر يتزامن تلقائيًا مع الوضع الداكن/الفاتح في النظام.
منذ الإصدار 4.0.0، يضبط تفعيله قيمة appearance في النسق على 'system'، كما يفعل setPresetTheme({ appearance: 'system' }). فيعرض المحرر عندئذ الوضع الفاتح أو الداكن الذي يُبلغ عنه نظام التشغيل، أو الذي يحدده setSystemAppearance، ويتبدل عندما يتغير ذلك.
وأي استدعاء لاحق للدالة setPresetTheme بالقيمة 'light' أو 'dark'، أو اختيار Light أو Dark في منشئ النسق أو البحث السريع، يحل محل 'system' ويبقى: فلا يعود التغيير التالي في نظام التشغيل يستبدله، رغم أن systemDarkMode لا يزال true. قبل الإصدار 4.0.0 كان التغيير التالي في نظام التشغيل يستبدله.
وتعطيله والمظهر 'system' يُبقي على الوضع الفاتح أو الداكن المعروض في تلك اللحظة. أما تعطيله بعد تغيير المظهر عن 'system' فيتركه كما هو.
ولا يُطلِق تغييره أي حدث.

editor.systemDarkMode = true;
// or
editor.setAttribute('system-dark-mode', 'true');

<erd-editor system-dark-mode></erd-editor>

enableThemeBuilder

يحدد ما إذا كان المحرر يوفر واجهة لضبط الأنساق المعدّة مسبقًا بسهولة.
يُظهر الزر Theme في شريط الأدوات، الذي يفتح منشئ النسق بخيارات Accent color وGray color وAppearance. منذ الإصدار 4.0.0، يقدّم Appearance الخيار System إلى جانب Light وDark، وما دام مفعّلًا، يعرض البحث السريع Theme مع System وLight وDark. راجع اللغة والنسق.

editor.enableThemeBuilder = true;
// or
editor.setAttribute('enable-theme-builder', 'true');

<erd-editor enable-theme-builder></erd-editor>

يُطلِق تغيير النسق المعدّ مسبقًا من هذه اللوحة، أو من البحث السريع، الحدث changePresetTheme.

enableLocalePicker

منذ الإصدار 4.0.0، يحدد ما إذا كان المحرر يوفر واجهة لاختيار لغة العرض فيه.
يُظهر الزر Display Language في شريط الأدوات، بعد Theme عند ظهور الاثنين. يفتح الزر منتقي لغة العرض، ويعرض البحث السريع Display Language. ويقدّم كلاهما System و25 لغة، راجع اللغة والنسق.
ويحدد أيضًا ما يعرضه المحرر قبل استدعاء setLocale أو اختيار لغة: 'system' ما دام مفعّلًا، والإنجليزية ما دام معطّلًا، لذا يحتفظ العنصر الذي لا يضبط شيئًا بالإنجليزية التي عرضها دائمًا. ويؤدي تفعيله أو تعطيله إلى التبديل بين الاثنين فورًا. وبمجرد ضبط لغة أو اختيارها، يبقى ذلك الاختيار أيًّا كانت حالة التفعيل.
اضبطه قبل إلحاق العنصر بالصفحة كي يتبع الإطار الأول 'system'.
ويُطلِق الاختيار changeLocale.

editor.enableLocalePicker = true;
// or
editor.setAttribute('enable-locale-picker', 'true');

<erd-editor enable-locale-picker></erd-editor>

enableWelcomeScreen

منذ الإصدار 4.0.0، يحدد ما إذا كان المخطط الفارغ يرحّب بالقارئ عبر شاشة الترحيب.
تظهر فوق علامة تبويب ERD ما دام المستند لا يحتوي على أي جدول ولا ملاحظة معروضة ولا مجموعة جداول معروضة. ولا تظهر أثناء ضبط readonly، أو في وضع الزن، أو أثناء فتح خصائص الجدول أو عارض الفروق أو السفر عبر الزمن أو معاينة التخطيط التلقائي. وأول جدول أو ملاحظة معروضة أو مجموعة جداول معروضة يُخفيها، والتراجع إلى مخطط فارغ يعيدها.
تعرض عناصرها New Table وNew Memo وCommand Palette أول تركيبة مفاتيح من اختصارات addTable وaddMemo وsearch كما تركها setKeyBindingMap، ولا تعرض شيئًا لاسم تُرك فارغًا. وتشير أسهمها إلى الزرين Theme وDisplay Language فقط حيث يُظهرهما enableThemeBuilder وenableLocalePicker.
في قائمتها، يتنقل ↑ و↓ وHome وEnd بين العناصر، ويُمنع سلوكها الافتراضي ويُوقف انتشارها. أما Enter وSpace فيُوقف انتشارهما دون منع سلوكهما الافتراضي، فيتلقاهما العنصر الذي عليه التركيز، وEscape بين تنسيقات Import يعود إلى الخلف، مع منع سلوكه الافتراضي وإيقاف انتشاره. ويصل كل مفتاح آخر إلى المحرر والصفحة كالمعتاد.
ولا تغيّر شيئًا في المستند، لذا تترك value كما كان ولا تُطلِق أي change.
فعّله بعد أن يحمّل setInitialValue المستند، كما تفعل التطبيقات المضيفة الرسمية، حتى لا تومض الشاشة أبدًا فوق ملف لا يزال قيد التحميل.

editor.enableWelcomeScreen = true;
// or
editor.setAttribute('enable-welcome-screen', 'true');

<erd-editor enable-welcome-screen></erd-editor>

value

getter

يسترجع المستند الحالي كسلسلة نصية بصيغة JSON، وفق المخطط الذي يحدده المحرر.
منذ الإصدار 4.0.0، يمثل صيغة التخزين، أي المستند كما يحفظه الملف، وهو أيضًا ما يكتبه تصدير json وما تحفظه التطبيقات المضيفة الرسمية. ويحتوي على الكيانات القائمة وحدها، دون الكيانات المُزالة أو ترتيب التراص أو ما يستنتجه المحرر بنفسه، مثل العروض المقيسة وعلامات المفاتيح ونقاط ارتكاز العلاقات. وتُرتَّب مفاتيح كياناته وفق ترتيب ثابت، وتُزاح أسطره بمسافتين، وينتهي بسطر جديد، لذا يعطي المستند نفسه دائمًا البايتات نفسها.
منذ الإصدار 4.2.0، يستبعد أيضًا ما هو فارغ: قائمة doc الفارغة، ومجموعة الكيانات الفارغة، وصف القاموس الذي لا يحمل شيئًا، وحقل النص الفارغ في الكيان، مثل الاسم أو التعليق أو نوع البيانات أو القيمة الافتراضية أو اللون. أما القائمة داخل الكيان، مثل columnIds في الجدول، فتُكتب حتى لو كانت فارغة. ويكون doc في المستند الجديد {}، ولا يحتوي المستند على collections، لذا اقرأ الحقل أو القائمة أو مجموعة الكيانات المفقودة على أنها فارغة. ويحمل الأسماء المنطقية للجداول والأعمدة وعلامات الأسماء المشتقة فيها، وروابط الأعمدة بالمجالات، والكلمات والمصطلحات والمجالات، ويُكتب كل قاموس كسطر عناوين واحد من أسماء الحقول تليه صفوفه، صف واحد في كل سطر، بترتيب الورقة. راجع صيغة التخزين.
كل إعداد يكون القفل الخاص به مفعّلًا يُكتب بقيمته المقفلة، لا كما تعرضه الشاشة. يشمل قفل Viewport القيم originX وoriginY وzoomLevel، ويحمل كل من Canvas Type وLanguage وTable Name Case وColumn Name Case وBracket Type، ومنذ الإصدار 4.2.0 Name View، إعداده الخاص. ويُكتب عرض الأسماء باسم nameViewMode، وفقط ما دام لا يساوي 'physical'. ويُكتب كل إعداد آخر كما هو، ويُكتب lockSettings دائمًا. لمعرفة البتات، راجع Settings؛ وتُقرأ بتة القفل Name View بالعكس.
ومنذ الإصدار 5.0.0 تُكتب أيضًا الإعدادات التي يغيّرها قارئ محرر للقراءة فقط بقيم المستند، مقفلة كانت أم لا، إذ تبقى على تلك الشاشة.
في المستند الجديد تكون كل الأقفال مفعّلة، سواء أكان المستند الذي يعرضه العنصر قبل إعطائه قيمة أم مستندًا محمّلًا من قيمة فارغة. ويحتفظ value الخاص به بنقطة الأصل عند 0, 0، ومستوى التكبير عند 1، وعلامة تبويب ERD، ولغة منشئ التعليمات البرمجية وأنماط التسمية ونوع علامات الاقتباس الافتراضية، ومنذ الإصدار 4.2.0 العرض Physical Names، إلى أن يُعطَّل القفل المقابل.
قبل الإصدار 4.0.0، كان يُرجع المستند كاملًا كما يحتفظ به المحرر، مع تطبيق ignoreSaveSettings. أما المستند كما يحتفظ به المحرر فهو الآن runtimeValue، ولم يعد ignoreSaveSettings يُقرأ أو يُكتب.

const data = editor.value;

setter

يحمّل حالة محرر محفوظة سابقًا. ويستبدل المستند كاملًا — إذ يُمسح المستند الحالي أولًا. ومنذ الإصدار 4.2.0 يشمل ذلك الكلمات والمصطلحات والمجالات: إذ يأخذ المستند ما يحمله النص منها، أو لا شيء، ويُفرَّغ سجل التراجع الخاص بكل ورقة من أوراق القاموس.
ومثل clear() وsetInitialValue() ودوال setSchema* في وضعها الافتراضي mode: 'replace'، يتخلص أيضًا من عرض التدفق في علامة تبويب التصور المرئي: تخطيطه، والجداول التي يقتصر عليها، وعرض الصفوف فيه، ومستوى تكبيره، وموضع تحريكه، ومنذ الإصدار 4.2.0 الجداول التي يتنقل بينها Previous table وNext table فيه. أما الإلحاق (mode: 'append') فلا يتخلص منه.
ومنذ الإصدار 5.1.0، ينهي رسم علاقة قيد الرسم، سواء كان نوعها فقط هو المجهّز أو كان جدولها الأصل قد اختير بالفعل. وكذلك يفعل clear() ودوال setSchema* في mode: 'replace' وImport في المحرر نفسه، والتراجع عن أي منها أو إعادته باستثناء التراجع عن clear()، وكل منها عند استلامه عبر مخزن مشترك، من متعاون أو من وكيل برمجة. وقبل الإصدار 5.1.0 كان الرسم يبقى مجهّزًا عبر التحميل، وحين كان النص المحمَّل، مثل قيمة وقت التشغيل التي يحملها التراجع، يضم الجدول الذي بدأ منه الرسم بوصفه كيانًا مُزالًا، كان بإمكان ضغطة أن تضيف علاقة من ذلك الجدول المُزال. ويترك الإلحاق الرسم مجهّزًا.
وكما كان من قبل، يبقى محرر الملاحظة أو اسم مجموعة الجداول أو الخلية مفتوحًا ما دام المستند المحمَّل لا يزال يحتوي على ما يحرره ويعرضه، ويُغلق في غير ذلك؛ وما يُكتب في محرر ظل مفتوحًا يستمر في المستند المحمَّل. ومنذ الإصدار 5.1.0، يترك المحرر الذي يغلقه أي تحميل لوحة المفاتيح للصفحة بدلًا من إعادتها إلى المحرر، فلا يزيل Delete أو Backspace المقصود به النص المغلق شيئًا من التحديد. وخلية الاسم المنطقي التي تُترك مفتوحة عبر تحميل كهذا لا تشتق الاسم المادي عند إغلاقها إلا من اسم منطقي كتبه المستخدم، ولا تشتقه أبدًا، منذ الإصدار 5.1.0، من اسم جاء به التحميل.
ويُسجَّل في قائمة السجل، ما يتيح Undo, Redo، ويُطلِق change.
ويقبل صيغة التخزين، أو قيمة runtimeValue، أو ملفًا حفظه إصدار سابق.
والسلسلة النصية الفارغة، أو أي شيء ليس سلسلة نصية، يحمّل مستندًا جديدًا بدلًا من رمي خطأ، لذا تحقق من القيمة قبل إسنادها.
وهذا المستند الجديد هو نفسه الذي يبدأ به setInitialValue(''): فارغ، بالإعدادات الافتراضية، ومنذ الإصدار 4.0.0 بكل الأقفال مفعّلة. في الإصدار 3.10.x لم يكن يحفظ موضع التمرير ولا مستوى التكبير، وقبل ذلك كان يحفظ كليهما.
ويمرر المخزن المشترك عملية التحميل هذه إلى المتعاونين مع نص JSON الكامل للمستند الجديد، لذا يحمّله كل نظير، بما في ذلك النظير الذي يعمل بإصدار أقدم، وإن كان المحرر السابق للإصدار 4.2.0 يُسقط ما لا يعرفه، مثل الأسماء المنطقية وروابط المجالات والقواميس، راجع الجمع بين إصدارات مختلفة.
منذ الإصدار 4.0.0، تأتي أقفال المستند المحمّل، والقيم المقفلة التي يكتبها value بعد ذلك، من النص، ويستقر العرض حيث يضعه النص، أو على المخطط إذا لم يُرسم أي جزء منه هناك. ولكل إعداد آخر يقفله النص — علامة التبويب ولغة منشئ التعليمات البرمجية وأنماط التسمية ونوع علامات الاقتباس، ومنذ الإصدار 4.2.0 عرض الأسماء — يواصل المحرر عرض ما كان يعرضه قبل التحميل. والإعداد الذي يتركه النص غير مقفل يأخذ قيمته من النص. والملف المحفوظ قبل الإصدار 4.2.0 لا يذكر القفل Name View ما لم يكن محرر بالإصدار 4.2.0 قد عطّل ذلك القفل فيه، لذا يُحمَّل وعرض الأسماء مقفل عند Physical Names، ويحتفظ المحرر بعرض الأسماء الذي كان يعرضه. أما setInitialValue فيأخذ كل قيمة يحملها النص؛ وراجعه أيضًا لمعرفة حالة النص الذي لا يذكر أي أقفال.
والنص الذي ليس JSON، مثل ملف بقيت فيه علامات تعارض الدمج، لا يرمي خطأً أيضًا: إذ يُفرَّغ المستند، وتبقى إعداداته كما كانت، ويُسجَّل خطأ التحليل في وحدة التحكم.
ويُتجاهل أثناء ضبط readonly؛ استخدم setInitialValue للتحميل في محرر للقراءة فقط.

editor.value = 'json...';

runtimeValue

منذ الإصدار 4.0.0، يسترجع المستند كما يحتفظ به هذا المحرر، كسلسلة نصية بصيغة JSON. ليس له setter، لذا يرمي إسناد قيمة إليه خطأً في التعليمات البرمجية العاملة في الوضع الصارم.
ويحمل ما يستبعده value: الكيانات المُزالة وترتيبها، وترتيب التراص، والعروض المقيسة، وعلامات المفاتيح، وعلامات كل علاقة (هل هي مُعرِّفة، وكيف يُرسم طرف الجدول الأصل) ونقاط ارتكازها، والتسلسلات.
ومنذ الإصدار 4.2.0 يحتفظ أيضًا بالأشياء الفارغة التي يستبعدها value: النص الفارغ في الكيان، مثل الاسم أو التعليق أو نوع البيانات أو القيمة الافتراضية أو اللون أو نص الملاحظة؛ وقوائم doc وهي tableIds وrelationshipIds وindexIds وmemoIds ومجموعات الكيانات من tableEntities إلى memoEntities، وتُكتب حتى وهي فارغة؛ وقائمة مجموعات الجداول ومجموعة كياناتها ما دام المستند يحتوي على مجموعة أو على مجموعة مُزالة؛ وكل قاموس مع قائمة doc الخاصة به ما دام أيٌّ منهما يحتوي على عنصر. ويحتفظ باسم منطقي لا يحوي إلا مسافات، وبالربط بمجال مُزال، وبالصفوف المُزالة من ورقة القاموس وبالصفوف التي لا تحمل شيئًا. وكما في value، يُستبعد الاسم المنطقي أو الربط بمجال أو مجموعة الجدول إذا كان ''، وعلامة الاسم المشتق في الجدول إذا كانت معطّلة.
كل قاموس سطر عناوين وصفوف، كما في الملف، لكن سطر عناوينه يذكر "order"، وهو مفتاح الترتيب لكل صف، بعد "name" مباشرة، وتقف صفوفه بالترتيب الذي يحتفظ به المحرر، بما فيها الصفوف المُزالة، لا بترتيب الورقة. وللحصول على ترتيب الورقة، خذ الصفوف التي تذكرها قائمة doc الخاصة به ورتّبها بحسب order مقارنةً بترتيب وحدات الترميز، وما يشترك منها في المفتاح بحسب id.
وتُكتب إعداداته كما يكتبها value، وكل إعداد مقفل بقيمته المقفلة. ويُزاح بمسافتين، وكل صف من صفوف القاموس في سطر خاص به، وعلى عكس value لا ينتهي بسطر جديد.
استخدمه لتهيئة محرر آخر ينضم إلى جلسة جارية بالفعل، مثل محرر متعاون أو عرض ثانٍ للمستند نفسه، عبر setInitialValue الخاص به. وعندئذ يستعيد التراجع عن إزالة، ترسله الجلسة لاحقًا، الكيانَ كاملًا هناك، في حين أن المحرر المُهيّأ من value لا يحمل أي كيان مُزال، فيستعيد بدلًا من ذلك جدولًا فارغًا بلا اسم، أو منذ الإصدار 4.2.0 صفًا فارغًا في القاموس. راجع التحرير التعاوني.
لم يعد هناك ما يجمع الكيانات المُزالة، لذا تبقى فيه إلى أن يُفتح المستند من ملفه في المرة التالية.
لا تكتبه في ملف أبدًا: احفظ value، الذي يقبله JSON Schema ولا يقبل هذا.

otherEditor.setInitialValue(editor.runtimeValue);

setInitialValue

يحمّل حالة محرر محفوظة سابقًا. لا يُسجَّل التحميل نفسه في قائمة السجل، لذا لا يمكن التراجع عنه، ولا يُطلَق الحدث change.
ويمسح أيضًا سجل التراجع، فلا يمكن التراجع عن أي شيء جرى قبل التحميل أو إعادته على المستند المحمّل، ومنذ الإصدار 4.2.0 يمسح أيضًا السجل الخاص بكل ورقة من أوراق القاموس.
ويقبل صيغة التخزين، أو قيمة runtimeValue، أو ملفًا حفظه إصدار سابق، وعلى عكس إسناد قيمة إلى value، يأخذ كل إعداد يحمله النص، بما في ذلك علامة التبويب وإعدادات التعليمات البرمجية.
والسلسلة النصية الفارغة، أو أي شيء ليس سلسلة نصية، يحمّل مستندًا جديدًا بدلًا من رمي خطأ، لذا يبدأ setInitialValue('') مخططًا فارغًا.
منذ الإصدار 4.0.0، تكون كل الأقفال مفعّلة في هذا المستند الجديد، وهو أيضًا ما يعرضه العنصر قبل إعطائه أي قيمة. والتمرير والتكبير والتصغير وتبديل علامات التبويب وتغيير لغة منشئ التعليمات البرمجية أو أنماط التسمية أو نوع علامات الاقتباس، أو منذ الإصدار 4.2.0 عرض الأسماء، كلها تترك value كما كان ولا تُطلِق أي change. في الإصدار 3.10.x لم يكن يحفظ موضع التمرير ولا مستوى التكبير، وقبل ذلك كان يحفظ كليهما.
يحتفظ المستند المحمّل من نص بالأقفال التي يذكرها. أما المستند الذي لا يذكر أيًّا منها — أي ملف حُفظ قبل الإصدار 4.0.0، أيًّا كانت قيمة ignoreSaveSettings فيه، وملف .vuerd بصيغة v2 — فيُفتح بكل الأقفال مفعّلة، وViewport مقفل عند نقطة الأصل 0, 0 ومستوى التكبير 1، في علامة تبويب ERD، مع لغته وأنماط التسمية ونوع علامات الاقتباس كما حفظها.
منذ الإصدار 4.2.0، يُفتح النص الذي يذكر أقفاله دون القفل Name View وذلك القفل مفعّل أيضًا، حتى عندما تكون كل الأقفال الأخرى معطّلة. والملف المحفوظ قبل الإصدار 4.2.0 نص من هذا النوع ما لم يكن محرر بالإصدار 4.2.0 قد عطّل ذلك القفل فيه (راجع Settings). ويُفتح في العرض Physical Names، كما يُفتح النص الذي لا يذكر أي قفل على الإطلاق.
وفي الحالتين يُفتح العرض عند عرض المستند — الذي حفظه النص إذا كان يذكر أقفاله، أو نقطة الأصل 0, 0 عند مستوى التكبير 1 إذا لم يذكر أيًّا منها — أو على المخطط إذا لم يُرسم أي جزء منه هناك. ويظل Viewport المقفل محتفظًا بقيمه المقفلة في value.
منذ الإصدار 4.0.0، يتخلص أيضًا من حالة التعاون الخاصة بالمستند الذي كان محمّلًا من قبل، ويطلب المخزن المشترك لهذا المحرر، إذا كان قد اشترك بالفعل، من المحررات الأخرى حالتها من جديد، فيلحق المحرر المُعاد تحميله في جلسة جارية بما فاته. هيّئ مثل هذا المحرر بقيمة runtimeValue من محرر آخر.
ومنذ الإصدار 5.1.0، يمكن أن تأتي مسجّلات التعاون مع التهيئة بدلًا من ذلك، وهو ما تحتاج إليه لقطة مخزنة حين لا يوجد محرر جارٍ يجيب.
بعد هذا الاستدعاء، لا قبله أبدًا، مرّر getLWW() وgetVersion() من مخزن آخر إلى mergeLWW في المخزن المشترك لهذا المحرر. أو حمّل عبر reseed في ذلك المخزن، الذي يحمّل ويأخذها في استدعاء واحد ويتخلص أيضًا من التحديد والتركيز. راجع تهيئة متعاون.
والنص الذي ليس JSON لا يرمي خطأً أيضًا: إذ يُفرَّغ المستند، وتبقى إعداداته كما كانت، ويُسجَّل خطأ التحليل في وحدة التحكم.
وعلى عكس إسناد قيمة إلى value، لا يمنعه readonly، لذا فهو الطريقة لتحميل مستند في محرر للقراءة فقط. ثم يعرض المحرر للقراءة فقط الإعدادات التي يحملها النص المحمّل، ويُسقط ما كان قارئه قد غيّره على الشاشة.

ومنذ الإصدار 5.1.0، ينهي رسم علاقة قيد الرسم ويغلق محرر الملاحظة أو اسم مجموعة الجداول أو الخلية إن كان مفتوحًا، حتى حين يحتوي المستند المحمَّل على ما يحرره ذلك المحرر. وقبل الإصدار 5.1.0 كان الرسم يبقى مجهّزًا، وكان كل محرر يبقى مفتوحًا ما دام المستند المحمَّل لا يزال يحتوي على ملاحظته أو مجموعته أو جدوله وعموده.
ولا يكتب إغلاقها شيئًا ولا يرسل شيئًا: فنص الملاحظة وقيمة الخلية كُتبا أصلًا أثناء كتابتهما في المستند الذي كان محمّلًا من قبل، بينما يُتخلَّص من بحث خلية المجال، الذي لا يكتب شيئًا حتى يُختار مجال، ومن اسم مجموعة الجداول الذي كُتب ولم يُدخَل بعد.
والاستثناء الوحيد هو خلية الاسم المنطقي التي كتب فيها المستخدم: فإذا كان المستند المحمَّل يحتوي على آخر اسم منطقي كُتب فيها، يشتق الإغلاق الاسم المادي منه، كما يفعل أي إغلاق لتلك الخلية. وهذا الاشتقاق تعديل كأي تعديل آخر، لذا يرسله المخزن المشترك، ويُنشئ إدخالًا في سجل التراجع، ويُطلِق change.
ويبقى التحديد والخلية التي عليها التركيز، وتُترك لوحة المفاتيح للصفحة، كما يصف setter لأي تحميل. ويغلق reseed في المخزن المشترك الأشياء نفسها.

editor.setInitialValue('json...');

حمّل عند البدء، واحفظ عند التغيير.

editor.setInitialValue(localStorage.getItem('my-diagram') ?? '');
editor.addEventListener('change', () => {
  localStorage.setItem('my-diagram', editor.value);
});

الأحداث

الأحداث العامة الوحيدة ثلاثة: change وchangePresetTheme وchangeLocale؛ والحدث changeLocale جديد في الإصدار 4.0.0.
ويُرسل العنصر أيضًا أحداثًا داخلية @dineug/erd-editor/internal-* على نفسه لتوصيلاته الداخلية؛ وهذه ليست جزءًا من واجهة برمجة التطبيقات.

change

عند حدوث تغييرات في المحرر، يُطلِق حدثًا.
يُؤخَّر إطلاق الحدث بمقدار 200 مللي ثانية، ولا يُطلَق ما دام readonly يساوي true.
يُطلَق عند أي تغيير في المستند — تعديل في الواجهة، أو إسناد قيمة إلى value، أو clear()، أو أي من دوال setSchema*، ومنذ الإصدار 4.0.0 أيضًا setSchemaJSON() وImport and Add. ولا يُطلِقه setInitialValue، ومنذ الإصدار 5.1.0 لا يُطلِقه كذلك reseed في المخزن المشترك، باستثناء الاسم المادي الذي يشتقه أي منهما عند إغلاق خلية اسم منطقي كتب فيها المستخدم (راجع setInitialValue).
منذ الإصدار 4.2.0، يشمل ذلك كل تعديل في علامة تبويب القاموس وكل تراجع عنه أو إعادة له، وتغيير الاسم المنطقي أو الربط بمجال، وDerive Physical Names Again، وتبديل عرض الأسماء ما دام القفل Name View معطّلًا.
ولا يُطلِقه أي شيء يجري داخل وضع التدفق في علامة تبويب التصور المرئي — التكبير والتصغير، وتحريك العرض، ونقل البطاقات، وTidy Up، وعرض الصفوف، وتضييق العرض من بطاقة، أو منذ الإصدار 4.2.0 التنقل خطوةً خطوة باستخدام Previous table وNext table أو مفاتيح التراجع والإعادة — لأن أيًّا من ذلك ليس تغييرًا في المستند. والاستثناء هو القائمة Name View فيه: إذ يُطلِقه التبديل منها ما دام القفل Name View معطّلًا، كما يفعل التبديل في علامة تبويب ERD.
منذ الإصدار 4.0.0، لا يُطلِقه أيضًا تغيير إعداد يكون القفل الخاص به مفعّلًا، لأنه لا يحرك سوى الشاشة ولا يمس value أبدًا: التمرير أو التكبير والتصغير في لوحة رسم ERD أثناء قفل Viewport، وتبديل علامة التبويب أثناء قفل Canvas Type، وتغيير لغة منشئ التعليمات البرمجية أو نمط تسمية الجداول أو نمط تسمية الأعمدة أو نوع علامات الاقتباس أثناء تفعيل القفل الخاص به، ومنذ الإصدار 4.2.0 تبديل عرض الأسماء أثناء قفل Name View. تُستبعد هذه التغييرات وحدها، لذا فإن الدفعة التي تعدّل المستند أيضًا لا تزال تُطلِقه. ويُطلِقه قفل الإعداد أو إلغاء قفله.
تكون كل الأقفال مفعّلة في المستند الجديد وفي أي ملف حُفظ قبل الإصدار 4.0.0، ويكون القفل Name View مفعّلًا في أي ملف حُفظ قبل الإصدار 4.2.0 ما لم يكن محرر بالإصدار 4.2.0 قد عطّله فيه، لذا لا يُطلِق التمرير والتكبير والتصغير وتبديل علامات التبويب وتبديل عرض الأسماء شيئًا افتراضيًا. ويشمل ذلك التركيز على الجداول من علامة تبويب ERD، وزر البطاقة للرابط الخارجي الذي يعيدك من التدفق إلى علامة تبويب ERD، والانتقال إلى صف في المستكشف أو إلى تطابق في البحث، وفتح المستكشف أو الانتقال إلى نتيجة في البحث السريع من علامة تبويب أخرى، ومنذ الإصدار 4.2.0 الانتقال إلى جدول أو عمود من صف في الورقة Checks في علامة تبويب القاموس. ولا يُطلِق كل منها change واحدًا إلا أثناء تعطيل القفل الذي يشمله: Canvas Type لتبديل علامة التبويب، وViewport للتمرير الذي يُحدثه أيضًا زر البطاقة أو نتيجة البحث السريع أو صف المستكشف أو تطابق البحث أو صف Checks. منذ الإصدار 4.1.0، تتبع كل عمليات التمرير هذه قاعدة واحدة، أين يستقر الانتقال، لذا لم تعد نتيجة جدول في البحث السريع تُمرِّر العرض في كل مرة، والانتقال الذي تتركه القاعدة في مكانه لا يُحدث تمريرًا يستدعي إطلاق الحدث. وفتح المستكشف أو إغلاقه أو تغيير حجمه يضيّق لوحة الرسم أو يوسّعها دون تحريك نقطة أصلها، ولا يُطلِق شيئًا أيضًا. قبل الإصدار 4.0.0، كانت عمليات التمرير والتكبير والتصغير وتبديل علامات التبويب تُطلِقه دائمًا، حتى عندما كان editor.value يخرج بالقيمة نفسها.
لتخطي عمليات الكتابة التي لا تغيّر شيئًا، قارن editor.value بالقيمة التي خزّنتها آخر مرة، لا بالملف الذي حمّلته: فالملف الذي كتبه إصدار سابق، أو ملف v2، أو ملف عُدِّل يدويًا، قد يخرج مختلفًا في value فور تحميله، لأن value يكتبه بصيغة التخزين. وكذلك الملف الذي يكون قفل Viewport فيه معطّلًا ولا تُظهر نقطة أصله أي جزء من المخطط على هذه الشاشة: إذ ينقل التحميل العرض إلى المخطط، ويكتب value الموضع الذي يستقر فيه. منذ الإصدار 4.0.0، لم تعد العروض المقيسة تسبب ذلك، لأن value لا يحمل أيًّا منها. ومنذ الإصدار 4.2.0، قد يخرج مختلفًا أيضًا الملف الذي حفظه الإصدار 4.0.0 أو 4.1.0، لأن value أصبح يستبعد حقول النص والقوائم ومجموعات الكيانات الفارغة فيه، لذا تُعاد كتابة مثل هذا الملف مرة واحدة، عند حفظه التالي. ويمكن للتطبيق المضيف الذي يكتب الملفات أن يميّز بدلًا من ذلك بين التعديل وتغيير العرض باستخدام changed في مخزن النسخ المتماثل، راجع on@change.
لا يحمل الحدث أي detail، ولا ينتشر صعودًا ولا يعبر حدود shadow root، لذا استمع إليه على العنصر نفسه واقرأ editor.value في دالة المعالجة.

editor.addEventListener('change', event => {
  const data = event.target.value;
});

changePresetTheme

يُطلَق عند تغيير النسق المعدّ مسبقًا من منشئ النسق المدمج، أو منذ الإصدار 4.0.0 من Theme في البحث السريع. ويُطلِقه كل اختيار، بما في ذلك اختيار الخيار المطبَّق حاليًا.
ولا يُطلِقه استدعاؤك setPresetTheme أو setSystemAppearance بنفسك، ولا تفعيل systemDarkMode أو تعطيله.
قيمة event.detail هي كائن ThemeOptions الكامل بعد الاختيار — { appearance, grayColor, accentColor } — لا القيم الجزئية التي طُلبت. منذ الإصدار 4.0.0، تكون قيمة appearance فيه 'system' ما دام System مختارًا، لا الوضع الفاتح أو الداكن الذي يعرضه، لذا خزّنه كما هو وأعده إلى setPresetTheme.

editor.addEventListener('changePresetTheme', event => {
  const themeOptions = event.detail;
});

changeLocale

منذ الإصدار 4.0.0، يُطلَق عند اختيار لغة في المحرر، من منتقي لغة العرض أو من Display Language في البحث السريع، وكلاهما يفعّله enableLocalePicker.
يُطلَق بعد تطبيق اللغة، عند كل اختيار، بما في ذلك اختيار الخيار المطبَّق حاليًا. لا يُطلِقه setLocale ولا setSystemLocale أبدًا، ولا تغيير لغات المتصفح. ولا يُطلِق تبديل اللغة أي change.
قيمة event.detail هي { locale }، وهي من النوع LocaleOption: 'system' عند اختيار System، وإلا فرمز اللغة. لا يتذكر العنصر الاختيار، لذا خزّنه ومرّره إلى setLocale في التحميل التالي.
ومثل change، لا ينتشر صعودًا، لذا استمع إليه على العنصر نفسه.

editor.addEventListener('changeLocale', event => {
  const { locale } = event.detail; // 'system' | 'ko-KR' | ...
});

focus

ينقل التركيز إلى المحرر.

editor.focus();

blur

يزيل التركيز عن المحرر.

editor.blur();

clear

يُفرّغ المستند، فيزيل كل جدول وعمود وعلاقة وفهرس وملاحظة، ومنذ الإصدار 4.0.0 كل مجموعة جداول، ومنذ الإصدار 4.2.0 كلمات علامة تبويب القاموس ومصطلحاتها ومجالاتها، مُفرِّغًا أيضًا سجل التراجع الخاص بكل ورقة.
ويبقى كل إعداد، بما في ذلك قاعدة البيانات وموضع العرض ومستوى التكبير وخيارات عرض الجداول وكل قفل مع القيمة التي يحملها، والسكربتان Before tables وAfter tables في علامة تبويب مخطط SQL، لذا يواصل الملف المُفرَّغ حفظ ما كان يحفظه. ولبدء مستند جديد بدلًا من ذلك، أسند '' إلى value أو استدعِ setInitialValue('').
ويُسجَّل في قائمة السجل، لذا يمكن التراجع عنه، ويُطلِق change. ويعيد التراجع المستند كما كان المحرر يحتفظ به، بما في ذلك كلماته ومصطلحاته ومجالاته، وكل إعداد مقفل بقيمته المقفلة. ويُتجاهل أثناء ضبط readonly.
ومنذ الإصدار 5.1.0، ينهي رسم علاقة قيد الرسم، كما يصف setter الخاص بـ value، وكذلك تفعل إعادته؛ أما التراجع عنه فلا.
وكما كان من قبل، يُغلق محرر الملاحظة أو اسم مجموعة الجداول أو الخلية المفتوح، لأن المستند الفارغ لا يحتوي على ما يُحرَّر. ومنذ الإصدار 5.1.0، يترك المحرر المغلق لوحة المفاتيح للصفحة، كما بعد التحميل.

editor.clear();

destroy

يدمّر مثيل المحرر تمامًا فلا يمكن إعادة استخدامه بعد ذلك.
ويحرّر مستمعي الأحداث والاشتراكات الخاصة بالمحرر، ويدمّر كل مخزن مشترك أرجعه getSharedStore.
وتُسقَط معه أي دفعة دفق لا يزال المخزن المشترك يحتجزها؛ استدعِ flushStreamBuffers لذلك المخزن أولًا لإرسالها.

editor.destroy();

setKeyBindingMap

يعيد تعريف اختصارات لوحة المفاتيح.
الأسماء edit وstop وundo وredo وzoomIn وzoomOut وzoomReset ثابتة ولا يمكن إعادة تعريفها.
لا تُكتب إلا الأسماء أدناه، وعددها 21 اسمًا؛ ويُتجاهل أي شيء آخر في الكائن، بما في ذلك الأسماء الثابتة.
منذ الإصدار 3.10.0، يمكن إعادة تعريف search، وأُضيف findReplace. وقبل ذلك كان search ثابتًا. أُضيف removeSelection في الإصدار 4.0.0. أُضيف addTableGroup وgroupSelectedTables في الإصدار 4.1.0.
يجب أن تكون قيمة الاختصار من النوع ShortcutOption[]. وتُتجاهل السلسلة النصية المجردة، لذا اكتب { addTable: [{ shortcut: 'Alt+KeyN' }] } بدلًا من { addTable: 'Alt+KeyN' }.
تُقبل المصفوفة الفارغة ولا تربط أي مفتاح: يترك setKeyBindingMap({ findReplace: [] }) الاختصار Ctrl + F (Windows/Linux) أو ⌘ + F (Mac) للصفحة، ويفعل { search: [] } الشيء نفسه مع Ctrl + K (Windows/Linux) أو ⌘ + K (Mac). ولا يزال الزر Search في شريط الأدوات يفتح البحث السريع، والزر Explorer في شريط الأدوات يفتح المستكشف ويغلقه، وToggle Explorer في البحث السريع وفي قائمة السياق للوحة الرسم يفتح بحث المستكشف أو يغلقه؛ ولا يعرض أي منها اختصارًا لاسم تُرك فارغًا. ويترك { removeSelection: [] } المفتاحين Delete وBackspace للصفحة، وعندئذ لا تعرض عناصر الحذف في قوائم الجدول والملاحظة ومجموعة الجداول (Delete وDelete selected وDelete column وDelete columns) أي اختصار.
منذ الإصدار 4.1.0، يترك { addTableGroup: [] } الاختصار Alt + G (Windows/Linux) أو ⌥ + G (Mac) للصفحة، ويترك { groupSelectedTables: [] } التسلسل T ثم G. ويظل كل من New Table Group في شريط أدوات لوحة الرسم وفي قائمة السياق للوحة الرسم وفي البحث السريع، وGroup selected tables في قائمة الجدول، وGroup Selected Tables في البحث السريع يعمل، دون عرض أي اختصار. وتذكر تلميحات الأزرار New Table وNew Memo وNew Table Group في شريط أدوات لوحة الرسم أول تركيبة مفاتيح من addTable وaddMemo وaddTableGroup، أو اسم الزر وحده إذا تُرك الاختصار فارغًا.
منذ الإصدار 4.2.0، يمنح addColumn وremoveColumn أيضًا شبكة علامة تبويب القاموس تركيبات مفاتيح الصفوف، كما هو موضّح أدناه، لذا فإن إعادة ربط أي منهما تنقل تلك التركيبات معه. ولا يترك { addColumn: [] } للشبكة أي تركيبة لإدراج الصفوف، وعندئذ لا يعرض عنصرا الإدراج في قائمة الشبكة أي اختصار؛ ولا يترك لها { removeColumn: [] } أي تركيبة لحذفها، وعندئذ لا يعرض عنصر الحذف في القائمة ولا تلميح الزر Delete Rows أي اختصار.
الاستدعاء دمج جزئي: تحتفظ الأسماء التي لا تذكرها بقيمها الافتراضية، واستدعاؤه مرتين يُبقي على التغييرات السابقة. لا يوجد getter للاختصارات الحالية: يُرجع createKeyBindingMap القيم الافتراضية، لا ما غيّره setKeyBindingMap.

type ShortcutOption = {
  shortcut: string;
  preventDefault?: boolean;
  stopPropagation?: boolean;
};

const defaultKeyBindingMap: Omit<
  KeyBindingMap,
  | 'edit'
  | 'stop'
  | 'undo'
  | 'redo'
  | 'zoomIn'
  | 'zoomOut'
  | 'zoomReset'
> = {
  search: [
    { shortcut: '$mod+KeyK', preventDefault: true, stopPropagation: true },
  ],
  findReplace: [
    { shortcut: '$mod+KeyF', preventDefault: true, stopPropagation: true },
  ],
  addTable: [{ shortcut: 'Alt+KeyN', preventDefault: true }],
  addColumn: [{ shortcut: 'Alt+Enter', preventDefault: true }],
  addMemo: [{ shortcut: 'Alt+KeyM', preventDefault: true }],
  addTableGroup: [
    { shortcut: 'Alt+KeyG', preventDefault: true, stopPropagation: true },
  ],
  groupSelectedTables: [{ shortcut: 'KeyT KeyG', preventDefault: true }],
  removeTable: [
    { shortcut: '$mod+Backspace', preventDefault: true },
    { shortcut: '$mod+Delete', preventDefault: true },
  ],
  removeColumn: [
    { shortcut: 'Alt+Backspace', preventDefault: true },
    { shortcut: 'Alt+Delete', preventDefault: true },
  ],
  removeSelection: [
    { shortcut: 'Delete', preventDefault: true },
    { shortcut: 'Backspace', preventDefault: true },
  ],
  primaryKey: [{ shortcut: 'Alt+KeyK', preventDefault: true }],
  selectAllTable: [
    { shortcut: '$mod+KeyA', preventDefault: true },
    { shortcut: '$mod+Alt+KeyA', preventDefault: true },
  ],
  selectAllColumn: [{ shortcut: 'Alt+KeyA', preventDefault: true }],
  relationshipZeroOne: [{ shortcut: '$mod+Alt+Digit1', preventDefault: true }],
  relationshipZeroN: [{ shortcut: '$mod+Alt+Digit2', preventDefault: true }],
  relationshipOneOnly: [{ shortcut: '$mod+Alt+Digit3', preventDefault: true }],
  relationshipOneN: [{ shortcut: '$mod+Alt+Digit4', preventDefault: true }],
  tableProperties: [{ shortcut: 'Alt+Space', preventDefault: true }],
  focusView: [
    { shortcut: 'Alt+KeyF', preventDefault: true, stopPropagation: true },
  ],
  handTool: [{ shortcut: 'Space', preventDefault: true }],
  zenMode: [
    { shortcut: 'Alt+KeyZ', preventDefault: true, stopPropagation: true },
  ],
};

// example
editor.setKeyBindingMap({
  addTable: [{ shortcut: '$mod+KeyN', preventDefault: true }],
});

يُفسح كل من selectAllTable وhandTool وremoveSelection، ومنذ الإصدار 4.1.0 groupSelectedTables أيضًا، المجال لمؤشر الكتابة: أثناء وجود التركيز في عنصر input أو textarea أو contenteditable، يحدد $mod + A النص، ويكتب Space مسافة، ويمحو Delete وBackspace النص، ويكتب T ثم G الحرفين، بدلًا من أن تصل إلى لوحة الرسم. ولا يُمنع السلوك الافتراضي لأي من هذه الضغطات. وأيًّا كانت المفاتيح التي تعيد ربطها بها، فإنها تتصرف بالطريقة نفسها.

منذ الإصدار 4.0.0، يزيل removeSelection (Delete أو Backspace) التحديد في علامة تبويب ERD كخطوة تراجع واحدة، دون أن يطلب تأكيدًا. فإذا كان الجدول الذي عليه التركيز هو الشيء الوحيد المحدد، وكان عمود أو أكثر من أعمدته محددًا، وكان مستوى التكبير يرسم صفوفه، أزال تلك الأعمدة؛ وإلا أزال كل جدول وملاحظة ومجموعة جداول محددة، مع الإبقاء على جداول المجموعة. راجع حذف الجداول والملاحظات.
والمفتاح المضغوط باستمرار يزيل مرة واحدة، ولا يُزال شيء أثناء فتح محرر خلية أو ملاحظة أو اسم مجموعة جداول. وخارج الحقول النصية واللوحات وعلامات التبويب التي تحتجز الاختصارات (راجع createKeyBindingMap)، يُمنع السلوك الافتراضي للضغطة في كل علامة تبويب ما دام التركيز على المحرر، وعلى زر شريط أدوات عليه التركيز أيضًا، وفي المحرر للقراءة فقط، حيث لا تزيل شيئًا.

منذ الإصدار 4.1.0، يُجهّز addTableGroup (Alt+KeyG) رسم New Table Group في علامة تبويب ERD، فترسم الضغطة التالية بالزر الرئيسي على لوحة الرسم المجموعة، والضغط عليه مرة أخرى يلغي تجهيز الرسم، كما يفعل الزر New Table Group في شريط أدوات لوحة الرسم. ويضع groupSelectedTables (KeyT KeyG، T ثم G) الجداول المحددة في مجموعة جديدة ويفتح محرر اسمها، كما يفعل Group selected tables في قائمة السياق للجدول. وإذا لم يكن أي جدول محددًا فلا يضيف شيئًا؛ ولا تُحتسب الملاحظة أو مجموعة الجداول المحددة. راجع رسم مجموعة وتجميع الجداول المحددة.
ولا يعمل الاثنان إلا حيث تتيح القوائم المجموعات: لا أثناء ضبط readonly، ولا عندما يُخفي خيار العرض Table Groups المجموعات، ولا أثناء فتح محرر خلية أو ملاحظة أو اسم مجموعة جداول. ومثل اختصارات لوحة الرسم الأخرى، لا يعملان إلا في علامة تبويب ERD، ولا يعملان أثناء فتح البحث السريع أو خصائص الجدول أو عارض الفروق أو السفر عبر الزمن أو معاينة التخطيط التلقائي أو Export image أو Map Columns. وحيث لا يفعلان شيئًا، يظل السلوك الافتراضي للضغطة ممنوعًا، ما لم يُفسح groupSelectedTables المجال لمؤشر الكتابة. ويُوقف أيضًا انتشار addTableGroup، كما هو الحال مع focusView وzenMode، لذا لا يسمعه أبدًا مستمع keydown في مرحلة الصعود في الصفحة.

منذ الإصدار 4.2.0، في علامة تبويب القاموس، تُدرج كل تركيبة مفاتيح من ضغطة واحدة في addColumn أسفل التحديد صفوفًا بعدد الصفوف التي يشملها التحديد، وتُدرجها التركيبة نفسها مع الضغط على Shift أيضًا في الأعلى، وتحذف كل تركيبة مفاتيح من ضغطة واحدة في removeColumn الصفوف التي يشملها التحديد: Alt+Enter وAlt+Shift+Enter، وAlt+Backspace أو Alt+Delete مع القيم الافتراضية. وتعمل في شبكة الأوراق Domains وWords وTerms ما دام لا يوجد تحرير خلية مفتوح. وتركيبة addColumn التي تتضمن Shift بالفعل لا تعطي تركيبة للإدراج في الأعلى، والتسلسل المرتبط بأي من الاسمين لا يعطي الشبكة شيئًا.
ويُمنع السلوك الافتراضي لكل ضغطة من هذا النوع بحسب خيارها، ويُوقف انتشارها دائمًا، لذا لا تضيف أي عمود ولا تزيله في علامة تبويب ERD. وفي الورقة Checks وفي المحرر للقراءة فقط لا تفعل شيئًا، وإن ظل سلوكها الافتراضي ممنوعًا وانتشارها موقوفًا. وفي تحرير خلية مفتوح أو في حقل البحث في علامة التبويب، تُترك التركيبات للنص: إذ يُوقف انتشارها هناك دون منع سلوكها الافتراضي، فيتعامل الحقل معها كما يفعل في أي مكان آخر (على جهاز Mac، يحذف ⌥ + Backspace كلمة). وتسردها dictionaryRowChords.

منذ الإصدار 3.10.0، يفتح findReplace ($mod+KeyF) البحث والاستبدال. ومنذ الإصدار 4.1.0، يفتح المستكشف الذي يضمه أو يغلقه، وتعرضه علامة تبويب الاختصارات باسم Toggle Explorer.
ما دام الزر Explorer في شريط الأدوات يظهر مضغوطًا (المستكشف مفتوح في علامة تبويب ERD وغير مخفي بوضع الزن)، يغلق المستكشف، ما لم يكن البحث السريع أو خصائص الجدول أو منشئ النسق أو منتقي لغة العرض أو مربع الحوار Export image أو Map Columns مفتوحًا. وإلا فإنه يغلق أيًّا من هذه كان مفتوحًا، ويُظهر علامة تبويب ERD من أي علامة تبويب أخرى، ويفتح المستكشف مع وجود مؤشر الكتابة في حقل Find وتحديد نص البحث. والمحرر الأضيق من أن يعرض المستكشف بجانب لوحة الرسم يبقيه مفتوحًا لكن مُنحّى جانبًا، ويعرض الإشعار المنبثق Widen the window to show the Explorer. قبل الإصدار 4.1.0، كان يفتح لوحة البحث والاستبدال العائمة، أو يعيد لوحة المفاتيح إلى حقلها، ولم يكن يغلقها أبدًا.
ولا يُفسح المجال لمؤشر الكتابة: ما دام التركيز على المحرر، يلتقطه المحرر في كل علامة تبويب، من لوحة الرسم أو من حقل إدخال داخل المحرر. ويُمنع السلوك الافتراضي للضغطة، فلا يفتح المتصفح شريط البحث، ويُوقف انتشارها، فلا يسمعها أي مستمع keydown في مرحلة الصعود في الصفحة. وعند فتح محرر خلية أو ملاحظة، أو منذ الإصدار 4.0.0 محرر اسم مجموعة جداول، أو منذ الإصدار 4.2.0 تحرير خلية في شبكة علامة تبويب القاموس، يظل سلوكه الافتراضي ممنوعًا وانتشاره موقوفًا، لكنه لا يفعل شيئًا. وفي هذه الحالة الأخيرة لا يفعل search شيئًا أيضًا، فيبقى النص المكتوب حتى الآن.
أثناء فتح عارض الفروق أو السفر عبر الزمن أو معاينة التخطيط التلقائي، في أي علامة تبويب، أو بينما لا يزال أسلوب الإدخال (IME) في طور التركيب، لا يُمنع سلوكه الافتراضي ولا يُوقف انتشاره، فيتلقاه البحث الخاص بالمتصفح أو بالتطبيق المضيف. وداخل المستكشف، يُوقف هناك انتشار الضغطة التي لا تزال في طور التركيب، وإن لم يُمنع سلوكها الافتراضي. وأيًّا كان المفتاح الذي تعيد ربط findReplace به، فإنه يتصرف بالطريقة نفسها.

لا يعمل focusView إلا في علامة تبويب ERD. فإذا كان جدول واحد على الأقل محددًا، يفتح علامة تبويب التصور المرئي في وضع التدفق، مقتصرًا على تلك الجداول وكل جدول يبعد عنها علاقة واحدة؛ ولا تُحتسب الملاحظة أو مجموعة الجداول المحددة، وإذا لم يكن أي جدول محددًا فلا يفعل شيئًا. راجع التركيز على الجداول.

يعمل undo وredo بحسب علامة التبويب. ففي علامة تبويب ERD يُجريان التراجع والإعادة على سجل المستند. ومنذ الإصدار 4.2.0، يُجريانهما في علامة تبويب القاموس على السجل الخاص بالورقة المعروضة، ولا يُجريان شيئًا في الورقة Checks، راجع أوراق القاموس. وفي وضع التدفق في علامة تبويب التصور المرئي، يرجعان خطوة ويتقدمان خطوة كما يفعل Previous table وNext table، دون المساس بسجل المستند. وفي علامات التبويب الأخرى، وفي وضع الرسم البياني، لا يتراجعان عن شيء.

في علامة تبويب ERD، يُنهي stop (Escape) محرر الخلية أو الملاحظة المفتوح، أو العلاقة الجاري رسمها، ويترك التحديد كما هو. ومنذ الإصدار 4.0.0، يُنهي أيضًا محرر اسم مجموعة الجداول دون كتابة أي اسم، ورسم New Table Group. ويستدعي المحرر preventDefault() على تلك الضغطة.
وإذا لم يكن أي منها مفتوحًا، يمسح Escape التحديد والخلية التي عليها التركيز، ولا يُمنع سلوكه الافتراضي. لذا يتطلب الخروج من التعديل ومسح التحديد ضغطتين.
منذ الإصدار 4.2.0، ما دامت قائمة المصطلحات في خلية الاسم المنطقي ظاهرة (راجع إكمال أسماء المصطلحات)، تغلق ضغطة Escape الأولى القائمة وحدها وتترك المحرر مفتوحًا. ويُمنع السلوك الافتراضي لتلك الضغطة ويُوقف انتشارها عند الخلية، لذا لا يسمعها stop ولا مستمع keydown في مرحلة الصعود في الصفحة.
وباستثناء المستكشف، وتنسيقات Import في شاشة الترحيب، وقائمة المصطلحات في خلية الاسم المنطقي، وعلامة تبويب القاموس، والمنتقيات ومربعات الحوار المذكورة أدناه، لا يوقف المحرر انتشار Escape أبدًا، لذا فإن الصفحة التي تستمع إليه بنفسها، لإغلاق مربع حوار خاص بها مثلًا، تسمع الضغطتين ويمكنها تخطي الضغطة التي تكون قيمة defaultPrevented فيها true.
أثناء فتح البحث السريع أو خصائص الجدول أو عارض الفروق أو معاينة التخطيط التلقائي أو السفر عبر الزمن، يغلق Escape المفتوح منها بدلًا من ذلك ويترك التحديد كما هو. ولا يُمنع السلوك الافتراضي لتلك الضغطة أيضًا.
منذ الإصدار 4.0.0، يتلقى مربع الحوار Export image أو Map Columns المفتوح أيضًا Escape، فيُغلق نفسه ويترك التحديد كما هو. ويستحوذ كل منهما على لوحة المفاتيح عند فتحه، ويُمنع السلوك الافتراضي لضغطة Escape هذه ويُوقف انتشارها.
منذ الإصدار 4.1.0، تعيد ضغطة Escape والتركيز داخل المستكشف، في شجرته أو حقوله أو أزراره، لوحة المفاتيح إلى لوحة الرسم، وتترك المستكشف مفتوحًا والتحديد كما هو. ويستدعي المحرر عليها preventDefault() وstopPropagation() كليهما، لذا لا تصل أبدًا إلى مستمع keydown في مرحلة الصعود في الصفحة.
ولا تغلق ضغطة Escape على لوحة الرسم المستكشف أبدًا. قبل الإصدار 4.1.0، كانت ضغطة Escape داخل لوحة البحث والاستبدال تغلقها، وكانت الضغطة على لوحة الرسم تغلقها بالضغطة نفسها التي تمسح التحديد.
منذ الإصدار 4.0.0، يُغلق منتقي لغة العرض ومنتقي الألوان عند Escape: داخلهما يُمنع سلوكه الافتراضي ويُوقف انتشاره، وعلى لوحة الرسم يغلقهما بالضغطة نفسها التي تمسح التحديد، دون منع سلوكه الافتراضي أو إيقاف انتشاره.
ضغطة Escape أثناء استمرار التركيب في أسلوب الإدخال (IME) تخص التركيب. فهي تترك المحرر المفتوح كما هو ولا يُمنع سلوكها الافتراضي، لذا يمكن للصفحة كذلك تخطي الضغطة التي تكون قيمة isComposing فيها true، أو قيمة keyCode فيها 229. وداخل المستكشف، يُوقف أيضًا انتشار مثل هذه الضغطة، مثل أي مفتاح يُضغط هناك في أثناء التركيب، وتبقى لوحة المفاتيح في الحقل.
قبل الإصدار 3.9.2، كانت ضغطة Escape واحدة تُنهي التعديل أو الرسم وتمسح التحديد معًا، ولم يكن المحرر يمنع سلوكها الافتراضي أبدًا.

createKeyBindingMap

منذ الإصدار 3.9.2، تُصدِّر الحزمة createKeyBindingMap()، ومعها الأنواع KeyBindingMap وKeyBindingName وShortcutOption.
يُرجع اختصارات لوحة المفاتيح الافتراضية، وهي 28 اسمًا بما فيها الأسماء الثابتة، في خريطة جديدة عند كل استدعاء، لذا لا يغيّر تعديل الخريطة التي يُرجعها أي شيء آخر.
وهي ما يبدأ منه كل محرر، ولا يظهر فيها أثر استدعاء setKeyBindingMap.
ومن بين هذه الأربعة، createKeyBindingMap وحده تصدير في وقت التشغيل؛ والثلاثة الأخرى أنواع. ومنذ الإصدار 4.2.0، يُصدَّر dictionaryRowChords بجانبه.

type KeyBindingName =
  | 'edit'
  | 'stop'
  | 'search'
  | 'findReplace'
  | 'undo'
  | 'redo'
  | 'addTable'
  | 'addColumn'
  | 'addMemo'
  | 'addTableGroup'
  | 'groupSelectedTables'
  | 'removeTable'
  | 'removeColumn'
  | 'removeSelection'
  | 'primaryKey'
  | 'selectAllTable'
  | 'selectAllColumn'
  | 'relationshipZeroOne'
  | 'relationshipZeroN'
  | 'relationshipOneOnly'
  | 'relationshipOneN'
  | 'tableProperties'
  | 'focusView'
  | 'zoomIn'
  | 'zoomOut'
  | 'zoomReset'
  | 'handTool'
  | 'zenMode';

type KeyBindingMap = Record<KeyBindingName, ShortcutOption[]>;

declare function createKeyBindingMap(): KeyBindingMap;

// example
import { createKeyBindingMap } from '@dineug/erd-editor';

const shortcuts = Object.values(createKeyBindingMap())
  .flat()
  .map(({ shortcut }) => shortcut); // 'Enter', 'Escape', '$mod+KeyK', ...

كل shortcut تركيبة مفاتيح بصيغة tinykeys تسمّي مفتاحها بحسب KeyboardEvent.code، حيث يكون $mod هو ⌘ على macOS وControl في غيره.
منذ الإصدار 4.0.0، يقرأ المحرر هذه التركيبات بنفسه بدلًا من tinykeys، بالصيغة نفسها. يتطابق المفتاح بقيمة code الخاصة به، أو بقيمة key بأي حالة أحرف، ولا تتطابق الضغطة إلا مع الضغط على مفاتيح التعديل التي تذكرها بالضبط. ويُحتسب AltGraph على أنه Control وAlt على Windows، وAlt على macOS. والضغطات التي تفصل بينها مسافة تشكّل تسلسل مفاتيح، يبدأ من جديد بعد مرور ثانية دون أي keydown.
منذ الإصدار 4.1.0، أحد الاختصارات الافتراضية تسلسل مفاتيح: groupSelectedTables هو KeyT KeyG، أي T ثم G. ويُنفَّذ التسلسل عند الضغطة التي تكمله، وتلك الضغطة وحدها تأخذ preventDefault وstopPropagation الخاصين به، لذا مع القيم الافتراضية يصل T إلى الصفحة ولا يُمنع السلوك الافتراضي إلا للمفتاح G. وتعرض القوائم والبحث السريع وعلامة تبويب الاختصارات التسلسل بمفتاح واحد لكل ضغطة.
تُربط الأسماء الثابتة على النحو التالي: Enter (edit) وEscape (stop) و$mod+KeyZ (undo) و$mod+Shift+KeyZ (redo) و$mod+Equal (zoomIn) و$mod+Minus (zoomOut) و$mod+Digit0 (zoomReset). لا يحمل edit وstop أي علامات؛ وتحمل الخمسة الأخرى preventDefault وstopPropagation. والبقية هي القيم الافتراضية أعلاه، ومنها search وfindReplace.

يستمع المحرر إلى هذه الاختصارات على عنصره الخاص، لذا يجب على التطبيق المضيف الذي يلتقط المفاتيح قبل المحرر، باختصارات عامة أو بمستمع keydown في مرحلة الالتقاط، أن يسمح بمرورها ما دام التركيز على المحرر.
أنشئ قائمة ما يُسمح بمروره من createKeyBindingMap()، مع وضع الاختصارات التي مررتها إلى setKeyBindingMap مكان القيم الافتراضية.
منذ الإصدار 3.10.0، تتضمن تلك القائمة $mod+KeyF، وهي تركيبة البحث الخاصة بالمتصفح. والتطبيق المضيف الذي يريد الإبقاء على بحثه الخاص على تلك التركيبة يستدعي setKeyBindingMap({ findReplace: [] }).
منذ الإصدار 4.0.0، تتضمن أيضًا Delete وBackspace دون مفاتيح تعديل. والتطبيق المضيف الذي يريد الإبقاء على هذين المفتاحين يستدعي setKeyBindingMap({ removeSelection: [] }).
منذ الإصدار 4.1.0، تتضمن أيضًا Alt+KeyG والتسلسل KeyT KeyG، الذي يأتي كسلسلة نصية واحدة: قسّمه عند المسافة واسمح بمرور كل ضغطة، بما في ذلك T وG دون مفاتيح تعديل، لأن التسلسل الذي تنقصه ضغطة لا يكتمل أبدًا. والتطبيق المضيف الذي يريد الإبقاء على هذه المفاتيح يستدعي setKeyBindingMap({ addTableGroup: [] }) أو setKeyBindingMap({ groupSelectedTables: [] }).
منذ الإصدار 4.2.0، أضف إليها التركيبات التي يُرجعها dictionaryRowChords للخريطة نفسها، ومنها Alt+Shift+Enter. والتطبيق المضيف الذي يريد الإبقاء على هذه المفاتيح يستدعي setKeyBindingMap({ addColumn: [] }) أو setKeyBindingMap({ removeColumn: [] })، ما يُبعدها أيضًا عن إضافة الأعمدة وإزالتها في علامة تبويب ERD.

ما دام التركيز داخل المستكشف، في شجرته أو حقلي Find وReplace أو أزراره، يمر findReplace وsearch وundo وredo وzoomIn وzoomOut وzoomReset إلى المحرر، لذا يعمل findReplace هناك كما يعمل على لوحة الرسم. وكل اختصار آخر، بحسب ضبطه الحالي، يتوقف عند المستكشف، والتسلسل بضغطته الأخيرة (G وحده مع القيم الافتراضية)، وكذلك مفاتيح الأسهم وTab وEnter وSpace وHome وEnd وأي مفتاح يُضغط بينما لا يزال أسلوب الإدخال (IME) في طور التركيب. وباستثناء Escape، الذي يعيد لوحة المفاتيح إلى لوحة الرسم، يُوقف انتشارها دون منع سلوكها الافتراضي، لذا تعمل كمفاتيح عادية في حقول المستكشف وأزراره وشجرته، ولا تصل إلى لوحة الرسم ولا إلى مستمع keydown في مرحلة الصعود في الصفحة: فلا يضيف Alt + N هناك أي جدول، ولا يزيل Delete شيئًا. أما المفاتيح التي تتنقل بين صفوف الشجرة أو تطويها أو تنتقل إلى صف منها، وEnter في حقل Find أو Replace، الذي يتنقل بين التطابقات أو يستبدل، فيُمنع سلوكها الافتراضي أيضًا.
وأي مفتاح آخر، مثل تركيبة الحفظ أو لوحة الأوامر في التطبيق المضيف، يواصل طريقه إلى الصفحة كالمعتاد. راجع لوحة المفاتيح في المستكشف. قبل الإصدار 4.1.0، كانت لوحة البحث والاستبدال العائمة تحتجز المفاتيح بالطريقة نفسها، باستثناء Home وEnd والضغطة الأخيرة في التسلسل، وSpace عندما كان handTool مرتبطًا بمفتاح آخر.
منذ الإصدار 4.0.0، يحتجز منتقي لغة العرض المفاتيح بالطريقة نفسها: تمر الاختصارات السبعة نفسها، ويُوقف هناك انتشار كل اختصار آخر (ومنذ الإصدار 4.1.0 التسلسل بضغطته الأخيرة) ومفاتيح الأسهم وTab دون منع سلوكها الافتراضي، وكذلك أي مفتاح يُضغط بينما لا يزال أسلوب الإدخال (IME) في طور التركيب. ويتنقل ↑ و↓ وHome وEnd وEnter وSpace على أحد صفوفه بين الصفوف أو يختار أحدها، ويُمنع سلوكها الافتراضي أيضًا.

منذ الإصدار 4.2.0، تحتجز علامة تبويب القاموس المفاتيح أيضًا، ولا يمر منها إلى المحرر إلا search وfindReplace وundo وredo. ويعمل undo وredo على السجل الخاص بالورقة المعروضة، ومع وجود تحرير خلية مفتوح أو التركيز في حقل البحث في علامة التبويب يُتركان للنص، فيُوقف انتشارهما هناك دون منع سلوكهما الافتراضي. ولا يفعل search وfindReplace شيئًا ما دام تحرير الخلية مفتوحًا، كما ورد أعلاه. وتعمل تركيبات مفاتيح الصفوف في الشبكة، كما هو موضّح ضمن addColumn وremoveColumn أعلاه.
وكل اختصار آخر، بحسب ضبطه الحالي، يتوقف عند علامة التبويب، والتسلسل بضغطته الأخيرة، وكذلك مفاتيح الأسهم وTab وEnter وSpace وHome وEnd وأي مفتاح يُضغط بينما لا يزال أسلوب الإدخال (IME) في طور التركيب. ولا يصل أي منها إلى لوحة الرسم ولا إلى مستمع keydown في مرحلة الصعود في الصفحة: فلا يضيف Alt + N هناك أي جدول، ولا يزيل Delete شيئًا من المخطط. وتتوقف أحداث النسخ والقص واللصق في علامة التبويب هناك أيضًا، لذا لا يقرؤها المخطط أبدًا على أنها أحداثه. وأي مفتاح آخر يواصل طريقه إلى الصفحة كالمعتاد.

dictionaryRowChords

منذ الإصدار 4.2.0، تُصدِّر الحزمة dictionaryRowChords(). ويُرجع، في مصفوفة ShortcutOption[] جديدة عند كل استدعاء، كل تركيبة مفاتيح تُدرج بها شبكة علامة تبويب القاموس الصفوف أو تحذفها وفق خريطة اختصارات لوحة المفاتيح التي تمررها.
وهي بالترتيب: تركيبات addColumn ذات الضغطة الواحدة، التي تُدرج صفوفًا أسفل التحديد؛ وكل منها مع الضغط على Shift أيضًا، وهي تُدرج صفوفًا في الأعلى، ولا شيء للتركيبة التي تتضمن Shift بالفعل؛ وتركيبات removeColumn ذات الضغطة الواحدة، التي تحذف الصفوف. وتحتفظ كل منها بقيمتي preventDefault وstopPropagation للاختصار الذي جاءت منه، ويُستبعد التسلسل. راجع إضافة الصفوف وحذفها.
والتركيبة التي تُدرج صفوفًا في الأعلى، وهي Alt+Shift+Enter مع القيم الافتراضية، غير موجودة في أي اختصار، لذا فإن التطبيق المضيف الذي يطابق مفاتيح التعديل بدقة ويبني قائمة المفاتيح المسموح بمرورها من createKeyBindingMap وحده لا يسمح بمرورها أبدًا. اسمح بمرور القائمتين كلتيهما، كما يفعل مكوّن Obsidian الإضافي.
ولا يقرأ إلا الخريطة التي تُعطى له، لا اختصارات العنصر، لذا مرّر إليه الخريطة التي بنيت منها قائمة المفاتيح.

declare function dictionaryRowChords(
  keyBindingMap: KeyBindingMap
): ShortcutOption[];

// example
import { createKeyBindingMap, dictionaryRowChords } from '@dineug/erd-editor';

const map = createKeyBindingMap();
const shortcuts = [
  ...Object.values(map).flat(),
  ...dictionaryRowChords(map),
].map(({ shortcut }) => shortcut);
// dictionaryRowChords(map): 'Alt+Enter', 'Alt+Shift+Enter', 'Alt+Backspace', 'Alt+Delete'

$mod

يبدّل مفتاح Control بحسب البيئة.

• Mac: $mod = Meta (⌘)
• Windows/Linux: $mod = Control

جدول الاختصارات

يستخدم الخاصيتين key, code في حدث لوحة المفاتيح.
استخدم code للمواضع المطلقة وkey لقيم الإدخال.

Windows	macOS	key	code
N/A	Command / ⌘	Meta	MetaLeft / MetaRight
Alt	Option / ⌥	Alt	AltLeft / AltRight
Control	Control / ^	Control	ControlLeft / ControlRight
Shift	Shift	Shift	ShiftLeft / ShiftRight
Space	Space	N/A	Space
Enter	Return	Enter	Enter
Esc	Esc	Escape	Escape
Backspace	Delete / ⌫	Backspace	Backspace
Delete	fn + Delete	Delete	Delete
1، 2، وهكذا	1، 2، وهكذا	1، 2، وهكذا	Digit1، Digit2، وهكذا
a، b، وهكذا	a، b، وهكذا	a، b، وهكذا	KeyA، KeyB، وهكذا
-	-	-	Minus
=	=	=	Equal
+	+	+	Equal

النسق

setPresetTheme

يضبط نسقًا معدًّا مسبقًا.
القيم الافتراضية هي appearance: 'dark' وgrayColor: 'slate' وaccentColor: 'indigo'.
يُطبَّق كل حقل على حدة، لذا يترك الاستدعاء الجزئي الحقلين الآخرين كما هما. وتُتجاهل القيمة التي ليست أحد الأسماء أدناه، ولا يرمي الاستدعاء خطأً أبدًا.
منذ الإصدار 4.0.0، يقبل appearance أيضًا 'system'، أي الخيار System في منشئ النسق. ويعرض الوضع الفاتح أو الداكن الذي يُبلغ عنه نظام التشغيل، أو الذي يحدده setSystemAppearance، ويتبدل عندما يتغير ذلك.

type ThemeOptions = {
  appearance: 'dark' | 'light' | 'system';
  grayColor: 'gray' | 'mauve' | 'slate' | 'sage' | 'olive' | 'sand';
  accentColor:
    | 'gray'
    | 'gold'
    | 'bronze'
    | 'brown'
    | 'yellow'
    | 'amber'
    | 'orange'
    | 'tomato'
    | 'red'
    | 'ruby'
    | 'crimson'
    | 'pink'
    | 'plum'
    | 'purple'
    | 'violet'
    | 'iris'
    | 'indigo'
    | 'blue'
    | 'cyan'
    | 'teal'
    | 'jade'
    | 'green'
    | 'grass'
    | 'lime'
    | 'mint'
    | 'sky';
};

// example
editor.setPresetTheme({ appearance: 'light' });

setSystemAppearance

منذ الإصدار 4.0.0، يحدد الوضع الفاتح أو الداكن الذي يعرضه المظهر 'system'، للتطبيق المضيف الذي له وضعان فاتح وداكن خاصان به، مثل نسق بيئة التطوير. وما دام أحدهما محددًا، تُتجاهل تغييرات نظام التشغيل.
ويؤدي null، أو أي قيمة غير 'dark' أو 'light'، إلى العودة إلى اتباع نظام التشغيل.
ما دام المظهر 'light' أو 'dark'، لا يغيّر شيئًا على الشاشة، لكن القيمة يُحتفظ بها وتُطبَّق فور أن يصبح المظهر 'system'. وإلا فإنها تُطبَّق فورًا. ولا يُطلِق شيئًا، ويواصل changePresetTheme الإبلاغ عن 'system'.
تستدعيه التطبيقات المضيفة VS Code وJetBrains وObsidian بوضعها الفاتح أو الداكن الخاص، ثم مرة أخرى كلما تغيّر ذلك.

editor.setPresetTheme({ appearance: 'system' });
editor.setSystemAppearance('light'); // null follows the OS again

setTheme

يتيح تخصيص النسق.
يستبدل كل استدعاء الطبقة المخصصة بأكملها، لذا مرّر الكائن الكامل مجددًا لتغيير رمز واحد فوق تخصيص قائم، ومرّر {} للعودة إلى النسق المعدّ مسبقًا.
لا يُحتفظ إلا بأسماء الرموز أدناه ذات القيم من نوع السلسلة النصية؛ ويُسقَط أي شيء آخر دون خطأ.
تقع الطبقة المخصصة فوق النسق المعدّ مسبقًا، لذا فإن استدعاء setPresetTheme لاحقًا يبدّل النسق المعدّ مسبقًا الذي تحتها بينما تبقى تخصيصاتك.

JavaScript

type Theme = {
  grayColor1: string;
  grayColor2: string;
  grayColor3: string;
  grayColor4: string;
  grayColor5: string;
  grayColor6: string;
  grayColor7: string;
  grayColor8: string;
  grayColor9: string;
  grayColor10: string;
  grayColor11: string;
  grayColor12: string;

  accentColor1: string;
  accentColor2: string;
  accentColor3: string;
  accentColor4: string;
  accentColor5: string;
  accentColor6: string;
  accentColor7: string;
  accentColor8: string;
  accentColor9: string;
  accentColor10: string;
  accentColor11: string;
  accentColor12: string;

  canvasBackground: string;
  canvasBoundaryBackground: string;

  tableBackground: string;
  tableHeaderBackground: string;
  tableSelect: string;
  tableBorder: string;
  tableShadow: string;

  tableGroupHeaderBackground: string;
  tableGroupBackground: string;
  tableGroupBorder: string;

  memoBackground: string;
  memoSelect: string;
  memoBorder: string;
  memoShadow: string;

  columnSelect: string;
  columnSelectHover: string;
  columnHover: string;

  columnHandleBackground: string;
  columnHandleBorder: string;
  columnHandleHoverBackground: string;
  columnHandleHoverBorder: string;

  relationshipHover: string;

  visualizationLink: string;
  visualizationColumn: string;
  visualizationRelationship: string;

  toolbarBackground: string;

  contextMenuBackground: string;
  contextMenuSelect: string;
  contextMenuHover: string;
  contextMenuBorder: string;

  minimapBorder: string;
  minimapShadow: string;
  minimapViewportBorder: string;
  minimapViewportBorderHover: string;

  toastBackground: string;
  toastBorder: string;
  toastSuccess: string;
  toastError: string;

  findReplaceError: string;

  mapColumnsError: string;

  schemaSqlWarningBackground: string;
  schemaSqlWarningForeground: string;

  dragSelectBackground: string;
  dragSelectBorder: string;

  scrollbarTrack: string;
  scrollbarThumb: string;
  scrollbarThumbHover: string;

  foreground: string;
  active: string;
  placeholder: string;

  focus: string;
  inputActive: string;

  keyPK: string;
  keyFK: string;
  keyPFK: string;

  treeBackground: string;
  treeRowHover: string;
  treeRowCurrent: string;
  treeMuted: string;
  treeMatch: string;

  explorerBackground: string;
  explorerBorder: string;

  dictionaryErrorForeground: string;
  dictionaryErrorBackground: string;
  dictionaryWarningForeground: string;
  dictionaryWarningBackground: string;
  dictionaryBackground: string;
  dictionaryHeaderBackground: string;
  dictionaryGridLine: string;
  dictionaryHeaderSelect: string;

  diffInsertForeground: string;
  diffDeleteForeground: string;
  diffModifyForeground: string;
  diffRenameForeground: string;
};

// example
editor.setTheme({
  canvasBackground: '#1b1b1f',
  tableBackground: '#242429',
  keyPK: '#ffc53d',
});

يمثل tableShadow وmemoShadow لون الظل الذي تلقيه الجداول والملاحظات على لوحة رسم ERD. ويتركهما النسق الداكن المعدّ مسبقًا transparent، فلا يُلقى أي ظل، كما يحدث عند تمرير none أو سلسلة نصية فارغة إلى setTheme؛ أما النسق الفاتح المعدّ مسبقًا فيستخدم rgba(0, 0, 0, 0.18).

منذ الإصدار 4.0.0، توجد تسعة رموز إضافية:

• يلوّن tableGroupHeaderBackground وtableGroupBackground وtableGroupBorder شريط العنوان والجسم والإطار في مجموعة الجداول التي ليس لها لون خاص بها.
• يلوّن toastSuccess وtoastError علامة الإشعار المنبثق الذي يُبلغ عن نتيجة انتهاء أمر ما.
• يلوّن findReplaceError وmapColumnsError الأخطاء التي يعرضها البحث والاستبدال ومربع حوار تعيين الأعمدة. وكان البحث والاستبدال يستخدم diffDeleteForeground من قبل، لذا لم يعد تخصيص ذلك الرمز يغيّر لونه.
• يلوّن schemaSqlWarningBackground وschemaSqlWarningForeground التحذيرات في خيارات علامة تبويب مخطط SQL.

منذ الإصدار 4.1.0، توجد تسعة رموز إضافية أخرى:

• يلوّن treeBackground وtreeRowHover وtreeRowCurrent وtreeMuted وtreeMatch الشجرة التي يتشاركها المستكشف وعارض الفروق: خلفيتها، التي تملأ أيضًا حقلي Find وReplace في المستكشف؛ والصف الذي يقع تحت المؤشر، وصف لوحة المفاتيح عندما يكون التركيز على الشجرة، والزر الذي يقع تحت المؤشر في شريط عنوان المستكشف وبحثه؛ وصف تطابق البحث الحالي؛ والنص الخافت مثل الأعداد وأنواع البيانات وأسهم الطي؛ والعلامة خلف النص الذي عثر عليه البحث.
• يلوّن explorerBackground وexplorerBorder لوحة المستكشف وخطوطها: حافتها بجانب لوحة الرسم، والخط أسفل بحثها، وحدود حقولها والأزرار التي يُظهرها توسيع Search In. ويرسم explorerBorder أيضًا حافة شجرة عارض الفروق، والخط أسفل حقل Filter by name فيها، وحدود ذلك الحقل. وتأخذ أيقونات المفاتيح في المستكشف keyPK وkeyFK وkeyPFK.
• يلوّن diffModifyForeground وdiffRenameForeground ما يعلّمه عارض الفروق على أنه معدّل أو معاد تسميته، في شجرته وعلى المستندين كليهما. ويرسم diffModifyForeground أيضًا إطار الجدول أو الملاحظة أو مجموعة الجداول التي نُقلت أو تغيّر حجمها أو لونها أو مجموعتها، بصرف النظر عما تغيّر فيها غير ذلك، ويرسم خط ربط المفتاح الخارجي الذي تغيّر.

أصبح diffInsertForeground وdiffDeleteForeground يلوّنان الآن ما يعلّمه عارض الفروق على أنه مضاف أو مُزال، في شجرته وعلى المستند الذي يحتويه، في النصوص والأطر وخطوط الربط على حد سواء. وأُزيل diffInsertBackground وdiffDeleteBackground وdiffCrossBackground وdiffCrossForeground في الإصدار 4.1.0، لأن عارض الفروق لم يعد يملأ الخلايا. ويُسقطها setTheme مثل أي اسم آخر ليس في Theme، ولم تعد متغيراتها --erd-editor-diff-insert-background و--erd-editor-diff-delete-background و--erd-editor-diff-cross-background و--erd-editor-diff-cross-foreground تُقرأ.

منذ الإصدار 4.2.0، يوجد 12 رمزًا إضافيًا آخر:

• يملأ columnHandleBackground وcolumnHandleBorder مقبض سحب العمود ويرسمان إطاره، وهو يُرسم خارج الحافة اليسرى للجدول مباشرة بجانب صف العمود الذي عليه التركيز، ويحل محلهما columnHandleHoverBackground وcolumnHandleHoverBorder أثناء وجود المؤشر فوقه. وتأخذ علامة الإمساك فيه foreground، وactive تحت المؤشر.
• يلوّن dictionaryErrorForeground وdictionaryWarningForeground ما ترصده فحوصات القاموس، خطأً كان أو تحذيرًا: الاسم المرصود على لوحة رسم ERD (راجع العلامات على لوحة الرسم)، ونص الخلية المرصودة في الأوراق Domains وWords وTerms، وعدد Checks. ويملأ dictionaryErrorBackground وdictionaryWarningBackground مثل هذه الخلية. ويلوّن dictionaryErrorForeground أيضًا الأداة Delete Rows تحت المؤشر.
• يلوّن dictionaryBackground وdictionaryHeaderBackground وdictionaryGridLine وdictionaryHeaderSelect ورقة علامة تبويب القاموس: خلاياها، ويملأ لونها أيضًا حقل البحث في علامة التبويب وقائمة مجالات المصطلح؛ ورؤوس أعمدتها وأرقام صفوفها؛ والخطوط بين الخلايا، ويرسم لونها أيضًا شريط علامة التبويب وحدود حقولها؛ والرأس الذي يتقاطع صفه أو عموده مع التحديد. وتأخذ بقية الورقة رموزًا مشتركة: foreground لتسميات الرؤوس، وactive لنص الخلايا، وgrayColor7 للخط الذي يفصل رؤوس الأعمدة وأرقام الصفوف عن الخلايا، وfocus لحافة الخلية النشطة، وaccentColor9 لحافة النطاق المحدد ولتعبئته بعتامة 20%، وaccentColor6 لرأس الصف أو العمود المحدد بالكامل، وgrayColor3 للخلايا المخصصة للقراءة فقط، ورموز شريط التمرير. وإذا لم يُكتب accentColor9 بصيغة #rgb أو #rrggbb، يبقى النطاق المحدد دون تعبئة.

متغيرات CSS

لكل رمز في Theme متغير CSS مقابل اسمه --erd-editor- متبوعًا بالمفتاح بصيغة kebab-case: grayColor10 يقابله --erd-editor-gray-color-10، وkeyPK يقابله --erd-editor-key-pk، وkeyPFK يقابله --erd-editor-key-pfk.
تُورَّث هذه المتغيرات إلى داخل المحرر، لذا اضبطها حيثما تريد أن تُطبَّق. فعلى :root تُطبِّق النسق على كل محرر في الصفحة؛ وعلى العنصر نفسه تُطبِّقه على ذلك المحرر وحده.

erd-editor {
  --erd-editor-canvas-background: #1b1b1f;
}

منذ الإصدار 3.4.0، أصبحت الرموز dargSelect ذات الإملاء الخاطئ تُكتب dragSelect، وتغيّرت متغيراتها من --erd-editor-darg-select-background و--erd-editor-darg-select-border إلى --erd-editor-drag-select-background و--erd-editor-drag-select-border. وتُتجاهل ورقة الأنماط التي لا تزال تستخدم الأسماء القديمة.

قيم النسق الافتراضية

:root {
  --erd-editor-gray-color-1: #111113;
  --erd-editor-gray-color-2: #18191b;
  --erd-editor-gray-color-3: #212225;
  --erd-editor-gray-color-4: #272a2d;
  --erd-editor-gray-color-5: #2e3135;
  --erd-editor-gray-color-6: #363a3f;
  --erd-editor-gray-color-7: #43484e;
  --erd-editor-gray-color-8: #5a6169;
  --erd-editor-gray-color-9: #696e77;
  --erd-editor-gray-color-10: #777b84;
  --erd-editor-gray-color-11: #b0b4ba;
  --erd-editor-gray-color-12: #edeef0;
  --erd-editor-accent-color-1: #11131f;
  --erd-editor-accent-color-2: #141726;
  --erd-editor-accent-color-3: #182449;
  --erd-editor-accent-color-4: #1d2e62;
  --erd-editor-accent-color-5: #253974;
  --erd-editor-accent-color-6: #304384;
  --erd-editor-accent-color-7: #3a4f97;
  --erd-editor-accent-color-8: #435db1;
  --erd-editor-accent-color-9: #3e63dd;
  --erd-editor-accent-color-10: #5472e4;
  --erd-editor-accent-color-11: #9eb1ff;
  --erd-editor-accent-color-12: #d6e1ff;
  --erd-editor-canvas-background: #212225;
  --erd-editor-canvas-boundary-background: #111113;
  --erd-editor-table-background: #18191b;
  --erd-editor-table-header-background: #2e3135;
  --erd-editor-table-select: #435db1;
  --erd-editor-table-border: #363a3f;
  --erd-editor-table-shadow: transparent;
  --erd-editor-table-group-header-background: #43484e;
  --erd-editor-table-group-background: #d3edf81d;
  --erd-editor-table-group-border: #43484e;
  --erd-editor-memo-background: #18191b;
  --erd-editor-memo-select: #435db1;
  --erd-editor-memo-border: #363a3f;
  --erd-editor-memo-shadow: transparent;
  --erd-editor-column-select: #182449;
  --erd-editor-column-select-hover: #1d2e62;
  --erd-editor-column-hover: #272a2d;
  --erd-editor-column-handle-background: #18191b;
  --erd-editor-column-handle-border: #363a3f;
  --erd-editor-column-handle-hover-background: #2e3135;
  --erd-editor-column-handle-hover-border: #43484e;
  --erd-editor-relationship-hover: #435db1;
  --erd-editor-visualization-link: #43484e;
  --erd-editor-visualization-column: #5a6169;
  --erd-editor-visualization-relationship: #5a6169;
  --erd-editor-toolbar-background: #111113;
  --erd-editor-context-menu-background: #18191b;
  --erd-editor-context-menu-select: #272a2d;
  --erd-editor-context-menu-hover: #3a4f97;
  --erd-editor-context-menu-border: #363a3f;
  --erd-editor-minimap-border: black;
  --erd-editor-minimap-shadow: black;
  --erd-editor-minimap-viewport-border: #3a4f97;
  --erd-editor-minimap-viewport-border-hover: #435db1;
  --erd-editor-toast-background: #18191b;
  --erd-editor-toast-border: #363a3f;
  --erd-editor-toast-success: #3dd68c;
  --erd-editor-toast-error: #ff9592;
  --erd-editor-find-replace-error: #ff9592;
  --erd-editor-map-columns-error: #ff9592;
  --erd-editor-schema-sql-warning-background: #500f1c;
  --erd-editor-schema-sql-warning-foreground: #ff9592;
  --erd-editor-drag-select-background: #253974;
  --erd-editor-drag-select-border: #435db1;
  --erd-editor-scrollbar-track: #ddeaf814;
  --erd-editor-scrollbar-thumb: #696e77;
  --erd-editor-scrollbar-thumb-hover: #777b84;
  --erd-editor-foreground: #b0b4ba;
  --erd-editor-active: #edeef0;
  --erd-editor-placeholder: #e5edfd7b;
  --erd-editor-focus: #435db1;
  --erd-editor-input-active: #5472e4;
  --erd-editor-key-pk: #ffc53d;
  --erd-editor-key-fk: #e54666;
  --erd-editor-key-pfk: #00a2c7;
  --erd-editor-tree-background: #111113;
  --erd-editor-tree-row-hover: #212225;
  --erd-editor-tree-row-current: #1d2e62;
  --erd-editor-tree-muted: #b0b4ba;
  --erd-editor-tree-match: #253974;
  --erd-editor-explorer-background: #111113;
  --erd-editor-explorer-border: #363a3f;
  --erd-editor-dictionary-error-foreground: #ff9592;
  --erd-editor-dictionary-error-background: #500f1c;
  --erd-editor-dictionary-warning-foreground: #ffca16;
  --erd-editor-dictionary-warning-background: #3f2700;
  --erd-editor-dictionary-background: #18191b;
  --erd-editor-dictionary-header-background: #2e3135;
  --erd-editor-dictionary-grid-line: #363a3f;
  --erd-editor-dictionary-header-select: #182449;
  --erd-editor-diff-insert-foreground: #3dd68c;
  --erd-editor-diff-delete-foreground: #ff9592;
  --erd-editor-diff-modify-foreground: #ffca16;
  --erd-editor-diff-rename-foreground: #70b8ff;
}

لغة العرض

منذ الإصدار 4.0.0، تتوفر نصوص المحرر الخاصة — قوائمه ولوحاته ومربعات الحوار فيه والبحث السريع والإشعارات المنبثقة والكلمات التي يرسمها على المخطط مثل unnamed، بما في ذلك الصور المُصدَّرة — في 25 لغة. ولا تُترجم أبدًا أسماء الجداول والأعمدة ولا SQL ولا أنواع البيانات ولا التعليمات البرمجية المُنشأة. راجع اللغة والنسق.
قبل استدعاء setLocale أو اختيار لغة، يعرض المحرر الإنجليزية، أو يتبع 'system' ما دام enableLocalePicker مفعّلًا.
يضبط المحرر lang وdir على جذره الخاص داخل shadow root المغلق، ولا يضبطهما أبدًا على العنصر المضيف أو الصفحة، لذا لا تقلب الصفحة المكتوبة من اليمين إلى اليسار اتجاه المحرر، ولا تقلب اللغة المكتوبة من اليمين إلى اليسار اتجاه الصفحة. وتعرض العبرية والعربية والفارسية واجهة المحرر من اليمين إلى اليسار؛ أما المخطط نفسه فلا يُعكس أبدًا. منذ الإصدار 4.1.0، يبقى المستكشف على يسار لوحة الرسم في كل اللغات، وتُقرأ صفوفه من اليمين إلى اليسار في هذه اللغات الثلاث.
تُصدِّر الحزمة النوعين LocaleCode (أحد الرموز أدناه) وLocaleOption.

type LocaleOption = LocaleCode | 'system';

الرمز	الاسم المعروض	اللغة
id-ID	Bahasa Indonesia	الإندونيسية
de-DE	Deutsch	الألمانية
en	English	الإنجليزية
es-ES	Español	الإسبانية
eu-ES	Euskara	الباسكية
fr-FR	Français	الفرنسية
it-IT	Italiano	الإيطالية
nl-NL	Nederlands	الهولندية
pl-PL	Polski	البولندية
pt-PT	Português	البرتغالية
pt-BR	Português Brasileiro	البرتغالية البرازيلية
ro-RO	Română	الرومانية
sk-SK	Slovenčina	السلوفاكية
sl-SI	Slovenščina	السلوفينية
sv-SE	Svenska	السويدية
tr-TR	Türkçe	التركية
ru-RU	Русский	الروسية
uk-UA	Українська	الأوكرانية
he-IL	עברית	العبرية
ar-SA	العربية	العربية
fa-IR	فارسی	الفارسية
ja-JP	日本語	اليابانية
zh-CN	简体中文	الصينية المبسطة
zh-TW	繁體中文	الصينية التقليدية
ko-KR	한국어	الكورية

setLocale

يضبط لغة العرض: 'system'، أو أحد الرموز أعلاه. ويُتجاهل أي شيء آخر دون خطأ، مثل 'ko' وحده أو رمز غير معروف أو قيمة ليست سلسلة نصية.
ويُطبَّق قبل أن يُرجع، لذا تظهر اللغة المضبوطة قبل إلحاق العنصر بالصفحة في إطاره الأول.
ولا يُطلِق شيئًا، لا changeLocale ولا change، ولا يمس value ولا سجل التراجع ولا أي مخزن مشترك.
ويبقى الاختيار أيًّا كانت حالة enableLocalePicker، ويتبع setLocale('system') النظام حتى مع تعطيل المنتقي.
لا يخزّن المحرر شيئًا. وللاحتفاظ باختيار القارئ، استمع إلى changeLocale ومرّره مجددًا في التحميل التالي.

editor.enableLocalePicker = true;
editor.setLocale(localStorage.getItem('locale') ?? 'system');
editor.addEventListener('changeLocale', event => {
  localStorage.setItem('locale', event.detail.locale);
});

setSystemLocale

يحدد اللغة التي يمثلها 'system'، كوسم BCP 47، للتطبيق المضيف الذي له لغة عرض خاصة به. وتستدعيه التطبيقات المضيفة VS Code وJetBrains وObsidian بلغة العرض الخاصة بها.
تُزال المسافات من طرفي الوسم. ويؤدي null أو سلسلة نصية فارغة أو قيمة ليست سلسلة نصية إلى العودة إلى navigator.languages في المتصفح، الذي يتبعه المحرر كلما تغيّر.
ولا يكون له أثر إلا ما دام الخيار المطبَّق حاليًا هو 'system'، ويُطبَّق فورًا. ويذكر الصف System في المنتقي اللغة التي يؤول إليها.
يؤول الوسم، أو كل لغة من لغات المتصفح بالترتيب، إلى أول لغة يملكها المحرر، بحسب الوسم الفرعي للغة، مع تجاهل حالة الأحرف والشرطات السفلية: de-AT يعطي de-DE وen-GB يعطي en. وتُحدَّد الصينية بحسب نظام الكتابة، فيعطي Hant القيمة zh-TW ويعطي Hans القيمة zh-CN، وعند غيابه بحسب المنطقة، فيعطي TW وHK وMO القيمة zh-TW وتعطي أي منطقة أخرى zh-CN. ويعطي pt القيمة pt-BR ما لم تُذكر منطقة غير BR. وعندما لا يتطابق شيء، يعرض المحرر الإنجليزية.

editor.setLocale('system');
editor.setSystemLocale('pt-PT'); // null follows the browser again

setSchemaSQL

يحمّل ملف مخطط SQL.
افتراضيًا، يستبدل المستند الحالي بدلًا من الدمج فيه؛ راجع mode أدناه. ويُحتفظ بالإعدادات الموجودة لديك، بما في ذلك كل قفل وقيمته المقفلة، باستثناء موضع العرض ومستوى التكبير، وتُوضع الجداول بعد قراءة الملف، في صفوف ما لم يطلب placement أدناه غير ذلك. ومع قفل Viewport، يكتب value بعد ذلك العرض الذي يبدأ عليه الاستيراد، أي نقطة الأصل 0, 0 عند مستوى التكبير 1. لذا فإن المستند المستورد إلى عنصر لم يُعطَ قيمة قط تكون فيه كل الأقفال مفعّلة، كما هو الحال في المستند الجديد.
منذ الإصدار 4.2.0، يحتفظ الاستبدال أيضًا بكلمات المستند ومصطلحاته ومجالاته، التي لا يمكن أن يحملها النص، مع سجل التراجع الخاص بكل ورقة من أوراق القاموس، ويحتفظ بها أيضًا التراجع عن الاستيراد أو إعادته. أما setSchemaJSON بالاستبدال وإسناد قيمة إلى value فيأخذان بدلًا من ذلك ما يحمله مستندهما منها.
ويُسجَّل في قائمة السجل، ما يتيح Undo, Redo، ويُطلِق change. وتُتجاهل السلسلة النصية الفارغة، ولا يفعل الاستدعاء شيئًا أثناء ضبط readonly.
ويتصرف setSchemaGraphQL وsetSchemaDBML وsetSchemaAML بالطريقة نفسها، ولا تفشل محللاتها أبدًا: فالنص الذي لا تستطيع قراءته يحمّل مستندًا فارغًا بدلًا من رمي خطأ.
منذ الإصدار 4.0.0، تقبل الدوال الأربع كلها وسيطة ثانية اختيارية، { placement, mode }:

• placement: 'grid'، وهو الافتراضي، يضع الجداول في صفوف فورًا، كما في السابق، ولا يُرجع الاستدعاء شيئًا.
• placement: 'auto' يرتّب الجداول أولًا بحسب علاقاتها، كما يفعل Import في المحرر، ويُرجع Promise يكتمل بعد أن يستقر الاستيراد كخطوة تراجع واحدة. ووجود أقل من جدولين، أو عدم وجود أي علاقة، أو فشل التخطيط، أو صفحة دون SharedWorker، أو Cancel في الإشعار المنبثق Placing tables، يضع الجداول في صفوف بدلًا من ذلك. وأي تحميل في هذه الأثناء — استيراد آخر بالاستبدال، أو إسناد قيمة إلى value، أو setInitialValue()، أو منذ الإصدار 5.1.0 reseed في مخزن مشترك، أو clear()، أو تحميل من متعاون، أو تراجع عن تحميل أو عن clear() أو إعادتهما — يحل محله، ويكتمل Promise دون تحميل أي شيء. وتستقر عمليات الاستيراد الموضوعة بهذه الطريقة بالترتيب الذي بدأت به.
• mode: 'replace'، وهو الافتراضي، يستبدل المستند. أما mode: 'append' فيضيف الملف أسفل المخطط كما يفعل استيراد وإضافة، تاركًا كل جدول موجود كما هو، وكل إعداد باستثناء علامة التبويب وموضع العرض. ومن علامة تبويب أخرى، تظهر علامة تبويب ERD أولًا. وتصبح الجداول الجديدة، ومجموعات الجداول التي يجلبها ملف DBML ما دامت مجموعات الجداول معروضة، هي التحديد، ويُمرَّر العرض إليها ما لم تكن ظاهرة جيدًا بالفعل، وفق القاعدة التي يتبعها كل انتقال منذ الإصدار 4.1.0، راجع أين يستقر الانتقال. ويزيل تراجع واحد الإضافة كلها. والنص الذي لا يستطيع قراءته لا يضيف شيئًا ويترك المستند كما هو.

أثناء ضبط readonly، يُتجاهل الاستبدال، ولا يضيف الإلحاق شيئًا، ويكتمل استدعاء placement: 'auto' فورًا.
منذ الإصدار 3.10.0، يقرأ setSchemaSQL الملف وفق قاعدة البيانات الحالية للمستند: فعند اختيار Databricks، تتبع السلاسل النصية المحاطة بعلامات اقتباس مفردة قواعد التهريب بالشرطة المائلة العكسية في Spark. راجع التعليقات.
منذ الإصدار 3.10.0، يقرأ setSchemaSQL قيد UNIQUE على عمودين أو أكثر كفهرس فريد واحد بدلًا من علامة فريد على كل عمود. راجع المفاتيح الفريدة والفهارس.
منذ الإصدار 3.10.0، تحتفظ عمليات استيراد SQL وDBML وAML بإجراءات ON DELETE وON UPDATE للمفاتيح الخارجية التي تقرؤها.
منذ الإصدار 4.0.0، يحتفظ setSchemaSQL بتعبير DEFAULT الكامل للعمود، ويقرأ ADD DEFAULT … FOR وتعليقات MS_Description في SQL Server، ويحوّل أعمدة serial وidentity في PostgreSQL إلى تزايد تلقائي، ويُبقي على UNSIGNED وZEROFILL في نوع البيانات، ويقرأ المفتاح الأساسي الذي يصفه ALTER TABLE … ADD PRIMARY KEY على أنه CLUSTERED أو NONCLUSTERED أو USING BTREE. راجع مخطط SQL.
لمعرفة الصيغة التي يقبلها كل محلل، راجع استيراد الملفات وتصديرها.

type SetSchema = {
  (
    value: string,
    options: { placement: 'auto'; mode?: 'replace' | 'append' }
  ): Promise<void>;
  (
    value: string,
    options?: { placement?: 'grid'; mode?: 'replace' | 'append' }
  ): void;
};

// example
editor.setSchemaSQL('Schema SQL...');
// or
await editor.setSchemaSQL('Schema SQL...', { placement: 'auto' });
// or
editor.setSchemaSQL('Schema SQL...', { mode: 'append' });

setSchemaGraphQL

يحمّل مستند GraphQL SDL.
تصبح تعريفات أنواع الكائنات جداول، ويصبح الحقل الذي يكون نوعه جدولًا آخر علاقة.

editor.setSchemaGraphQL('GraphQL SDL...');

setSchemaDBML

يحمّل ملف DBML، وهو التنسيق الذي يستخدمه dbdiagram.io وdbdocs.
منذ الإصدار 4.0.0، يصبح كل TableGroup مجموعة جداول، ويصبح headercolor الخاص بالجدول لونَه. راجع DBML.

editor.setSchemaDBML('DBML...');

setSchemaAML

يحمّل ملف AML (Azimutt Markup Language). وتُقبل الصيغة الحالية والصيغة القديمة v1 كلتاهما.
منذ الإصدار 4.0.0، يصبح لون الكيان، وهو أحد أسماء الألوان في Azimutt أو قيمة ست عشرية بين علامتي اقتباس، لونَ جدوله. راجع AML.

editor.setSchemaAML('AML...');

setSchemaJSON

منذ الإصدار 4.0.0، يحمّل مستند .erd.json، مثل النص الذي يُرجعه value.
في وضعه الافتراضي mode: 'replace'، يحمّل المستند كما يفعل إسناد قيمة إلى value: يُسجَّل في قائمة السجل، ويُطلِق change، ويأخذ أقفال المستند بالطريقة نفسها، ومنذ الإصدار 4.2.0 تحل كلمات المستند ومصطلحاته ومجالاته محل ما في المحرر منها. وعلى عكس value، تُتجاهل السلسلة النصية الفارغة أو القيمة التي ليست سلسلة نصية بدلًا من بدء مستند جديد. والنص الذي ليس JSON يُفرّغ المستند، كما يحدث مع value.
أما mode: 'append' فيضيف جداول المستند وعلاقاته وفهارسه وملاحظاته ومجموعات جداوله أسفل المخطط بمعرّفات جديدة، مع الحفاظ على مواضعها بعضها بالنسبة إلى بعض واستبعاد إعدادات المستند، كما يفعل استيراد وإضافة مع ملف json. ومنذ الإصدار 4.2.0، يحتفظ بالأسماء المنطقية للجداول والأعمدة وعلامات الأسماء المشتقة فيها، لكنه يترك كلمات المستند ومصطلحاته ومجالاته، لذا لا يرتبط أي عمود من أعمدته بمجال. والنص الذي لا يستطيع قراءته، أو المستند الذي لا يحتوي على أي جدول ولا ملاحظة، لا يضيف شيئًا. وفيما عدا ذلك، يستقر كما يستقر الإلحاق في setSchemaSQL، مع تحديد ملاحظاته ومجموعات جداوله الجديدة مع جداوله، كل نوع ما دام معروضًا.
ويعود بعد أن يستقر المستند، ويُتجاهل أثناء ضبط readonly.

editor.setSchemaJSON('json...');
// or
editor.setSchemaJSON('json...', { mode: 'append' });

getSchemaSQL

يصدّر حالة المحرر الحالية كمخطط SQL.
إذا لم يُحدَّد databaseVendor، يكتب لقاعدة البيانات التي يعرضها المحرر: قاعدة بيانات المستند، ما لم يكن قارئ محرر للقراءة فقط قد اختار غيرها، وهو ما يبقى منذ الإصدار 5.0.0 على تلك الشاشة وتعرضه علامة تبويب مخطط SQL فيه. ويُعامل الاسم غير الموجود في القائمة أدناه بالطريقة نفسها، دون رمي خطأ.
تُحاط الأسماء بنوع علامات الاقتباس الذي يعرضه المحرر. وما دام Bracket Type مقفلًا، أو في محرر للقراءة فقط اختار قارئه نوعًا آخر منذ الإصدار 5.0.0، قد يختلف ذلك عن النوع الذي يحفظه value، وهو النوع الذي تستخدمه الأداة erd_read لدى وكيل البرمجة لإحاطة الأسماء. والأسماء المكتوبة هي دائمًا الأسماء المادية، أيًّا كان عرض الأسماء.
منذ الإصدار 4.0.0، تختار وسيطة options الاختيارية العبارات والترويسة، كما تفعل خيارات علامة تبويب مخطط SQL، ومنذ الإصدار 4.2.0 ما إذا كانت الأسماء المنطقية تملأ التعليقات الفارغة. ويُصدَّر SchemaSQLOptions كنوع.

• statements: 'create'، وهو الافتراضي؛ أو 'ifNotExists'، الذي يكتب IF NOT EXISTS في MySQL وMariaDB وPostgreSQL وSQLite وDatabricks ويعود إلى 'create' في غيرها؛ أو 'recreate'، الذي يحذف الجداول قبل إنشائها، بينما يكتب Snowflake CREATE OR REPLACE TABLE بدلًا من ذلك.
• header: 'none'، وهو الافتراضي؛ أو 'use'، الذي ينتقل إلى قاعدة بيانات المستند أو مخطط قاعدة البيانات الخاص به؛ أو 'createAndUse'، الذي ينشئها أولًا إن لم تكن موجودة ثم ينتقل إليها. وقاعدة البيانات التي لا تدعم الخيار المطلوب تعود إلى بديل كما تفعل علامة التبويب: يكتب Oracle 'use' بدلًا من 'createAndUse'، ولا يكتب PostgreSQL أي ترويسة مع 'use'، ولا يكتب SQLite أي ترويسة. ولا تُكتب الترويسة إلا ما دام اسم قاعدة بيانات المستند معرّفًا بسيطًا — أحرف ASCII وأرقام و_، ولا يبدأ برقم.
• logicalNameAsComment، منذ الإصدار 4.2.0: يكتب true الاسم المنطقي للجدول أو العمود كتعليق له حيثما كان تعليقه الخاص فارغًا أو لا يحوي إلا مسافات ولم يكن الاسم المنطقي كذلك، بالصيغة التي تكتب بها قاعدة البيانات تلك التعليق. ويُكتب التعليق الذي يحوي نصًا كما في السابق. ولا يفعّله إلا true: فعند حذفه، أو مع false، أو مع أي قيمة أخرى، مثل 'true' أو 1، لا يُكتب أي اسم منطقي. ويؤدي ما يؤديه مفتاح التبديل Write logical names into empty comments في علامة التبويب.

والخيار غير المذكور، أو الخيار ذو القيمة غير المعروفة، يُقرأ بقيمته الافتراضية، لذا يكتب الاستدعاء دون خيارات عبارات CREATE عادية دون ترويسة، كما في السابق.
منذ الإصدار 4.0.0، تتضمن المخرجات دائمًا سكربتي Before tables وAfter tables للمستند، بالترتيب التالي: الترويسة، والسكربت السابق، وعبارات الحذف، والجداول، والسكربت اللاحق. ولا تؤثر خيارات Statements وHeader وWrite logical names into empty comments وTables الخاصة بعلامة تبويب مخطط SQL أبدًا في هذا الاستدعاء، الذي يكتب المستند كاملًا دائمًا.
منذ الإصدار 3.10.0، يحمل كل مفتاح خارجي بندَي ON DELETE وON UPDATE الخاصين بالعلاقة. ولا يُكتب البند إلا عندما يكون إجراؤه مضبوطًا ويقبله نظام قاعدة البيانات، لذا يُستبعد الإجراء الذي لا يقبله ذلك النظام وتُطبَّق قيمته الافتراضية. منذ الإصدار 4.0.0، لا يقبل Snowflake إلا NO ACTION. لمعرفة ما تكتبه كل قاعدة بيانات، راجع ON DELETE وON UPDATE.
منذ الإصدار 3.10.0، تُهرَّب علامة الاقتباس المفردة داخل تعليق الجدول أو العمود، لذا لم يعد تعليق مثل it's يكسر العبارة. وكل نظام قاعدة بيانات يكتب التعليقات كسلاسل نصية حرفية يضاعفها، باستثناء Databricks، الذي يضع شرطة مائلة عكسية قبل كل علامة اقتباس وكل شرطة مائلة عكسية. ولا يزال SQLite يكتب التعليقات كأسطر --.
منذ الإصدار 4.2.0، يكتب SQL Server كل تعليق كسلسلة نصية حرفية وطنية، N'…'، فيُحفظ النص الواقع خارج صفحة الترميز لقاعدة البيانات، مثل النص الكوري. ويكتب Oracle كل سلسلة متتالية من الأسطر الفارغة في التعليق كفاصل أسطر واحد، ويكتب SQLite فواصل الأسطر في التعليق كمسافات، فيبقى التعليق على سطر -- الخاص به. راجع التعليقات.
منذ الإصدار 4.0.0، تكتب عدة قواعد بيانات أيضًا أسماء المفاتيح والقيم الافتراضية والتزايد التلقائي بشكل مختلف. راجع ما يُكتب في DDL.

type DatabaseVendor =
  | 'Databricks'
  | 'MariaDB'
  | 'MSSQL'
  | 'MySQL'
  | 'Oracle'
  | 'PostgreSQL'
  | 'Snowflake'
  | 'SQLite';

type SchemaSQLOptions = {
  statements?: 'create' | 'ifNotExists' | 'recreate';
  header?: 'none' | 'use' | 'createAndUse';
  logicalNameAsComment?: boolean;
};

const schemaSQL = editor.getSchemaSQL();
// or
const postgresSQL = editor.getSchemaSQL('PostgreSQL');
// or
const mysqlSQL = editor.getSchemaSQL('MySQL', {
  statements: 'ifNotExists',
  header: 'createAndUse',
});
// or
const commentedSQL = editor.getSchemaSQL('PostgreSQL', {
  logicalNameAsComment: true,
});

getSharedStore

يُرجع مخزنًا للتحرير التعاوني في الوقت الفعلي.
قيمة config هي { getNickname?, mouseTracker?, focusTracker? }. القيمة الافتراضية للمتتبعين كليهما true: يبث mouseTracker مؤشر الماوس في هذا المحرر إلى الآخرين، ويبث focusTracker الخلية التي عليها التركيز والتحديد ومربع التحديد بالسحب.
ومنذ الإصدار 5.0.0 لا يرسل المخزن أي تغيير ما دام readonly مضبوطًا، بل ما ترسله أدوات التتبع والسجلات التي يطلبها المحرر المنضم فقط، ولا يزال يطبّق ما ترسله المحررات الأخرى.
ومنذ الإصدار 5.1.0، يسلّم أيضًا مسجّلات التعاون في المحرر ورقم نسخة ساعته (getLWW، getVersion)، ويأخذ مسجّلات مخزن آخر (mergeLWW)، وينسى مؤشر متعاون غادر وتركيزه وتحديده ومربع سحبه (forgetPeer)، ويعيد فتح مستند الجلسة مع المسجّلات المحفوظة إلى جانبه (reseed). ويعتمد @dineug/erd-editor-yjs على هذه الدوال لإبقاء العنصر متزامنًا مع مستند Yjs.
ومنذ الإصدار 5.1.0، ينتهي مستخدمان يغيّران اسمًا واحدًا أو حقلًا واحدًا، أو ينقلان جدولًا واحدًا، أو ينقلان ملاحظة واحدة أو مجموعة جداول واحدة أو يغيّران حجمها، في اللحظة نفسها، إلى النتيجة نفسها على كل محرر ونسخة متماثلة من الإصدار 5.1.0 أو أحدث، ويُرسَل السحب أو تحريك العرض أو التكبير بوصفه الموضع الذي ينتهي إليه.
واللون، والعمود المنقول داخل جدوله أو فهرسه، وبضعة إعدادات مثل قاعدة البيانات، هي الاستثناءات، التي لا يزال كل محرر ونسخة متماثلة يأخذها بالترتيب الذي يتلقاها به. راجع التعديلات المتزامنة.
راجع التحرير التعاوني.

const sharedStore = editor.getSharedStore({
  mouseTracker: false,
  focusTracker: false,
});

setDiffValue

يفتح عارض الفروق، مقارنًا المستند المفتوح حاليًا بالمستند الذي تمرره.
لا يُرجع شيئًا ولا يعدّل المستند، لذا يترك إغلاق العارض المحرر كما كان تمامًا.
وتُقارن القيمة الفارغة، أو أي شيء ليس سلسلة نصية، بمستند فارغ.
وهو الطبقة نفسها التي يفتحها عنصر عارض الفروق في قائمة السياق للوحة الرسم.
منذ الإصدار 4.1.0، يطابق بين محتويات المستندين بحسب المعرّف أولًا، ثم بحسب ما يحتفظ به كل منهما فقط بعد ذلك، مثل اسم الجدول أو نص الملاحظة، راجع ما تجري مقارنته. لذا عند المقارنة بنسخة سابقة من المستند نفسه، مثل مراجعة Git لملفه، تظهر إعادة التسمية كعنصر واحد معاد تسميته؛ وعند المقارنة بمستند معرّفاته مختلفة، تظهر كإزالة وإضافة. ويعرض العارض ما تغيّر في شجرة بجانب المستندين، ويعلّم التغييرات بالألوان بدلًا من ملء الخلايا.
منذ الإصدار 4.2.0، يُفتح المستندان كلاهما بعرض الأسماء الذي يعرضه هذا المحرر، أيًّا كان ما حفظه المستند المُمرَّر، وتسمّي الشجرة الجداول والأعمدة وفقه أيضًا، راجع خارج لوحة الرسم. ولا تُقارن الأسماء المنطقية وروابط المجالات والقواميس، لذا فإن التغيير فيها وحدها لا يُظهر أي تغيير.

editor.setDiffValue('prev json...');