Ana içeriğe geç

Ortak düzenleme

getSharedStore() yöntemi bir düzenleyiciyi ortak düzenleme oturumunda bir düğüme dönüştürür.
Her değişikliği bir eylem akışı olarak yayımlar ve diğer düzenleyicilerin geri gönderdiği eylemleri uygular – aradaki taşıma katmanını (WebSocket, WebRTC ya da JSON taşıyabilen başka herhangi bir şey) siz sağlarsınız.
ErdEditorElement yöntemlerinden biridir ve aktarılan değişikliklerin ayrıca depolanması gerektiğinde Uzak depolama ile birlikte kullanılır.

interface ErdEditorElement extends HTMLElement {
  // ...
  getSharedStore: (
    config?: SharedStoreConfig & {
      mouseTracker?: boolean;
      focusTracker?: boolean;
    }
  ) => SharedStore;
}

type SharedStoreConfig = {
  getNickname?: () => string;
};

type SharedStore = {
  connection: () => void;
  disconnect: () => void;
  dispatch: (actions: Array<AnyAction> | AnyAction) => void;
  dispatchSync: (actions: Array<AnyAction> | AnyAction) => void;
  subscribe: (fn: (value: AnyAction[]) => void) => Unsubscribe;
  flushStreamBuffers: () => void;
  destroy: () => void;
};

// example
const sharedStore = editor.getSharedStore();

Eylem, belgedeki tek bir değişikliği tanımlayan serileştirilebilir düz bir nesne olduğundan taşıma katmanına giderken JSON.stringify çağrısından bozulmadan geçer.
Eylemler paketler hâlinde gelir: subscribe yöntemi bir dizi verir ve bu dizi tek bir birimdir – onu bütün olarak aktarın ve karşı tarafta da bütün olarak dispatch yöntemine verin.
Eylemi okumak ya da yeniden yazmak yerine içine bakılmayan bir değer olarak ele alın ve olduğu gibi iletin, çünkü düzenleyicilerin eşitlenmiş kalmasını sağlayan şey eylemin taşıdığı iç kayıtlardır.

Bir düzenleyicide yapılanların bir kısmı o düzenleyicide kalır.
Bir tabloyu, notu veya tablo grubunu öne getirme işlemi gönderilmez; bunlardan birini seçmek de onu öne getirir.
Şema SQL sekmesindeki Statements, Header ve Tables seçimleri de yapıldıkları pencereye ait oldukları için gönderilmez.
4.1.0 sürümünden itibaren Gezgin de kendi düzenleyicisinde kalır: Açık olup olmadığı, genişliği, daraltılmış satırları, klavye odağının bulunduğu satır, ağacının kaydırma konumu, araması ve seçenekleri gönderilmez.
Bir yabancı anahtara gidildiğinde ilişkisinin bağlantı çizgisine uygulanan vurgu da gönderilmez.
Kaydırma, yakınlaştırma veya sekme geçişi gönderilir, ancak hiçbir zaman başka bir kullanıcının görünümünü ya da sekmesini değiştirmez. Gezginden yapılan bir atlamanın oluşturduğu kaydırma ve Gezgin başka bir sekmeden açıldığında ERD sekmesine yapılan geçiş de buna dahildir.

Kilitler paylaşılır: Bir ayarın en son kilitlenmesi ya da kilidinin açılması her düzenleyicide geçerli olur ve kilit, onu etkinleştiren düzenleyicinin değerlerini taşır, böylece her düzenleyici ve replika aynı değeri kaydeder.
Bu nedenle Viewport kilidi onu etkinleştiren düzenleyicinin görünümünü, Canvas Type kilidi ise o düzenleyicinin, kilitlerin etkinleştirildiği Ayarlar sekmesinden önce bulunduğu son sekmeyi kaydeder.
Language, Table Name Case, Column Name Case veya Bracket Type kilidini devre dışı bırakmak, her düzenleyicideki o ayarı da kilidi devre dışı bırakan düzenleyicide gösterilen değere getirir, böylece tümü tek bir değeri kaydetmeye devam eder. Viewport veya Canvas Type kilidini devre dışı bırakmak kimsenin görünümünü ya da sekmesini değiştirmez.

Before tables veya After tables betiğinde yapılan bir düzenleme, betiğin alanı odaktan çıktığında bütün olarak gönderilir. İki betik ayrı ayrı çözümlenir, bu yüzden bir ortak çalışanın birinde yaptığı düzenleme asla diğerinin üzerine yazmaz.

Görselleştirme sekmesinin Akış modunda yapılan hiçbir şey belge değişikliği değildir, bu yüzden Akış modundaki bir düzenleyici diğerlerine hiçbir değişiklik göndermez ve diğerlerinin gönderdiği değişiklikler o Akış modundayken de uygulanmaya devam eder.
Tek istisna Akış modundan başka bir sekmeye geçmektir: Bu sekme geçişi de diğerleri gibi gönderilir.
Dış bağlantı kart düğmesi, #, @ veya : önekinden sonra seçilen bir Hızlı arama sonucu ve Gezginin açılması, düzenleyiciyi Akış modundan ERD sekmesine geçirir. Kart düğmesinin ya da bir Hızlı arama sonucunun orada yaptığı kaydırma da gönderilir.

Tek sayfada iki düzenleyici​

Buradaki subscribe ile dispatch arasındaki bağlantı ağın yerini tutar, böylece araya bir taşıma katmanı girmeden bir oturumun yapısını görebilirsiniz.

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

const sharedStore1 = editor1.getSharedStore({
  getNickname: () => 'editor1',
});
const sharedStore2 = editor2.getSharedStore({
  getNickname: () => 'editor2',
});

sharedStore1.subscribe(actions => {
  sharedStore2.dispatch(actions);
});

sharedStore2.subscribe(actions => {
  sharedStore1.dispatch(actions);
});

Buradaki iki düzenleyici de aynı yeni, boş belgeyle başlar, bu yüzden hiçbirinin ilk içerikle başlatılması gerekmez.
Üç veya daha fazla düzenleyici olduğunda her birinin paketlerini diğerlerinin hepsine gönderin: Bir düzenleyici aldığını asla başkasına iletmez.

Ortak çalışanı başlatma​

Paylaşılan depo değişiklikleri yapıldıkları anda aktarır ve katılan bir düzenleyiciye belgenin o anki hâlini asla vermez, bu yüzden hâlihazırda süren bir oturuma katılan bir düzenleyiciye önce belgenin verilmesi gerekir.
4.0.0 sürümünden itibaren onu value değeriyle ya da kaydedilmiş dosyayla değil, oturumda zaten bulunan bir düzenleyicinin runtimeValue değeriyle başlatın.

editor2.setInitialValue(editor1.runtimeValue);

const sharedStore2 = editor2.getSharedStore();

Çalışma zamanı değeri, belge açıldığından beri kaldırılanları hâlâ tutar, bu yüzden başka bir düzenleyici daha sonra bir kaldırmayı geri aldığında, katılan düzenleyici tabloyu adı ve sütunlarıyla geri getirir.
value değeri, bir dosyada saklanan ve kaldırılmış varlıkları içermeyen biçimdir, bu yüzden katılan bir düzenleyici bu değerle ya da dosyayla başlatılırsa bunun yerine boş, adsız bir tablo geri getirirdi.
Depolamaya value değerini yazmaya devam edin: runtimeValue değeri yalnızca başka bir düzenleyiciyi, ikinci bir görünümü veya bir replicationStore deposunu başlatmak içindir.
VS Code'daki, Obsidian'daki, bir JetBrains IDE'sindeki ve web uygulamasındaki düzenleyiciler, açık bir belgenin ikinci görünümünü bu şekilde başlatır.

setInitialValue çağrısı aktarılmaz, bu yüzden katılan düzenleyiciyi başlatmak diğerlerinde hiçbir şeyi değiştirmez.
4.0.0 sürümünden itibaren bu çağrı, düzenleyicinin eşzamanlı düzenlemeleri çözümleyen ortak çalışma kayıtlarını da atar. Düzenleyicinin paylaşılan deposunun daha önce bir abonesi olduysa depo, ilk subscribe çağrısında olduğu gibi diğer düzenleyicilerden onların kayıtlarını yeniden ister, böylece oturumun ortasında yeniden yüklenen bir düzenleyici düzenlemeleri diğerleriyle aynı şekilde çözümler.
value özelliğine atama yapmak kayıtları korur, ancak setInitialValue çağrısının aksine aktarılır: Düzenleyicinin bir paylaşılan deposu olduğu andan itibaren oturumdaki her düzenleyici atanan belgeyi yükler, bu yüzden katılan bir düzenleyiciyi asla bu şekilde başlatmayın.

Sürümleri karıştırma​

Bir düzenleyici yalnızca kendi sürümünün bildiği eylem türlerini uygular, bu yüzden farklı sürümlerin bir arada bulunduğu bir oturumda eski düzenleyiciler daha yeni bir türle taşınan her şeyi kaçırır.

3.10.0 sürümünden itibaren bir ilişkinin ON DELETE veya ON UPDATE ayarında yapılan bir değişiklik, iki yeni eylem türünden biri olan relationship.changeOnDelete ya da relationship.changeOnUpdate olarak taşınır ve relationship.add eylemi ikisini de taşıyabilir. Eylemleri olduğu gibi ileten bir aktarıcı bunlar için yeni hiçbir şeye ihtiyaç duymaz.
3.10.0 sürümünden önceki bir düzenleyici bu eylem türlerini ve alanları yok sayar: Bir ilişkinin ON DELETE veya ON UPDATE değerini asla öğrenmez ve böyle bir düzenleyiciden kaydedilen belgede ikisi de bulunmaz. Eski bir düzenleyicinin eklediği ilişki bunlar olmadan gelir, bu yüzden ikisi de Not set değeriyle başlar.

3.10.0 sürümlü bir düzenleyicinin gönderdiği diğer tüm değişiklikler, eski düzenleyicilerin zaten bildiği eylem türleriyle taşınır.
Bul ve değiştir içindeki Replace All düğmesi, düzenlemelerini elle yapılan bir düzenlemenin gönderdiği yeniden adlandırma, açıklama ve not eylemlerinin aynısından oluşan tek bir paket olarak gönderir. Alternate Key ve Referential Actions görünüm seçenekleri mevcut settings.changeShow eylemiyle taşınır.

4.0.0 sürümünden itibaren şu değişiklikler yeni eylem türleriyle taşınır ve eylemleri olduğu gibi ileten bir aktarıcı bunlar için yeni hiçbir şeye ihtiyaç duymaz:

  • eklenen, taşınan, yeniden boyutlandırılan, yeniden adlandırılan, rengi değiştirilen veya kaldırılan bir tablo grubu: tableGroup.add, tableGroup.move, tableGroup.moveTo, tableGroup.resize, tableGroup.changeName, tableGroup.changeColor ve tableGroup.remove; bir tablonun gruba katılması veya gruptan ayrılması: table.changeGroup;
  • var olan bir ilişkide Sütunları eşle iletişim kutusunda yapılan ve ilişkinin iki sütun listesini aynı anda ayarlayan Save işlemi: relationship.changeColumns;
  • bir kilidin etkinleştirilmesi veya devre dışı bırakılması: settings.changeLockSettings;
  • Şema SQL sekmesindeki Before tables veya After tables betiğinde yapılan bir düzenleme: settings.changeDDLScript.

Table Groups ve Memos görünüm seçenekleri mevcut settings.changeShow eylemiyle taşınır.
Kilitler yerlerini almadan önce Save Scroll Information ve Save Zoom Information anahtarlarının gönderdiği settings.changeIgnoreSaveSettings eylemi artık gönderilmez ve settings.changeRelationshipOptimization eylemi kaldırılmıştır. Bunlardan birini alan 4.0.0 sürümlü bir düzenleyici hiçbir şeyi değiştirmez.

4.0.0 sürümünden önceki bir düzenleyici yeni eylem türlerini yok sayar: Bir tablo grubunu ya da hangi tabloların grupta olduğunu asla görmez, yine de grup sürükleme tabloların table.move eylemlerini de gönderdiği için grubun tabloları orada da taşınır.
“Sütunları eşle” iletişim kutusundaki Save işleminden sonra ilişkinin eski sütunlarını korur ve o eski eşlemenin bir sütunu bu düzenleyicide kaldırıldığında ilişki her düzenleyiciden kaybolur. Bu düzenleyicide kilit de betik de yoktur.
Böyle bir düzenleyiciden kaydedilen belgede bunların hiçbiri bulunmaz ve 4.0.0 sürümlü bir düzenleyici bu belgeyi tüm ayarlar kilitli hâlde açar.
Bir oturumdaki her düzenleyiciyi ve oturumun belgesini depolayan her replicationStore deposunu 4.0.0 veya sonraki bir sürümde tutun.

4.1.0 sürümlü bir düzenleyici yeni bir eylem türü göndermez, bu yüzden 4.0.0 ve 4.1.0 sürümlü düzenleyiciler ve replikalar hiçbir şey kaçırmadan aynı oturumu paylaşır.
Bu sürümde Bul ve değiştir dizin adlarında ve tablo grubu adlarında da arama yapar, Replace ve Replace All düğmeleri de bunları 4.0.0 sürümlü bir düzenleyicinin zaten uyguladığı index.changeName ve tableGroup.changeName eylemleriyle yeniden adlandırır.

SharedStoreConfig​

getNickname​

Diğer düzenleyicilerde bu kullanıcının fare imlecinin yanında gösterilen takma adı belirler.
Takma ad yoksa veya boşsa diğer kullanıcılar user adını görür.

editor.getSharedStore({
  getNickname: () => 'nickname...',
});

mouseTracker​

Bu kullanıcının fare imlecini diğer düzenleyicilere yayınlar. Varsayılan olarak true değerini alır.
Diğer kullanıcıların gönderdiği imleçler ERD tuvalinde her zaman gösterilir.

editor.getSharedStore({ mouseTracker: false });

focusTracker​

Bu kullanıcının üzerinde çalıştığı şeyi yayınlar. Varsayılan olarak true değerini alır.
Odakladığınız tablo ve hücre, seçtiğiniz tablolar, notlar ve tablo grupları ile tuvalde sürüklediğiniz kutu diğer düzenleyicilere gönderilir ve orada çizilir.
Onları birbirinden ayırt edebilmeniz için her kullanıcıya kendine ait bir renk verilir: odaktaki tabloda bir dış çizgi, odaktaki hücrede bir alt çizgi, seçili tabloların, notların ve tablo gruplarının çevresinde bir halka ve sürükleme kutusu için kesikli bir dikdörtgen.
Diğer kullanıcılardan gelen anlık durum bilgisi, bu seçenek açık olsun ya da olmasın, tuvalinizde her zaman çizilir.
Görselleştirme sekmesinin Akış modunda diğer kullanıcıların odağı ve seçimi tablo kartlarında çizilir, ancak sürükleme kutuları çizilmez. Orada seçtiğiniz tablolar yine de gönderilir, orada sürüklediğiniz kutu ise gönderilmez.

editor.getSharedStore({ focusTracker: false });

Paylaşılan depoyu, kendi anlık durum bilgisini yayımlamayan düz bir aktarıcı olarak kullanmak için iki izleyiciyi de kapatın.
Diğer düzenleyicilerin gönderdiği anlık durum bilgisi yine de alınır ve çizilir.
VS Code'daki, Obsidian'daki, bir JetBrains IDE'sindeki ve Google Drive'daki düzenleyiciler de bunu yapar.

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

İmleç, odak, seçim ve sürükleme kutusu belge değişiklikleriyle aynı akışta taşınır, ancak bunlar geçicidir.
Belgeye, geri alma geçmişine ya da editor.value değerine asla girmezler, bu yüzden taşıma katmanı bunları dilediği gibi atabilir ve bir replicationStore bunları yok sayar.

SharedStore​

connection, disconnect​

Bu yöntemler geçerli bağlantı durumunu ayarlar.
Bağlantı kesikken değişiklikler dahili olarak arabelleğe alınır.
Arabelleğe alınan değişiklikler, iletim yeniden mümkün olduğunda abonelere yayımlanır.
Varsayılan durum bağlıdır (connection).

sharedStore.connection();
sharedStore.disconnect();

dispatch, dispatchSync​

Diğer düzenleyici örneklerinden gelen değişiklikleri geçerli düzenleyici örneğine uygular.

sharedStore.dispatch(actions); // async
sharedStore.dispatchSync(actions); // sync

subscribe​

Düzenleyicideki değişikliklere abone olur.
En az bir abone olana kadar düzenleyiciden hiçbir şey çıkmaz ve o zamana kadar yapılan değişiklikler arabelleğe alınır.
İlk subscribe çağrısı ayrıca diğer düzenleyicilerden, eşzamanlı düzenlemeleri çözümleyen ortak çalışma kayıtlarını ister, böylece sonradan katılan bir düzenleyici bu düzenlemeleri aynı şekilde çözümler.
Belgeyi getirmez, bu yüzden sonradan katılan bir düzenleyiciyi önce ilk içerikle başlatın.
4.0.0 sürümünden itibaren depo, bu ilk subscribe çağrısından sonra setInitialValue yöntemi düzenleyicisine her belge yüklediğinde kayıtları yeniden ister.

const unsubscribe = sharedStore.subscribe(actions => {
  // send...
});

flushStreamBuffers​

Bu deponun hâlâ bekletmekte olduğu akış paketlerini, sessiz sürelerinin bitmesini beklemeden hemen gönderir.
3.9.2 sürümünden itibaren getSharedStore yönteminden alınan bir depoda çalışır. 3.9.1 sürümünde yöntem türde bulunur ancak hiçbir şey yapmaz.
Bir tabloyu, notu veya tablo grubunu taşıma, rengini değiştirme, bir notu yeniden boyutlandırma ve görünümü kaydırma ya da yakınlaştırma işlemlerinin her biri küçük değişikliklerden oluşan bir akış olarak gelir. Bir tablo grubunu yeniden boyutlandırma ise böyle gelmez: Sürükleme bittiğinde tek seferde gönderilir.
Depo her akışı tek bir pakette toplar ve akış 200 ms boyunca sessiz kalana kadar bekletir. Bunu iki aşamada yaptığı için paket, son değişiklikten yaklaşık 400 ms sonra gönderilir.
Bir çağrı bu beklemeyi iki aşamada da sonlandırır. Depo bağlıyken abone, paketi çağrı dönmeden önce alır. Bekletilen bir şey yokken yapılan çağrı hiçbir şey göndermez.
İster deponun kendisine ister düzenleyiciye ait olsun, destroy yöntemi hâlâ bekletilen bir paketi atar, bu yüzden bir sekme kapanırken olduğu gibi, bir depoyu bırakırken diğerlerinin son değişikliği koruması gerekiyorsa önce bu yöntemi çağırın.

sharedStore.flushStreamBuffers();
sharedStore.destroy();

destroy​

sharedStore örneğini tamamen yok eder.
Düzenleyicinin kendisine dokunulmaz, bu yüzden bir oturumdan ayrılmak belgeyi düzenlenebilir bırakır.
Fare ve odak izleyicileri, düzenleyicinin verdiği son sharedStore yok edildiğinde durur.
Deponun hâlâ bekletmekte olduğu bir akış paketi de onunla birlikte atılır. Göndermek için önce flushStreamBuffers yöntemini çağırın.

sharedStore.destroy();