Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2560x 2560x 2560x 6x 6x 6x 77x 77x 77x 77x 2x 2x 2x 2x 2x 2x 2x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 242x 242x 242x 3x 3x 3x 3x 242x 242x 508x 508x 312x 312x 312x 508x 508x 130x 508x 508x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 1x 242x 242x 242x 242x 242x 242x 242x 242x 242x 150x 92x 92x 92x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 242x 239x 239x 239x 239x 239x 239x 242x 242x 239x 239x 239x 239x 239x 239x 239x 239x 101x 239x 242x 269x 269x 269x 269x 30x 269x 242x 54x 54x 54x 54x 54x 54x 54x 54x 54x 7x 7x 7x 7x 47x 47x 47x 47x 47x 47x 47x 47x 47x 2x 2x 2x 2x 2x 2x 47x 47x 54x 242x 2x 2x 242x 14x 14x 14x 242x 59x 59x 59x 59x 59x 12x 12x 12x 12x 59x 59x 43x 43x 10x 43x 43x 43x 43x 43x 43x 43x 43x 59x 59x 59x 59x 242x 242x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 3x 59x 242x 5x 5x 5x 2x 5x 242x 5x 5x 5x 2x 2x 2x 2x 2x 5x 242x 6x 6x 6x 5x 6x 242x 6x 6x 3x 6x 3x 3x 3x 3x 3x 3x 1x 2x 2x 6x 6x 242x 2x 2x 242x 4x 4x 4x 4x 242x 311x 2x 2x 311x 242x 25x 25x 56x 25x 25x 25x 31x 8x 8x 56x 56x 56x 25x 31x 31x 31x 25x 25x 242x 5x 5x 242x 242x 242x 30x 30x 30x 30x 30x 44x 44x 44x 44x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 242x 2x 2x 2x 2x 2x 2x 4x 4x 4x 4x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 2x 2x 2x 242x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 1x 1x 1x 242x 6x 6x 6x 242x 105x 105x 57x 57x 57x 57x 57x 57x 49x 49x 49x 49x 57x 57x 105x 228x 228x 105x 105x 57x 105x 105x 105x 105x 57x 57x 57x 105x 242x 19x 19x 10x 7x 7x 10x 19x 19x 19x 19x 38x 14x 14x 4x 4x 4x 4x 38x 24x 24x 2x 2x 2x 2x 24x 32x 38x 32x 32x 32x 38x 38x 19x 10x 4x 10x 10x 10x 10x 19x 19x 19x 19x 19x 19x 19x 14x 14x 14x 19x 19x 19x 242x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 420x 100x 100x 100x 100x 100x 100x 100x 100x 100x 18x 82x 82x 82x 82x 100x 135x 135x 135x 135x 100x 100x 90x 10x 100x 100x 100x 100x 1x 1x 100x 100x 100x 100x 100x 100x 100x 100x 100x 100x 100x 412x 60x 60x 60x 60x 60x 60x 60x 60x 60x 60x 3x 3x 3x 60x 60x 60x 60x 60x 60x 405x 62x 62x 62x 62x 62x 62x 62x 62x 62x 62x 62x 62x 62x 197x 197x 348x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 420x 18x 18x 420x 420x 420x 420x 420x 420x 11x 11x 420x 420x 420x 420x 420x 420x 420x 242x 242x 1x 1x 1x 1x 1x 242x 24x 24x 24x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 24x 24x 24x 24x 24x 24x 242x 16x 16x 16x 7x 7x 7x 16x 16x 242x 266x 266x 266x 266x 266x 13x 17x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 266x 9x 9x 9x 9x 266x 4x 4x 4x 4x 4x 266x 242x 4x 4x 1x 1x 1x 3x 4x 242x 9x 9x 9x 9x 9x 9x 9x 9x 2x 2x 9x 242x 242x 14x 14x 14x 14x 14x 14x 242x 7x 242x 15x 15x 7x 7x 7x 7x 7x 242x 242x 15x 15x 7x 7x 7x 7x 7x 6x 1x 15x 15x 242x 242x 1x 1x 242x 242x 242x 242x 242x 31x 31x 31x 31x 31x 242x 242x 1x 1x 242x 242x 15x 15x 15x 4x 6x 2x 2x 2x 2x 2x 242x 242x 242x 30x 30x 30x 30x 10x 30x 10x 13x 8x 30x 30x 8x 30x 30x 8x 30x 242x 25x 25x 25x 242x 8x 8x 8x 8x 8x 8x 242x 10x 10x 10x 10x 10x 10x 10x 5x 10x 10x 242x 12x 12x 12x 12x 242x 4x 8x 4x 4x 4x 4x 4x 4x 4x 4x 4x 2x 2x 7x 2x 2x 4x 242x 1x 1x 1x 1x 1x 1x 1x 242x 433x 433x 2519x 2260x 2260x 433x 433x 242x 18x 18x 242x 21x 21x 1x 3x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 242x 242x 79x 79x 79x 242x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 242x 421x 420x 421x 421x 421x 421x 421x 421x 421x 421x 242x 242x 680x 680x 680x 680x 680x 680x 242x 734x 734x 476x 476x 476x 734x 734x 734x 1x 32x 27x 5x 734x 734x 2258x 2258x 2258x 17x 2241x 2258x 2258x 734x 242x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 242x 6x 6x 1x 1x 1x 1x 5x 5x 6x 6x 6x 6x 242x 77x 77x 54x 40x 77x 242x 1x 1x 1x 1x 1x 242x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 242x 1x 1x 1x 1x 1x 242x 242x 242x 312x 1x 1x 1x 311x 312x 3x 3x 3x 3x 3x 312x 1x 1x 1x 307x 307x 307x 307x 307x 307x 312x 312x 242x 32x 32x 242x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 38x 124x 60x 60x 60x 60x 120x 64x 64x 64x 124x 38x 38x 38x 38x 38x 38x 36x 30x 30x 30x 38x 2x 2x 38x 38x 38x 242x 1x 1x 1x 1x 1x 1x 242x 6x 6x 6x 6x 6x 6x 242x 3x 3x 14x 14x 3x 3x 3x 242x 1x 1x 1x 1x 1x 1x 1x 242x 242x 242x 5x 5x 5x 1x 1x 1x 1x 1x 5x 5x 5x 3x 5x 5x 1x 1x 1x 1x 1x 5x 242x 242x 242x 3x 3x 3x 242x 4x 4x 4x 242x 5x 5x 5x 5x 5x 5x 5x 242x 3x 3x 3x 1x 1x 1x 1x 3x 2x 2x 2x 3x 242x 242x 3x 3x 1x 3x 242x 11x 11x 9x 9x 9x 11x 242x 7x 7x 7x 242x 10x 10x 10x 7x 7x 7x 3x 10x 10x 10x 10x 10x 10x 10x 242x 10x 10x 8x 10x 242x 2x 2x 242x 14x 14x 28x 25x 28x 28x 14x 14x 242x 1x 1x 1x 1x 242x 242x 387x 387x 387x 387x 387x 387x 387x 387x 387x 387x 387x 242x 411x 411x 2238x 2238x 411x 411x 411x 411x 23x 407x 411x 242x 393x 393x 393x 393x 393x 393x 393x 393x 393x 393x 242x 202x 202x 202x 242x 19x 19x 19x 242x 19x 19x 19x 242x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 421x 242x 247x 247x 12x 12x 12x 12x 235x 235x 247x 9x 226x 247x 247x 247x 247x 9x 226x 247x 247x 247x 247x 222x 13x 247x 247x 247x 247x 247x 247x 247x 242x 237x 237x 237x 237x 237x 237x 237x 237x 237x 242x 242x 242x 6x 6x 6x 6x 242x 242x 6x 6x 242x 242x 242x 242x 10x 9x 9x 9x 9x 9x 9x 9x 9x 10x 242x 2x 2x 2x 2x 2x 2x 242x 7x 7x 242x 61x 61x 22x 22x 22x 61x 242x 28x 28x 28x 28x 28x 28x 28x 242x 519x 519x 242x 462x 462x 242x 7288x 7288x 242x 6x 6x 6x 2x 2x 2x 6x 6x 242x 241x 241x 241x 236x 5x 241x 241x 241x 242x 664x 664x 664x 664x 664x 664x 664x 664x 664x 664x 664x 242x 3981x 3981x 316x 3981x 242x 24x 24x 242x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 4x 1088x 39x 1049x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 10x 1082x 1092x 1092x 1092x 1092x 1092x 1092x 10x 1082x 1092x 1092x 1092x 1092x 3768x 3768x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 18x 18x 18x 18x 18x 18x 1074x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 1092x 242x 5x 5x 5x 7x 7x 5x 7x 7x 7x 7x 7x 5x 5x 5x 5x 5x 242x 421x 421x 220x 220x 220x 2225x 2225x 31x 2194x 2225x 2225x 220x 220x 337x 421x 242x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 2x 242x 242x 3x 2x 2x 3x 242x 1x 1x 1x 1x 242x 2x 2x 1x 2x 2x 9x 9x 9x 9x 9x 8x 8x 8x 9x 9x 2x 10x 10x 10x 10x 2x 170x 170x 170x 2x 3x 3x 2x 19x 6x 6x 18x 18x 18x 19x 1x 1x 1x 17x 17x 17x 17x 19x 2x 2x 4x 6x 6x 4x 4x 4x 2x 65x 65x 65x 65x 2x 4x 4x 4x 4x 2x 5x 5x 5x 5x 5x 5x 2x 426x 426x 293x 6x 6x 6x 426x 90x 90x 90x 426x 150x 150x 150x 426x 2x 5x 5x 5x 5x 2x 27x 27x 33x 33x 33x 27x 27x 2x 4x 4x 2x 1x 1x 1x 2x 3x 3x 6x 6x 6x 3x 3x 3x 3x 3x 3x 2x 355x 355x 355x 2x 1092x 1092x 2x 1x 1x 1x 1x 1x 2x 1092x 1092x 26x 1092x 1092x 2x 11x 11x 11x 2x 11x 11x 11x 11x 11x 11x 2x 242x 242x 242x 2x 242x 242x 1x 1x 1x 1x 1x 1x 242x 2x 404x 404x 2x 27x 27x 27x 27x 2x 2x 2x 2672x 2672x 2672x 2x 2x 2x 6x 6x 6x 6x 6x 6x 6x 6x 6x 180x 180x 180x 180x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x 59x | /**
* N maps on screen at once, navigating together (§16).
*
* The viewer already had two answers to "two files" and neither of them
* generalises. A **tab** is a whole second session — its own worker, its own
* tables, its own tracks, its own address bar entry — and only one is on screen
* at a time, so it answers *open* rather than *compare*. The **lower-left
* triangle** puts a second file in one square, which is the strongest possible
* comparison and is why it is gated so hard: one grid, so one bin size, so one
* chromosome list (`ui/CompareCard.ts`). Neither is HiGlass's actual
* capability, which is several maps beside each other under one navigation, and
* that is what this is.
*
* Both of the old answers survive unchanged. A deck's lead panel is still the
* session's file and may still hold a second file in its lower triangle; the
* deck is *beside* that, not instead of it. The two compose because they are
* different claims: a blend says *these numbers share a grid*, and a panel says
* *this picture is of the same place*.
*
* ---
*
* **What is shared, and what is not.** The view is shared and the presentation
* is not. Which region, which level, which score, which balancing — all of that
* is what is being *looked at*, and a deck showing four files at four different
* regions is four unrelated pictures that happen to be adjacent. The colour
* scale is per panel, and it has to be: `vmax` is a number of contacts, and two
* libraries at different depths do not have the same one, so one clip across a
* deck would draw the shallower file as an empty rectangle. Where the reader
* wants the files at one depth, the breadcrumb's *contacts* box draws every map
* to one total (§6.5) — which changes the contacts, and leaves each panel's
* scale its own.
*
* The **transform and the colormap** are seeded from the lead and then belong to
* each panel, and "one scale for all" pushes the lead's clip down for the case
* where the reader knows the files are comparable. Default off, because it is
* the stronger claim.
*
* **The lock** is `panels/lock.ts`, whose currency is base pairs rather than
* cells — that is what lets panels of different resolution follow each other.
* It is a preference rather than view state: the hash has never carried a pan or
* a zoom, so there is nothing there for a lock to be consistent with, and
* whether a panel is off the lead is the same kind of fact as which side panel
* is folded.
*
* **The three side panels** are left entirely alone, and that is deliberate.
* They are the *session's* furniture and each describes the one file the session
* is of — and one of them, Annotations, does not exist at all on a file with a
* genome layer (§8.5), which is exactly the kind of file a deck is most useful
* for. So the deck's controls ride above its own grid and each panel's colour
* card rides inside its own panel, which is also the plainest possible statement
* of what is shared and what is not. The grid is inside `.content`, which pins
* the light palette for every descendant, so the maps do not change colour in
* the dark theme without a rule being written here (`ui/styles.css`).
*/
import type { Command } from '../ui/commands'
import type { NameContext } from '../genome/naming'
import { deviceDenseBudgetBytes } from '../metacooler/matrix'
import { recall, remember } from '../state/UiMemory'
import type { ViewState } from '../types'
import type { SourceSpec } from '../worker/protocol'
import type {
AnnotationContext,
DeckExport,
DerivePresentation,
MatrixPanel,
PanelGeometry,
TurnPresentation,
} from '../ui/MatrixPanel'
import type { SelectedRegion } from '../ui/mapSelection'
import type { ScaleState } from '../ui/GenomeView'
import { button, dragHasFiles, dragHasMapRow, el, fmt, readMapRow, type MapRow } from '../ui/dom'
import { dragHasFileRow } from '../ui/fileDrag'
import { filesFrom } from '../ui/chooseFiles'
import { tabAmong } from '../ui/tabWalk'
import { resolutionLabel } from '../units'
import {
canvasToPng,
copyPngToClipboard,
chooseSaveTarget,
fileStamp,
type ExportFormat,
} from '../ui/export'
import { FIGURE_BACKGROUND } from '../ui/canvasPalette'
import { KEYS, withKey } from '../ui/commands'
import { cardTitle, icon, iconButton, setPressed } from '../ui/icons'
import type { PickedFile } from '../browse/folder'
import { DeckFrame } from './DeckFrame'
import type { DeckCell } from './cell'
import { rasterDeck, vectorDeck, type CellFigure } from './deckFigure'
import type { LocusWindow } from '../render/locus'
import { StructurePanel, type StructureCellProps } from './StructurePanel'
import { TRACKS_CELL_NAME, TracksPanel, type TracksCellProps } from './TracksPanel'
import { cellHeightOf } from './cellHeight'
import { deckTools } from './deckHead'
import type { LaneEdge } from '../annotations/types'
import { HOVER_SOURCE_MAP, subscribeHoverPlace } from '../ui/hoverLocus'
import { isStructureName } from '../annotations/g3d'
import { MapPanel, VacantPanel, type VacancyOrigin } from './MapPanel'
import {
DECK_DRAG_TYPE,
MAX_PANELS,
carriedUnit,
grownDeck,
grownPlacement,
panelBudgetBytes,
deepestStacks,
parseMaps,
sameRefs,
serialiseMaps,
swapItems,
isMapRef,
tracksCellKey,
localCompanions,
withLocalCompanions,
readDeckLook,
type DeckLocal,
withLook,
type DeckLook,
type GrowDirection,
type PanelRef,
mapStarTitle,
readDeckLead,
withLead,
type DeckLead,
} from './deck'
import { ViewportLock, spansAgree, type LockUnit } from './lock'
import { offerLanding, within, type LaneCarry, type LaneSurface } from '../ui/laneCarry'
import type { PickHandlers } from '../ui/mapPick'
import { LEAD_MAP, type MapId } from '../annotations/placement'
import { LANE_EDGES } from '../annotations/types'
import { canonicalUrl } from '../sources/rewrite'
import { fileLabel } from '../ui/labels'
import { routeFor } from '../browse/route'
import { placementOn } from '../annotations/types'
import { paintSequencePicker, sequencePicker, shownSequence } from './sequencePicker'
/** The id the lock knows the session's own map by. */
const LEAD = 'lead'
/**
* The lead's cell, in a list of the deck's cells in reading order — where the
* companions are {@link Slot}s and the session's own view is not one (§16.9).
*/
const LEAD_CELL = 'lead-cell'
/** Where the lead's place in the grid is remembered (`panels/deck.ts`'s `DeckLead`). */
const LEAD_SCOPE = 'deck:lead'
/** The element a companion's cell is, whichever of the three kinds it holds. */
function elOf(slot: Slot): HTMLElement | undefined {
return slot.panel?.el ?? slot.cell?.el ?? slot.vacancy?.el
}
/**
* Whether a picked file is a structure: by its address, or by the name its
* folder gave it where the address is an id — a `model.pdb` in a Drive folder
* (§24.9), which by its address alone was taken for a map and refused as one.
*/
function isStructurePick(picked: PickedFile): boolean {
return isStructureName(picked.uri) || (picked.name !== undefined && isStructureName(picked.name))
}
/**
* What the deck's shared window counts in, for one panel (`panels/lock.ts`).
*
* Base pairs at bin level and everywhere nothing has been read yet, which is
* every deck this class was written for. **Cells above it**, because a
* contig-level cell is a whole chromosome: it has no width in base pairs, the
* number `bpPerCell` answers there is the file's bin size, and a window
* converted through it put chromosomes 10–14 of a 1 kb roll-up on chromosomes
* 2–3 of the 5 kb roll-up beside it. Cell `i` is sequence `i` in both, so the
* index is the thing the two grids share — and carrying it is what makes a deck
* navigate at chromosome level at all.
*/
function lockUnit(panel: MatrixPanel): LockUnit {
const level = panel.blockLevel()
return level === null || level === 'bin' ? 'bp' : 'cell'
}
/**
* How one panel's cell offsets convert on the way to another's — the deck's
* currency for a pointer, as {@link lockUnit} is for a window.
*
* `null` where there is nothing honest to carry: the two panels are at
* different levels, so one's cells are stretches of sequence and the other's
* are whole sequences, and no number means the same thing on both. The pointer
* echoes answer that with *nothing here*, which is the same refusal they make
* off the end of a shorter block and for the same reason — a mark that is
* confidently in the wrong place is the one claim a deck must never make.
*
* Otherwise the pair of steps to divide by: base pairs per cell at bin level,
* and one apiece above it, where the cell index is carried across untouched.
*/
function carryBetween(
source: MatrixPanel,
target: MatrixPanel,
): { mine: number; theirs: number } | null {
const level = source.blockLevel()
if (level !== target.blockLevel()) return null
if (level !== null && level !== 'bin') return { mine: 1, theirs: 1 }
return { mine: source.bpPerCell(), theirs: target.bpPerCell() }
}
/**
* A remembered local companion, once the session has asked whether it can still
* be opened.
*
* `source: null` is a real answer and not an absence: it means *this cell held a
* file and the grant did not answer*, which is what earns the vacancy the
* `remembered` wording and the file's own name. The asking happens in
* `SessionDeck.sync`, before the deck is handed the state, because it is
* asynchronous and nothing inside this class may be.
*/
export interface ResolvedLocal {
index: number
uri: string
source: SourceSpec | null
}
/**
* A heading that can be typed into: an `<input>` that looks like text.
*
* The Tracks card's control, shared between the deck's own cell and a
* companion's because they are one gesture on two headings — see
* `ui/mapNames.ts` for what a map's name is and where it lives. An empty box
* hands the map back to its file name, which is what makes the rename undoable.
*/
function renameBox(
name: string,
title: string,
onRename: (name: string | null) => void,
): HTMLInputElement {
const input = el('input', {
class: 'input deck-name',
type: 'text',
value: name,
title,
})
input.addEventListener('change', () => {
const typed = input.value.trim()
if (typed === name) {
input.value = name
return
}
onRename(typed === '' ? null : typed)
// The name comes back through a repaint of this heading, so the box is put
// back as it was rather than left holding a name nothing has accepted yet.
input.value = name
})
input.addEventListener('keydown', (event) => {
// Enter that goes on to the next cell's heading, in reading order (§26.8).
if (tabAmong(event, input, '.deck-grid', 'input.deck-name')) {
event.stopPropagation()
return
}
if (event.key === 'Enter') {
event.preventDefault()
input.blur()
} else if (event.key === 'Escape') {
event.preventDefault()
input.value = name
input.blur()
}
event.stopPropagation()
})
input.addEventListener('pointerdown', (event) => event.stopPropagation())
return input
}
export interface PanelDeckProps {
/**
* Rewrite the `maps` key. `replace` always: adding a panel is not a
* navigation, and a deck built up one file at a time should leave one history
* entry rather than five that each undo a file.
*/
onMapsChange(maps: string | undefined): void
/**
* A companion's file answered for the contacts it holds, or for what it was
* drawn to (§6.5): the breadcrumb's contacts box reads every map's.
*/
onDrawn?(): void
/** Where the per-file preferences are remembered — the session's memory key. */
memoryKey(): string
/**
* The star moved: which map an analysis now runs against (§18.2).
*
* The session's cue to re-price the Analysis column and re-read its context,
* because both are answers about one file and the file has changed.
*/
onStarChange?(): void
/**
* The maps open in the deck changed: a companion's file finished opening, it
* moved to another rung, or its cell was closed.
*
* The session's cue to re-ask the Analysis column which tasks apply, since a
* task that compares two files is waiting on exactly this (§18.1). Told once
* per change rather than per block read — see {@link PanelDeck.notePeers}.
*/
onPeersChange?(): void
/**
* The *Map* card the Aesthetics column should show has changed (§16.5): the
* star moved, or the starred companion's card was built or rebuilt. Only the
* session can put a card in that column, so it is told and asks
* {@link PanelDeck.mapCard} which one.
*/
onMapCardChange?(): void
/**
* A **track** file dropped on an empty cell (§16.9): load it into the
* session's one list of tracks, drawn on the tracks cell `map` the deck has
* just opened there. Absent where the session carries no tracks (§8.5), in
* which case an empty cell takes maps and structures only.
*/
onTrackFile?(picked: PickedFile, map: MapId): void
/**
* The session's own map, and the file in its lower triangle, as files a cell
* can open (§16.9) — what a row of the Contact maps card dragged onto a cell
* names. `null` where there is no such map.
*/
leadPicked?(): PickedFile | null
comparePicked?(): PickedFile | null
/**
* A map the Contact maps card holds hidden (§16.9), whose row was dropped on
* a cell: the file to open there — handed over, so the session stops holding
* it hidden, since from now on a cell holds it.
*/
hiddenPicked?(id: string): PickedFile | null
/**
* A map's cell was closed from its own heading (§16.9): the map is *hidden*,
* not let go — the session holds it on the Contact maps card, whose eye opens
* it again. Absent, and the map simply leaves.
*/
onMapHidden?(picked: PickedFile): void
/**
* The session's own cell was closed from its heading, put back, or moved to
* another place in the grid (§16.9) — the Contact maps card's eye on the
* first map says which, its row stands where the cell does, and the deck's
* memory has just changed under the durable record.
*/
onLeadShownChange?(): void
/**
* Which models the deck's structure cells draw may have changed — a cell
* opened or closed, a model shown in one, a cell's own fallback settling —
* so the Structures card's eyes can be asked again. They used to be asked
* only after the card's own eye was pressed, so a cell closed from its
* heading left its row's eye lit, and a model dropped on a `+` left it dark.
*/
onStructuresChange?(): void
/**
* A tracks cell was renamed from its heading (§25.3). The Tracks card's
* location rows name the cells a track can be put on, so the session has
* them drawn again; nothing else is renamed.
*/
onCellRenamed?(): void
/**
* The **structure** star moved: the *3D structure* card in the Aesthetics
* column is now a different cell's, and only the session can put it there.
*/
onStructureStarChange?(): void
/**
* What to call the session's own map, for the heading over its cell.
*
* Every cell of a deck says which file it is, the first one included. Without
* it the reader has four labelled rectangles and one that is simply *the
* page*, and telling which of five conditions the unlabelled one is means
* reading the breadcrumb — which is on the other side of the window and says
* a region rather than a file.
*/
leadName?(): string | undefined
/**
* The session's own file's sequences, in its order, for the picker on the
* first map's heading (§16.3) — `null` before its table is read.
*/
leadSequences?(): readonly string[] | null
/**
* A sequence picked on the first map's heading: the session goes there, as
* its locus box would, and every map following it goes along (§16.3).
*/
onLeadSequence?(name: string): void
/**
* The derivation every panel of the deck draws (§7.5), or `undefined`.
*
* A thunk, and shared across the deck for the reason the score and the level
* are: a deck exists to put N files' pictures of one place beside each other,
* and one panel drawing O/E beside four drawing counts is four wrong
* comparisons rather than a choice.
*/
derive?(): DerivePresentation | undefined
/**
* One panel's lanes, by the id the deck knows it as.
*
* The session owns the store; the deck owns the ids. Handed as a function of
* the slot rather than resolved here, because which tracks a map draws is the
* session's business and the deck's only contribution is a name.
*/
annotations?(map: string): AnnotationContext | undefined
/**
* How the session's own map names its sequences, for the companions to
* follow (§5.9).
*
* A thunk for the same reason `derive` is one: the lead's contigs arrive
* after the deck is built, and a value snapshotted at construction would be
* `undefined` for the whole session.
*/
leadNaming?(): NameContext | undefined
/**
* The sequences the session declares circular (§8.15), as the first map's
* file names them — each companion reads a window across the origin of its
* own sequence of the same name. A thunk, for {@link leadNaming}'s reason.
*/
circular?(): readonly string[]
/** What the session's own map is called, for the placement control's rows. */
leadLabel?(): string
/**
* What to call a companion, which is not always what its file is called.
*
* A map can be renamed (`ui/mapNames.ts`), and the names live with the
* session rather than with the deck — a deck is an arrangement of files and
* the session is what is holding them. A thunk of the URI so a panel that
* resolves itself into an entry of a collection asks again under the address
* it ended up at.
*/
mapLabel?(uri: string): string
/** The reader typed a name into a companion's heading, or emptied the box. */
onRenameMap?(uri: string, name: string | null): void
/**
* The same, for the session's own map in cell 0.
*
* A separate handler rather than {@link onRenameMap} with the lead's URI,
* because the deck does not have that URI: it has a *name* for cell 0 and
* nothing else, which is the whole of what {@link leadName} is.
*/
onRenameLead?(name: string | null): void
/**
* Whether the deck is turned 45°, or `undefined`.
*
* A thunk and shared, on the derivation's argument taken one step further: a
* turn changes the geometry rather than the values, so a lead drawn as a band
* along its diagonal beside four squares is not one navigation over five
* pictures of a place — it is five pictures in two coordinate systems under a
* bar claiming otherwise.
*/
turn?(): TurnPresentation | undefined
/**
* Put a colour scale on the session's own map — "fix all scales" (§16.2).
*
* Through the session rather than onto the panel, and that is not ceremony:
* `MatrixPanel.applyScale` writes the clip onto the panel and tells nobody, so
* the next render — which rebuilds the lead's view from the *state* — would
* put it straight back. The session's own colour controls patch the view
* state, so this does too, and the choice sticks and travels in the link.
*
* Absent where the lead is a view with no scale to set, in which case the
* toggle simply moves the companions.
*/
onLeadScale?(scale: ScaleState): void
/**
* Read the session's own map at this bin size — "fix all resolutions".
*
* Only reachable when the star is on a companion: it is the one direction the
* deck cannot take itself, because changing the lead's rung means reopening
* the file the session *is* — the breadcrumb's own entry picker, from the
* other end.
*/
onLeadBinsize?(binsize: number): boolean
/**
* The bin size the session's own file is at, or `undefined`.
*
* Only for a companion that turns out to be a **collection** rather than a
* map: an `.mcool` is a ladder of complete coolers and the rung to land on is
* the lead's, because two files with the same ladder are comparable at any of
* them and the finest-regardless rule would put a 1 kb map beside a 16 kb one
* (§3.4, `MapPanelProps.preferBinsize`). The *file's* bin size and not the
* lead panel's effective resolution: pooling is a fact about how much of the
* block is on screen, and it is not what a resolution ladder is indexed by.
*/
binsize?(): number | undefined
/**
* The score the session's own map resolved to — `count`, `balanced`, `ICE`, a
* column name.
*
* Shared as a resolved id, because the *default* is a fact about a file and
* is not in the hash: a cooler somebody balanced opens balanced. Two panels
* each applying their own default disagreed silently, which is the one thing
* a deck must not do about a quantity.
*/
score?(): string | undefined
/**
* A companion's own scale, score or chain moved.
*
* Nothing to apply — the deck has already written it into this session's
* memory — only somebody to tell, because the durable record and the exported
* workspace are built from that memory and neither is rewritten by a change
* that does not touch the view state. Without this, nudging four companions'
* clips and closing the window lost all four: a clip is not a navigation, so
* nothing on the state road ever fired.
*/
onLooksChange?(): void
/**
* What a **structure cell** needs from the session (§25): the store its row
* is in, the marks a shift-click adds to, and where a double-click takes
* the maps. Absent where the session has no annotation store — a metacool —
* in which case a structure cell draws its "no structure" line and nothing
* else.
*/
structure?: StructureCellProps
/**
* What a **tracks cell** needs from the session (§25.3): the lead file's
* sequences and the annotation machinery its own browser would have. Absent
* where the session has none, in which case a tracks cell says so.
*/
tracks?: TracksCellProps
/**
* Whether a **map** may join this deck (§25.3). Absent is yes. `false`
* for a deck whose lead is the 1D browser: its cells are tracks and a
* structure, and a map dropped on it is refused in the bar rather than
* opened beside a lead it cannot follow.
*/
mapsAllowed?(): boolean
}
/**
* A lead that is not a map (§25.3): the session's browser, re-parented
* into cell 0 like a map's view, answering the two things the cells need of a
* lead — where it is looking, as loci, and to be taken somewhere.
*/
export interface LeadAxis {
windows(): { rows: LocusWindow[]; cols: LocusWindow[] }
/** Put a stretch on the axis; `false` where it could not. */
show(range: { contig: string; start: number; end: number }): boolean
/**
* The tracks as the deck's figure's cell of them (`panels/deckFigure.ts`),
* which was left empty before the browser could be asked: pixels for its
* PNG, paths for its PDF. `null` where there is nothing to draw.
*/
figure?(now: Date): CellFigure | null
/** Hand the browser's Export card and keys to the deck's figure, or back (`null`). */
setDeckExport?(hook: DeckExport | null): void
}
/**
* A companion, its slot, and whether it is on the lead.
*
* `held` is what distinguishes an open local file from the vacancy a link left:
* a local companion has a source nothing can reconstruct from a URI, so the
* deck holds it and writes `~` into the hash instead.
*/
interface Slot {
/**
* The lock's name for this panel, minted here rather than taken from the URI.
*
* A local companion's URI is its file name, and two files called `rep1.cool`
* from two directories are two maps — a lock keyed on the name would drive
* both from one report. A counter has no such coincidence.
*/
id: string
ref: PanelRef
panel: MapPanel | null
vacancy: VacantPanel | null
/**
* A cell that is not a map and not empty — a structure, a stack of tracks
* (§25). Exclusive with the two above: a slot holds one of the three, and a
* `DeckCell` answers only what every cell can, so the deck's map-only calls
* (a lock member, a lane floor, a bin size) never look at it.
*/
cell: DeckCell | null
/** What the reader asked for; whether it is *honoured* is {@link agrees}. */
locked: boolean
}
/**
* What the deck's bar rasterises its PNG at.
*
* A fixed 300 dpi rather than a picker of its own: the per-panel export already
* has one, and a second dpi control in the deck's bar would be a shared setting
* that is not shared with anything. 300 is what a figure is for. The air
* between cells is `deckFigure.ts`'s, with the rest of the layout.
*/
const DECK_EXPORT_DPI = 300
/** A map offered to a deck whose lead is the browser (§25.3). */
const NO_MAP_LEAD =
'This deck is of tracks and a structure beside the browser. A map opens as a session of its ' +
'own — drop it on the tab strip, or open it first and put the tracks beside it.'
/**
* What the structure button promises.
*
* One more structure cell at every press (§16.11), drawing the first model no
* other cell is drawing (§25.3). While a deck held one structure cell the
* button was greyed once there was one, with the reason in this tooltip; a
* deck holds as many as the reader asks for now, so the button is always live
* and this sentence always true.
*/
const ADD_STRUCTURE = 'Open a cell drawing a 3D structure beside the maps; each model gets its own'
/**
* What a reader is told when the deck will not open another cell.
*
* In the deck's own bar and on the `+` edges rather than on an error screen: a
* refusal to open a *sixty-fifth* map is not a reason to take the others away.
*/
const NO_ROOM =
`A deck stops at ${MAX_PANELS} maps, which is a backstop rather than a judgement about how ` +
'many are useful: every panel is a worker and, for a whole-file view, a block held in memory, ' +
'and each one added makes every panel’s share of this tab’s memory smaller. Long before this ' +
'it is the share that refuses, panel by panel and in bytes. Close one to open another.'
let nextSlotId = 1
export class PanelDeck {
/** The grid, parented into the session's content area. */
readonly el: HTMLElement
private readonly toolbar: HTMLElement
private readonly grid: HTMLElement
private readonly leadHead = el('header', { class: 'deck-head deck-head-lead hidden' })
/**
* The lead's half of the star; every companion carries its own. Pressed
* filled, it leaves no map starred ({@link setStarred}).
*/
private readonly leadStar = iconButton('star', '', () => this.setStarred(LEAD_MAP), {
class: 'btn btn-icon deck-star is-on',
size: 13,
})
/**
* The lead's half of the chain, beside its star — see {@link syncLeadLock}.
*
* In the lead cell's own heading and not in the deck's bar, where it was: the
* chain is a *per-cell* control, the one thing each cell says about itself
* (§16.5), and a companion's sits in its own heading. In the bar it was the
* same glyph at two heights, and the one among controls that act on every
* cell read as a lock over the whole deck rather than as the first map's own.
*
* Titled and drawn by {@link syncLeadLock}, because what it says depends on
* which way it is flipped.
*/
private readonly leadLock = iconButton('link', '', () => this.toggleLeadLock(), {
class: 'btn btn-icon deck-lock',
size: 14,
})
/**
* The lead's grip — every cell has one (§16.9). The first map used to have
* none: it is the session's own view in the grid, and "which file is this
* session of" is not a thing a drag should change. Nor does this change it.
* What moves is where the picture stands; the session is of the same file
* afterwards, under the same breadcrumb, with the same tables.
*/
private readonly leadGrip = el('span', {
class: 'deck-grip',
attrs: { draggable: 'true' },
})
/**
* The lead's ×: the cell leaves the screen and its view stays alive behind
* the grid, still what the others follow (§16.9). Only while another cell
* is beside it — a deck with nothing on screen is not a deck — and the eye
* on its row of the Contact maps card, or the deck's bar, puts it back.
*/
private readonly leadClose = iconButton('x', '', () => this.hideLead(), {
class: 'btn-close',
size: 14,
})
/**
* The sequence the first map is on, as every map cell's heading says it
* (§16.3) — a pick here is the session's navigation, so it goes where the
* locus box would and the maps following it go along.
*/
private readonly leadSequence = sequencePicker((name) => this.props.onLeadSequence?.(name))
/** What {@link leadSequence} last said, so a frame of the lead's pan does not repaint it. */
private leadSequenceKey = ''
/**
* Where the lead view's own heading goes while a deck is on.
*
* The heading, the locus box, the back link and the block summary belong to
* the *session*, not to the first cell of a grid — they answer "what am I
* looking at", which is one question however many pictures are on screen. Left
* inside cell 0 they made it a head taller than every other cell, so the first
* map was drawn smaller than the maps it was there to be compared with, and
* the reader had to correct for the difference before reading anything.
*/
private readonly leadHeadHost = el('div', { class: 'deck-lead-head hidden' })
/** What was hoisted out of which view, so it can be put back. */
private hoisted: { head: HTMLElement; view: HTMLElement } | null = null
/** The deck's own line in that summary — how many maps, and how many empty. */
private readonly deckNote = el('span', { class: 'deck-maps' })
private readonly leadCell = el('div', { class: 'deck-panel is-lead' }, this.leadHead)
private readonly addRow: HTMLElement
private readonly urlInput: HTMLInputElement
/**
* The one cell that is not a file (§25), one more at every press — see
* {@link ADD_STRUCTURE}.
*/
private readonly structureButton: HTMLButtonElement
/** A refusal about the deck as a whole, rather than about one panel. */
private readonly warning = el('p', { class: 'inline-error deck-warning hidden' })
/** The `+` edges, wrapped round the grid — see {@link DeckFrame}. */
private readonly edges: DeckFrame
private slots: Slot[] = []
private readonly lock = new ViewportLock()
private lead: MatrixPanel | null = null
/** The lead when it is not a map — the browser (§25.3); else `null`. */
private leadAxis: LeadAxis | null = null
private readonly unsubscribeHover: () => void
/** Takes the deck's places off offer to a carried lane (`ui/laneCarry.ts`). */
private readonly stopLanding: () => void
/** How many times {@link publish} has written the deck, for {@link growFilled} to tell. */
private writes = 0
/** Whether the echo on the maps is one a structure cell's pointer put there. */
private echoingPlace = false
/**
* Whether the first map's chain is closed — whether it drives the deck.
*
* Remembered with its place (`DeckLead.locked`), as a companion's is with
* its look, and read back by the constructor: it started `true` on every
* build of the deck, so a first map the reader had set moving on its own
* came back driving the others after a reload, a restored workspace or the
* deck being built again, while every companion beside it kept its chain
* open.
*/
private leadLocked = true
/**
* The lead's last report, kept because the alignment is recomputed without it.
*
* A companion whose stack changes has to raise the deck's floor, and it has
* no way to ask the lead what its own geometry is — that arrives as a push.
* So the last one is held rather than the figures derived from it.
*/
private leadGeometry: PanelGeometry = {
lanes: { top: 0, right: 0, bottom: 0, left: 0 },
plot: 0,
plotHeight: 0,
}
/** Guards {@link align} against the reports its own writes provoke. */
private aligning = false
/**
* How many cells are in a row, or `null` for one row of everything.
*
* The deck's whole shape, as one number. It used to be three preset buttons —
* row, column, near-square — which answered "arrange however many maps are
* here" and were therefore a function of the count: a `row` of four stayed a
* row when a fifth arrived. A drawn deck (§16.9) needs the other thing, a
* shape that *survives* the count changing, or closing one map out of a 2 × 2
* silently reflows the other three into a row.
*
* Set by a `+` on an edge and by the columns picker in the bar, which is the
* preset row's honest replacement: it says the same thing the three buttons
* said, in the vocabulary the grid is actually in.
*/
private columns: number | null = null
/**
* Where the lead's cell stands in reading order, among every cell the deck
* holds, and whether it is on screen (`panels/deck.ts`'s `DeckLead`).
*
* A place rather than a flag on a slot, because the lead is not a slot: it
* is the session's view, re-parented into the grid, and every piece of the
* deck that speaks to companions — the hash, the lock's members, a cell's
* seat — goes on speaking to them alone. Hidden, it keeps its place, so the
* eye that brings it back brings it back where it stood.
*/
private leadAt = 0
private leadHidden = false
/**
* The map an analysis runs against — the star (§18.2).
*
* **Not the lead, and deliberately a second idea.** The lead is what the
* session *is of*: the breadcrumb, the tables, the tracks and the second-file
* split all name it, and it does not move (§16.9). What a reader wants a deck
* for is often the other question — four replicates on screen and *this* one is
* the one to measure — and answering it by changing which file the session is
* of would rewrite the breadcrumb and the tables to run a P(s).
*
* So the star says which picture the tasks read and which map the *Map* card
* in the Aesthetics column sets (§16.5); it starts on the lead, and it goes
* back to the lead the moment the map it named leaves. One starred map at a
* time, because a task runs against one file and the column holds one card:
* a radio button drawn as five.
*
* **Or none**, `null`: the reader pressed the filled star. Then the card sets
* every map at once — the first map's card, its changes copied onto every
* companion ({@link mirrorLead}) — and no task that reads a map can run, since
* there is no file for one to run against (§18.1). The 1D tasks read only the
* tracks, and run as before.
*/
private starred: MapId | null = LEAD_MAP
/**
* What the first map's card last said, for {@link mirrorLead} to tell which
* of its settings a render has just moved. `null` before the first render.
*/
private leadSettings: LeadSettings | null = null
/**
* The structure cell the *3D structure* card is about (§25.3), by slot id.
*
* Its own star and not the maps': a starred map is *the file an analysis
* runs against* and a starred structure cell is *the picture this column's
* settings are for*. One deck can want both at once, and a reader who
* starred a model to tune it has said nothing about which map a task reads.
*
* `''` is *not chosen yet*, which falls to the first cell; `null` is *none*,
* the reader having pressed the filled star — the card then sets every
* structure cell at once (§25.3).
*/
private starredStructure: string | null = ''
/**
* How each companion was last drawn, by file (`panels/deck.ts`'s `DeckLook`).
*
* Held here rather than on the panels because it has to outlive them. A panel
* is destroyed and rebuilt by every reconcile that changes the list — closing
* a neighbour, dragging a map to another cell, following a link — and a clip
* kept on the instance is a clip the reader loses on the next thing they do to
* the grid. It also has to outlive the *deck*, since the whole point is that a
* saved workspace brings four replicates back on their own four scales.
*/
private looks: DeckLook[] = []
/**
* The cells {@link adopt} has built or kept so far in one pass, which the
* slots list does not hold until the pass is over.
*
* What a structure cell asks before it falls to a model (`taken`, §25.3):
* without them, every cell of a deck rebuilt from a link fell to the first
* model, and the next change to the store moved each to the first one its
* neighbours were not drawing — the models came back one seat to the left
* of the order they were saved in, the first of them in the last cell.
*/
private placed: readonly Slot[] = []
/**
* The bin size the session's own map was last seen at.
*
* Watched rather than told, because there is no one place to be told from: a
* reader changes the first map's resolution from the breadcrumb's own picker,
* a link can arrive naming another rung, and *fix all resolutions* can move it
* from the deck's bar. All three end in the same place — the session reopens
* its file — so the deck notices the number change and takes every companion
* with it (§16.2). `undefined` until the first view lands, which is why the
* first sighting only records: a companion already opens on the first map's
* bin size (§3.4) and has nothing to be moved to.
*/
private leadBinsize: number | undefined
private state: ViewState | null = null
/**
* The `maps` value this deck last wrote, so it does not act on its own echo.
*
* The same shape as `App.writingHash`, and needed for the same reason plus
* one: a **local** companion is published as `~` (§16.6), so the state that
* comes back describes a vacancy where this deck is holding an open file.
* Reconciling against it would destroy the panel the reader had just dropped
* in and leave a drop rectangle in its place. Wrapped in an object rather
* than compared against `undefined`, because "no key" is a legitimate value
* to have published and has to be told apart from "never published".
*/
private published: { value: string | undefined } | null = null
/** The open maps as last told to the session; see {@link notePeers}. */
private peersTold = ''
/** Which block the deck was last showing, so a move to another resets the lock. */
private place: string | null = null
private destroyed = false
constructor(private readonly props: PanelDeckProps) {
this.columns = this.recallColumns()
// Where the lead was left, and whether it was on screen. Reconciled against
// the deck when its cells arrive: a place past their end is the end
// ({@link order}), and a hidden lead in a deck that comes back with no other
// cell is shown ({@link paintGrid}). Its chain needs no reconciling: open,
// it seeds nothing ({@link seedFromLead}), and the lock asks it each time.
const place = readDeckLead(recall<unknown>(props.memoryKey(), LEAD_SCOPE))
if (place !== null) {
this.leadAt = place.at
this.leadHidden = place.hidden
this.leadLocked = place.locked !== false
}
this.wireLeadGrip()
// A pointer on a structure cell is a place on every map (§25.4): the cell
// publishes it and the deck, which is what knows the maps, draws the mark
// — the lane-echo shape, on the axis that means position in every
// presentation. Cleared only when this deck put one there, so a hand
// leaving a map does not wipe another deck's echo through this one.
this.unsubscribeHover = subscribeHoverPlace((place) => {
const locus = place === null ? null : place.loci[0]
// Onto the cells that draw an axis, whoever is pointing — bar the one
// pointing — and **every** place the pointer names: a cell of a map is a
// pair, and the lanes under that map mark both ends of it, so a tracks
// cell marking only the first put one of the two anchors nowhere. The
// structure cell listens for itself and has no relay.
for (const slot of this.slots) {
if (slot.cell === null || place?.source === `${slot.cell.kind}:${slot.id}`) continue
slot.cell.showLocusEcho?.(place === null ? null : place.loci)
}
// Onto the maps only from a cell: the maps already echo between
// themselves, through cells and converted, and a second mark for the
// same pointer would be two answers.
const fromCell = place !== null && place.source !== HOVER_SOURCE_MAP
if (!fromCell && !this.echoingPlace) return
this.echoingPlace = fromCell
this.lead?.showLocusEcho(fromCell ? locus : null)
for (const slot of this.slots) slot.panel?.map?.showLocusEcho(fromCell ? locus : null)
})
// Restored, then reconciled: a session written when four maps were open can
// name a slot this one has not built, and `keepStarPresent` puts it back on
// the lead rather than leaving the Analysis column pointed at nothing.
const star = recall<string>(props.memoryKey(), 'deck:starred')
if (star === NO_STAR) this.starred = null
else if (typeof star === 'string' && star !== '') this.starred = star
const model = recall<string>(props.memoryKey(), STRUCTURE_STAR_SCOPE)
if (model === NO_STAR) this.starredStructure = null
else if (typeof model === 'string') this.starredStructure = model
this.looks = this.recallLooks()
this.structureButton = button('add a 3D structure', () => this.add({ kind: 'structure' }), {
class: 'btn deck-add-structure',
title: ADD_STRUCTURE,
})
this.urlInput = el('input', {
class: 'input input-tiny deck-url',
type: 'url',
placeholder: 'https://bucket.example.org/other.cool',
})
const fileInput = el('input', { class: 'hidden-input', type: 'file' })
fileInput.addEventListener('change', () => {
const file = fileInput.files?.[0]
if (file !== undefined) this.addLocal(file)
fileInput.value = ''
})
this.addRow = el(
'div',
{ class: 'deck-add hidden' },
button('choose a file…', () => fileInput.click(), { class: 'btn' }),
this.urlInput,
button('add', () => this.addUrl(), { class: 'btn' }),
// No *from a connected place…* beside it any more. Browsing a folder this
// window is connected to is the Files column (§20), which is a column and
// not a dialog — open one, look, open the next — and a button that opened a
// one-shot copy of it from four different rows was four doors to one room.
//
// The one cell that is not a file: the session's 3D model, in a cell of
// its own (§25). A press opens one more, however many the deck holds —
// see {@link ADD_STRUCTURE}.
this.structureButton,
// **Both lead with the verb**, like every other button in the row. They
// read `3D structure` and `tracks`, which in a row opened by a button
// that says *add* parse as two kinds of thing the URL box takes rather
// than as two more cells to open — and the tracks cell has no other road
// a reader can find (§16.11).
button('add a tracks cell', () => this.add({ kind: 'tracks' }), {
class: 'btn deck-add-tracks',
title: 'Open a cell of tracks alone beside the maps — put tracks on it from the Tracks card',
}),
fileInput,
)
this.urlInput.addEventListener('keydown', (event) => {
if (event.key === 'Enter') this.addUrl()
})
this.grid = el('div', { class: 'deck-grid' }, this.leadCell)
this.watchArranging()
this.watchFileDrops()
this.toolbar = el('div', { class: 'deck-bar' })
// The same edges the session was showing a moment ago, now round the grid
// instead of round one map — which is the whole reason they are a component
// and not a pair of buttons in each place (`panels/DeckFrame.ts`).
this.edges = new DeckFrame({
onGrow: (direction, picked) => this.grow(direction, picked),
onGrowWithMap: (direction, row) => this.growWithMap(direction, row),
...(props.structure === undefined
? {}
: {
onGrowWithStructure: (direction: GrowDirection, id: string) =>
this.growWithStructure(direction, id),
}),
onGrowWithTrack: (direction, id) => this.growWithTrack(direction, id),
})
this.stopLanding = offerLanding(this.laneSurface)
this.el = el(
'div',
{ class: 'deck' },
this.leadHeadHost,
this.toolbar,
this.addRow,
this.warning,
this.edges.hold(this.grid),
)
this.paintBar()
this.applyLayout()
}
// -------------------------------------------------------------------------
// What the session drives
// -------------------------------------------------------------------------
/**
* Put the mounted view inside the deck and hand back the element to mount.
*
* The lead's DOM is *re-parented* rather than rebuilt, which is what makes a
* deck cost nothing on a view that would have been mounted anyway: the region
* view, its map, its lanes and its canvas are exactly what they would have
* been without a deck, one grid cell further in.
*/
frame(lead: HTMLElement): HTMLElement {
this.paintLeadHead()
this.hoistHead(lead)
this.leadCell.replaceChildren(this.leadHead, lead)
this.paintBar()
return this.el
}
/**
* Let go of the lead, for a view this deck is not framing.
*
* {@link DeckFrame.release}'s counterpart, and it exists for exactly the same
* reason one line up: {@link frame} *re-parents* the mounted view rather than
* rebuilding it, so the cell goes on holding whatever it was last given. A
* session navigating to a table takes the bare node instead of a framed one
* (`SessionDeck.framed`) — and nothing then tells the deck, so `leadCell` kept
* parenting the **previous, already destroyed** view. A heatmap's subtree is
* a canvas with a full-resolution backing store behind it, so what is
* retained is not a stale node but tens of megabytes of it, for as long as
* the deck lives.
*
* `lowerHead` first, and that order is the whole of why this cannot be done
* from the call site by emptying the cell: {@link hoistHead} moves the view's
* own `.view-head` out of it and into the deck's bar, and parks the pair in
* `hoisted`. Clearing the cell alone would leave that heading mounted in the
* bar and `hoisted` pointing at the subtree — the same retention, one element
* further away, plus a heading over a map that is no longer there.
*
* Idempotent, because the states that reach it are not mutually exclusive: a
* session can navigate from one table to another, and `lowerHead` already
* returns on a null `hoisted`.
*/
release(): void {
this.lowerHead()
this.leadCell.replaceChildren(this.leadHead)
}
/**
* Take the view's own heading out of cell 0 and put it above the grid.
*
* Moved rather than rebuilt, so the region box keeps its caret, the stepper
* keeps its listeners and the summary keeps whatever the last read wrote into
* it. Every view a deck can frame has exactly one `.view-head` and it is the
* first child of the view's root (§16.8 lists which they are); anything else
* in there — a whole-genome view's gate and progress bar, say — is about the
* *picture* and stays with it.
*
* The deck's own note goes immediately after the summary rather than into it:
* a view rewrites that element on every read, and anything the deck had put
* inside would go with the previous block's numbers.
*/
private hoistHead(lead: HTMLElement): void {
this.lowerHead()
const head = lead.querySelector<HTMLElement>(':scope > .view-head')
if (head === null) {
this.leadHeadHost.replaceChildren()
this.leadHeadHost.classList.add('hidden')
return
}
this.hoisted = { head, view: lead }
this.leadHeadHost.replaceChildren(head)
this.leadHeadHost.classList.remove('hidden')
const summary = head.querySelector(':scope > .summary, :scope > .match-kind')
if (summary === null) head.append(this.deckNote)
else summary.after(this.deckNote)
}
/** Give the heading back to the view it belongs to, first child as it was. */
private lowerHead(): void {
const held = this.hoisted
this.hoisted = null
this.deckNote.remove()
if (held === null) return
held.view.prepend(held.head)
}
/**
* The map the session just mounted, for the lock to drive.
*
* Re-registered on every mount because it is a different object on every
* navigation — a region view builds its own panel — and a lock holding the
* previous one would drive a canvas nobody can see.
*/
setLead(panel: MatrixPanel | null): void {
if (this.lead !== null && this.lead !== panel) {
this.lead.setDeckExport(null)
this.lead.setViewportListener(null)
this.lead.setLaneListener(null)
this.lead.setHoverListener(null)
this.lead.setLaneHoverListener(null)
}
this.lead = panel
this.lock.leave(LEAD)
// A new first map is a new card, which has to be told what it sets.
this.paintCardsFor()
panel?.setDeckExport(this.deckExport)
panel?.setLaneListener((budget) => this.align(budget))
panel?.setHoverListener((cell) => this.echoHover(LEAD, panel, cell))
panel?.setLaneHoverListener((at) => this.echoLaneHover(LEAD, panel, at))
if (panel === null) {
this.align({ lanes: { top: 0, right: 0, bottom: 0, left: 0 }, plot: 0, plotHeight: 0 })
// A table view has no map. The bar still repaints, because the chain on it
// is about the lead and there is now nothing for it to hold.
this.paintBar()
return
}
this.lock.join({
id: LEAD,
unit: () => lockUnit(panel),
bpPerCell: () => panel.bpPerCell(),
cells: () => panel.cellCount(),
locked: () => this.leadLocked,
show: (rows, cols) => panel.showViewport(rows, cols),
})
panel.setViewportListener((rows, cols) => {
this.lock.report(LEAD, rows, cols)
// A report is also the first word that a new block is drawn.
this.syncLeadSequence()
// One way, to the cells that light what the maps are looking at (§25).
// Read back from the panel as loci rather than converted from the cell
// spans above: a structure has no cells, and base pairs are what it has.
const windows = panel.framedRanges()
for (const slot of this.slots) slot.cell?.applyWindow(windows)
// Before the notes, because it is one of the things they are about: a
// companion whose band reaches a different distance is refused by
// `lockNote`, and this is what stops that being a thing two boxes can
// disagree into.
this.syncTurnReach()
// The lead's first report is the moment a companion's note can be
// *answered*: until the lead has a block there is nothing to compare
// against, so `lockNote` says nothing, and a real disagreement discovered
// afterwards would otherwise sit unsaid until the next thing that happened
// to repaint the panel.
this.syncLockNotes()
})
this.paintBar()
}
/** Re-ask every companion's chain and line, after something they compare against moved. */
private syncLockNotes(): void {
for (const slot of this.slots) slot.panel?.syncLock()
}
/**
* One distance from the diagonal across every turned panel (§17.2, §16.3).
*
* A turned map's band is cut as deep as its own box has rows for, which is the
* right rule for one map and cannot work for several: a grid lays its cells
* out over more than one frame, so two panels asking their own boxes at their
* own moments get two answers and neither is wrong. What the reader saw was
* two bands of visibly different depths, the lock refusing to move them
* together, and `lockNote` blaming the files' *resolutions* for what was a
* layout race — a claim about their data, made out of a timing accident, and
* cured by turning the deck off and on again, which re-cuts both bands from
* boxes that have by then settled.
*
* So the lead's reach is pushed down, in base pairs, exactly as the window is
* and for the same reason: each panel converts to its own lattice, so panels
* of unequal resolution reach the same distance rather than the same number of
* bins. The lead keeps its box — it is the one map whose depth is a reader's,
* through the height of the window they are looking at.
*
* Companions are released back to their own boxes when the lead is not turned,
* which is what makes this leave a square deck exactly as it was.
*/
private syncTurnReach(): void {
const reach = this.lead?.turnReach() ?? null
for (const slot of this.slots) slot.panel?.map?.setTurnReach(reach)
}
/**
* Reconcile the companions against a view state, and hand it to them.
*
* The list first, so a link that names three maps has three panels before any
* of them reads anything; then the view, which each panel resolves against
* its own file.
*/
apply(state: ViewState, locals: readonly ResolvedLocal[] = []): void {
// A different block is a different place, and the lock's currency is base
// pairs *from each block's own first cell* — so a window carried across a
// navigation still parses and means somewhere else. Cleared before anything
// is pushed, so a companion that finishes reading before the lead catches up
// to nothing rather than to the previous region's window.
const place = placeKey(state)
if (this.place !== null && this.place !== place) this.lock.reset()
this.place = place
// The session's own map may have changed rung since the last view — from the
// breadcrumb's picker, from a link, or from this deck's own button — and
// every companion follows it there. Before the panels are handed the state,
// so a companion that is about to re-read does it once at the new resolution
// rather than twice.
const binsize = this.props.binsize?.()
if (binsize !== undefined && binsize > 0) {
const moved = this.leadBinsize !== undefined && this.leadBinsize !== binsize
this.leadBinsize = binsize
if (moved) this.followLeadResolution(binsize)
}
this.state = state
if (this.published === null || this.published.value !== state.maps) {
// The hash says `~` for a local companion, which is all it can honestly
// say (§16.6). What this session privately remembers about those cells is
// merged back in here — resolved ones become live panels again, and the
// rest stay vacancies that at least know what they were.
//
// **The cells this deck is already holding count first.** A `~` is all
// the hash can say about a local map, and what it is resolved against
// was, until now, only the *stored* record — which is re-opened through
// a filesystem grant. A file that arrived by **drag and drop** has no
// grant: the browser hands over a `File`, not a handle, and nothing can
// ask for one afterwards. So dropping four coolers on a deck opened four
// live panels, published, came back through here, failed to resolve any
// of the four, and replaced all of them with vacancies reading *this cell
// held that file and it could not be re-opened* — about files that were
// open a frame earlier and whose bytes this deck still had in hand.
//
// A slot that is live is the best possible answer for its own index, so
// it is asked before the record is. Positional, which is exactly the
// correspondence {@link publish} writes and `rememberedCompanions`
// already assumes; and only ever over a `~`, so a link that put a remote
// map or a structure cell at that index still wins.
const live: DeckLocal[] = []
this.slots.forEach((slot, index) => {
if (slot.ref.kind === 'local') live.push({ index, uri: slot.ref.uri })
})
const wanted = withLocalCompanions(
withLocalCompanions(parseMaps(state.maps), live),
locals.filter((local) => local.source !== null),
)
if (!sameRefs(wanted, this.slots.map((slot) => slot.ref))) this.adopt(wanted, locals)
// The **hash** value, never the merged list's. They serialise the same —
// a local ref becomes `~` again — but recording what was merged would
// make the next render see a difference and reconcile the deck away.
this.published = { value: state.maps }
}
// Before the panels are handed the state, so a companion told a new score
// reads it once rather than reading the old one first.
this.mirrorLead(state)
for (const slot of this.slots) (slot.panel ?? slot.cell)?.apply(state)
this.paintBar()
}
/**
* The session's declarations moved under the maps on screen (§8.15) — a circle
* ticked or measured, an origin typed or placed by a task. Every companion
* reads them again: a window across a circle's origin is read only where the
* circle is declared, and the arms are read from the origin.
*/
redeclared(): void {
const state = this.state
if (state === null) return
for (const slot of this.slots) slot.panel?.apply(state)
}
/**
* With no map starred, make every change to the first map's card a change to
* every map (§16.5).
*
* The card in the column is the first map's then, and its settings live in
* the view state — so what moved is read off the state, against what it said
* last render, and only what moved is copied: a score picked there must not
* also flatten every companion's clip onto the first map's. Watched here
* rather than reported by the card, so every road to the first map's
* settings — the card, the palette, a link — reaches every map alike while
* nothing is starred, and none of them does while something is.
*/
private mirrorLead(state: ViewState): void {
const now: LeadSettings = {
score: this.props.score?.(),
oe: state.oe === true,
smooth: state.smooth ?? '0',
arms: state.arms,
transform: state.transform,
colormap: state.colormap,
vmin: state.vmin,
vmax: state.vmax,
}
const was = this.leadSettings
this.leadSettings = now
if (was === null || this.starred !== null) return
for (const slot of this.slots) {
const panel = slot.panel
if (panel === null) continue
if (now.score !== undefined && now.score !== was.score) panel.useScore(now.score)
if (now.smooth !== was.smooth) panel.useSmooth(now.smooth)
if (now.oe !== was.oe) panel.useExpected(now.oe)
// Along the arms too (§8.15), which the first map's `arms` turns on with
// its O/E: one press on the card that sets every map.
if (now.arms !== was.arms) panel.useArms(now.arms)
const look: ScaleState = {}
if (now.transform !== was.transform && now.transform !== undefined) look.transform = now.transform
if (now.colormap !== was.colormap && now.colormap !== undefined) look.colormap = now.colormap
// The clip as a pair, and *auto* carried as auto: a clip taken back off
// the first map is a clip taken off every map.
const clip = now.vmin !== was.vmin || now.vmax !== was.vmax
if (Object.keys(look).length > 0 || clip) {
panel.mergeLook(clip ? { ...look, vmin: now.vmin, vmax: now.vmax } : look)
}
}
}
/**
* The colour scale the deck is being asked to put every panel on.
*
* The **starred** map's, which is the map every other "all of them" in this
* bar is measured from — it is what a task runs against (§18.2), and making
* it what the scale and the resolution come from too is one idea rather than
* three. `null` where there is nothing to read one from: a first map that is a
* table, a starred companion still opening.
*/
private starredLook(): ScaleState | null {
// The star's own map and never a fall-back to the first one: a starred
// companion that has not drawn yet has no numbers, and answering with
// somebody else's while the button says "the starred map" is worse than
// answering with nothing.
if (this.starred === null) return null
const panel = this.starred === LEAD_MAP ? this.lead : (this.starredPanel?.map ?? null)
if (panel === null) return null
// **What it is drawing with**, not what the reader has set on it. Those are
// the same thing only where somebody has nudged a clip; everywhere else the
// setting is `NaN` — §7.1's auto rule, resolved per read — and reading it
// here is why the press used to carry the ramp and the transform across the
// deck and leave every range where it was ({@link MatrixPanel.shownScale}).
return scaleState(panel.shownScale())
}
/**
* Draw every panel on the starred map's clip — the *match all scales* press.
*
* **An action, and no longer a mode.** It used to be a switch that stayed on,
* and a switch makes a promise it cannot keep: the moment it is lit, every
* later nudge of any panel's clip either has to be undone or leaves the deck
* claiming a shared scale it no longer has. A press says something a reader
* can rely on — *these are all on that one's numbers now* — and the very next
* nudge is honestly their own again. The same shape as the download beside it,
* which is the other thing in this bar that does something rather than being
* something.
*
* The first map goes through the session (see
* {@link PanelDeckProps.onLeadScale}), because a clip written straight onto
* its panel is one the next render puts back — its colour lives in the view
* state. Every other panel is told directly: a companion's scale is its own
* and is in no state to be restored from.
*/
private matchScales(): void {
const look = this.starredLook()
if (look === null) return
if (this.starred !== LEAD_MAP) this.props.onLeadScale?.(look)
for (const slot of this.slots) {
if (slot.id === this.starred) continue
slot.panel?.applyLook(look)
}
this.warn('')
}
/** The bin size the deck is being asked to put every panel on. */
private starredBinsize(): number | undefined {
if (this.starred === null) return undefined
const panel = this.starredPanel
if (panel !== null) return panel.binsize()
return this.props.binsize?.()
}
/**
* Read every panel at the starred map's bin size — the *match all
* resolutions* press.
*
* An action for {@link matchScales}'s reason, and **exact** for
* {@link MapPanel.useBinsize}'s: a file that has not got that level stays
* where it is and says so under its own map, rather than being moved to the
* nearest thing and leaving the deck at two resolutions under a button that
* has just claimed one. The first map is named in the deck's own line instead,
* since it is the one panel with no frame of its own to be told in.
*/
private matchResolutions(): void {
const binsize = this.starredBinsize()
if (binsize === undefined || !Number.isFinite(binsize) || binsize <= 0) return
const refused: string[] = []
if (this.starred !== LEAD_MAP && this.props.onLeadBinsize?.(binsize) === false) {
refused.push(this.props.leadName?.() ?? 'the first map')
}
for (const slot of this.slots) {
if (slot.id === this.starred || slot.panel === null) continue
if (!slot.panel.useBinsize(binsize)) refused.push(fileLabel(slot.panel.uri))
}
this.warn(
refused.length === 0
? ''
: `${refused.join(', ')} ${refused.length === 1 ? 'has' : 'have'} no ` +
`${resolutionLabel(binsize)} level and stayed where ${refused.length === 1 ? 'it is' : 'they are'}.`,
)
}
/**
* Take every companion to the resolution the session's own map just moved to.
*
* A reader who changes the first map's rung means the deck, not one cell of
* it: the whole claim a deck makes is that its pictures are of one place and
* can be read against each other, and half of them at 1 kb beside the rest at
* 10 kb is a claim it is no longer making. The same rule
* {@link matchResolutions} follows — exact, or the panel stays where it is and
* says why — because *this file has not got that level* is a fact about the
* file that no amount of good intention changes.
*
* Watched from {@link apply} rather than reported by the session, so every
* road to a new rung arrives here: the breadcrumb's picker, a link, and the
* deck's own button.
*/
private followLeadResolution(binsize: number): void {
for (const slot of this.slots) slot.panel?.useBinsize(binsize)
}
/**
* Show the add row and put the caret in it — the shell's "add a map", and the
* bar's own button.
*
* The bar is repainted because the button is a toggle and says which way it
* is pointing; that is cheap and it is what {@link paintBar} is for.
*/
promptAdd(): void {
this.addRow.classList.remove('hidden')
this.paintBar()
this.urlInput.focus()
}
/** Put the add row away again, without opening anything. */
private hideAdd(): void {
if (this.addRow.classList.contains('hidden')) return
this.addRow.classList.add('hidden')
this.paintBar()
}
/**
* Every map a track can be drawn on, in the order they stand in the grid.
*
* The lead where it stands (§16.9) — and while it is hidden too, since it
* is still the session's map and its eye brings it back with its lanes. An
* empty cell is not offered: a placement on a map that holds no file would be
* a lane waiting for a picture, and the reader can place it the moment one
* arrives.
*/
get mapList(): Array<{ id: string; label: string; edges?: readonly LaneEdge[]; tracks?: true }> {
const out: Array<{ id: string; label: string; edges?: readonly LaneEdge[]; tracks?: true }> = []
for (const slot of this.order()) {
if (slot === LEAD_CELL) {
out.push({ id: LEAD_MAP, label: this.props.leadLabel?.() ?? 'this map' })
continue
}
if (slot.panel === null) continue
// The panel's **own** URI, which is neither the ref's nor the slot's id.
// Not the id: it used to fall back to one for anything that was not a
// remote file, which is every local companion — so a reader who dropped
// `rep2.cool` on a cell was offered `p3` as the name of the map to draw
// their bigWig on, in a list where every other row said what it was. And
// not the ref's URI either, because a companion that descended into an
// entry of a collection is showing `rep2.mcool::1000` and the ref catches
// up to that only after `onResolved` has been round the houses.
//
// Through `mapLabel`, so a companion the reader has **renamed** is called
// what they called it here too (§16.10: one name, everywhere the map is
// named). This row was written before renaming existed and kept the file
// name after it landed, so the one control that lists the whole deck said
// "G1" for cell 0 and `mat_G2M.mcool::1000` for the cell beside it. A
// name is filed under the path before `::` (`ui/mapNames.ts`), so
// resolving the entry above costs nothing here: the rename is found
// either way, and `Session.mapLabel` falls back to this same `fileLabel`
// for a map nobody has named.
out.push({
id: slot.id,
label: this.props.mapLabel?.(slot.panel.uri) ?? fileLabel(slot.panel.uri),
})
}
// A tracks cell is a place a track can be put, with one edge (§25.3).
// After the maps, under the name on its heading: the reader's, or numbered
// where there is none, since two stacks of tracks would otherwise be two
// rows with one name. Marked as one, because it has no matrix for an
// overlay to be drawn on (`ui/lanePlacement.ts`'s `overlayMapsField`).
for (const slot of this.slots) {
const cell = tracksIn(slot)
if (cell !== null) out.push({ id: slot.id, label: cell.label, edges: ['bottom'], tracks: true })
}
return out
}
/** `true` when there is nothing here but the lead — the deck may be put down. */
get isEmpty(): boolean {
return this.slots.length === 0
}
relayout(): void {
for (const slot of this.slots) (slot.panel ?? slot.cell)?.remeasure()
}
/** Ask every companion for a frame; see `MatrixPanel.repaint` (§8.12). */
repaint(): void {
for (const slot of this.slots) (slot.panel ?? slot.cell)?.repaint()
}
destroy(): void {
this.destroyed = true
this.unsubscribeHover()
this.stopLanding()
// Before anything else: the heading is the *view's*, it outlives this deck,
// and a session that puts its last companion down must get it back rather
// than lose its locus box with the grid.
this.lowerHead()
for (const slot of this.slots) {
slot.panel?.destroy()
slot.vacancy?.destroy()
slot.cell?.destroy()
}
this.slots = []
this.lock.leave(LEAD)
// The one thing here that outlives the deck. The lead's panel belongs to the
// mounted view, so a listener left on it would go on reporting into a lock
// nothing can reach, once per frame, for as long as that view is on screen.
this.lead?.setViewportListener(null)
this.lead?.setLaneListener(null)
this.lead?.setHoverListener(null)
this.lead?.setLaneHoverListener(null)
// …and the room it was holding for maps that are no longer beside it, or the
// last panel put down would leave the first one padded out for ever.
this.lead?.setLaneFloor({ top: 0, right: 0, bottom: 0, left: 0 })
this.lead?.setDeckExport(null)
// A map on its own again, whose card has nothing to choose between.
this.lead?.setCardFor(null)
this.lead = null
this.leadAxis?.setDeckExport?.(null)
this.leadAxis = null
}
/**
* Put a small mark where one panel's pointer is on every *other* panel.
*
* The full crosshair stays where the pointer is, and that asymmetry is the
* whole design: exactly one map has a pointer over it, and five sets of rules
* across five pictures claim five pointers while covering the data the deck
* exists to compare. What the others owe the reader is *where is that here*,
* which a cross the size of a cursor answers.
*
* Converted through **base pairs from each block's own start**, as the lock
* is and for the same reason: a 1 kb file and a 5 kb file answer one name with
* blocks of different cell counts, and a mark placed by cell index would land
* five times too far along the coarse one. Cheap enough to run per pointer
* move — two divisions per panel, and each panel repaints only when its own
* cell actually changed.
*
* Base pairs at bin level, that is. Above it a cell is a whole sequence with
* no width in base pairs, and dividing by the file's bin size anyway put the
* pointer over chromosome 12 of a 1 kb roll-up and a mark on chromosome 3 of
* the 5 kb one beside it, with nothing said anywhere — {@link carryBetween}
* is where that decision lives now, for this and for the lane echo alike.
*/
private echoHover(
from: string,
source: MatrixPanel,
cell: { row: number; col: number } | null,
): void {
const fromPlace = this.placeOf(from)
const show = (id: string, panel: MatrixPanel | null): void => {
if (panel === null || id === from) return
// Two blocks that are not one place — a companion reading a window of its
// own (§16.3) — share no cell origin, so the pointer is carried as the
// contact it is over rather than as a cell index.
if (this.placeOf(id) !== fromPlace) {
const contact = cell === null ? null : source.contactAt(cell)
panel.showHoverEcho(contact === null ? null : panel.cellOfContact(contact))
return
}
const carry = cell === null ? null : carryBetween(source, panel)
if (cell === null || carry === null) {
panel.showHoverEcho(null)
return
}
const theirs = carry.theirs > 0 ? carry.theirs : 1
const extent = panel.cellCount()
const row = Math.floor(((cell.row + 0.5) * carry.mine) / theirs)
const col = Math.floor(((cell.col + 0.5) * carry.mine) / theirs)
// Off the end of a shorter block is *nothing here*, not the last cell: a
// mark clamped to the edge would say the pointer is over a place this
// file has, which is the one thing a deck must not claim.
const inside = row >= 0 && col >= 0 && row < extent.rows && col < extent.cols
panel.showHoverEcho(inside ? { row, col } : null)
}
show(LEAD, this.lead)
for (const slot of this.slots) show(slot.id, slot.panel?.map ?? null)
}
/**
* The same, for a pointer on a **track** rather than on a map.
*
* A hand moving along one profile is asking "what is here" of every profile on
* screen — that is what a deck is for — and until now it was asked of one. The
* panel under the pointer draws its own full guide; the others get a tick in
* the stacks that measure the same axis and a small mark where that place
* stands on their picture ({@link MatrixPanel.showLaneEcho}).
*
* Converted through base pairs from each block's own start, exactly as
* {@link echoHover} is and for the same reason — and here the conversion earns
* its keep twice over, because a **turned** panel counts its columns in half
* bins. A unit carried across untouched would land at half the position on a
* band beside a square, or twice it the other way; a base pair is a base pair
* on both.
*
* Fractional at the far end, unlike the cell echo: what is being carried is a
* position rather than a cell, and rounding it onto a cell boundary would move
* the mark by half a bin on the coarser panel — visible at the zoom a reader
* hovers a track at, and pointless, since nothing downstream indexes with it.
*/
private echoLaneHover(
from: string,
source: MatrixPanel,
at: { axis: 'rows' | 'cols'; unit: number } | null,
): void {
const fromPlace = this.placeOf(from)
const show = (id: string, panel: MatrixPanel | null): void => {
if (panel === null || id === from) return
// Not one place, so no unit to carry: nothing here, rather than a mark as
// far off as the two blocks' starts are apart (§16.3).
if (this.placeOf(id) !== fromPlace) {
panel.showLaneEcho(null)
return
}
// The same currency the cell echo uses, and above bin level the same
// refusal: a cell there is a whole sequence, so the index is carried
// untouched and a panel drawing a different level gets nothing rather
// than a mark on the wrong chromosome.
const carry = at === null ? null : carryBetween(source, panel)
if (at === null || carry === null) {
panel.showLaneEcho(null)
return
}
const extent = panel.cellCount()
const unit = carriedUnit(
{ unit: at.unit, bpPerCell: carry.mine },
{
bpPerCell: carry.theirs,
cells: at.axis === 'cols' ? extent.cols : extent.rows,
},
)
panel.showLaneEcho(unit === null ? null : { axis: at.axis, unit })
}
show(LEAD, this.lead)
for (const slot of this.slots) show(slot.id, slot.panel?.map ?? null)
}
/** Which window a map's block is of, `''` for the deck's; see `MapPanel.placeKey`. */
private placeOf(id: string): string {
if (id === LEAD) return ''
return this.slots.find((slot) => slot.id === id)?.panel?.placeKey ?? ''
}
/**
* Reserve, on every panel, the room the *deepest* stack on each edge takes.
*
* The deck's whole promise is that the pictures in it are of one place and
* can be read against each other, and a map inset by a stack of tracks beside
* a map that is not is a comparison the eye has to correct for first.
*
* This used to be the lead's own geometry pushed onto companions that had no
* lanes at all. They can have them now — a track goes on any edge of any map
* (§16.8) — so the figure is the largest across the deck, and every panel
* including the lead pads out the difference between that and its own stack.
*
* **Pulled, not accumulated.** Each panel announces its stacks whenever they
* change, and the announcements arrive in no particular order — a companion
* that finishes reading first reports before the lead has drawn anything. A
* maximum kept as panels report is therefore a maximum over whoever has
* spoken so far, which reserved nothing at all on the first pass; asking all
* of them at the moment of use has no such order to get wrong.
*/
private align(geometry: PanelGeometry | null): void {
if (geometry !== null) this.leadGeometry = geometry
// A floor set on a panel resizes its plot, which is a report, which lands
// back here. The floors are idempotent, so the second pass changes nothing
// and stops — but it is still a layout per panel per pass, and this runs
// from a resize observer.
if (this.aligning) return
this.aligning = true
try {
const held = this.leadGeometry
const floor = deepestStacks([
held.lanes,
...this.slots.map((slot) => ({
top: slot.panel?.laneRoom('top') ?? 0,
right: slot.panel?.laneRoom('right') ?? 0,
bottom: slot.panel?.laneRoom('bottom') ?? 0,
left: slot.panel?.laneRoom('left') ?? 0,
})),
])
for (const edge of LANE_EDGES) {
this.grid.style.setProperty(`--deck-lane-${edge}`, `${floor[edge]}px`)
}
this.lead?.setLaneFloor(floor)
for (const slot of this.slots) slot.panel?.setLaneFloor(floor)
// The lead's plot size, **measured**, not derived a second time from the
// same variables. A companion sized by the same stylesheet still lands
// somewhere else — its cell holds different content, so one `clamp`
// bottoms out where the other is capped by its column — and there is no
// reading of the rules that fixes that, only a number both can be given.
const plot = Math.round(held.plot)
this.grid.style.setProperty('--deck-plot', plot > 0 ? `${plot}px` : '')
// And its height, which is the width only while the picture is a square.
// An empty cell is a card the size of a *map*, and it has no map to ask —
// so with only the width to go on it drew itself square, which under a
// turn is several times the height of the band beside it, set the height
// of the whole grid row, and left every map in that row standing at the
// foot of a rectangle of air (`ui/styles.css`'s `.deck-vacant`).
const plotHeight = Math.round(held.plotHeight)
this.grid.style.setProperty('--deck-plot-h', plotHeight > 0 ? `${plotHeight}px` : '')
for (const slot of this.slots) (slot.panel ?? slot.cell)?.remeasure()
} finally {
this.aligning = false
}
}
// -------------------------------------------------------------------------
// The list
// -------------------------------------------------------------------------
/**
* Bring the held panels in line with a list of refs.
*
* Panels are matched by URI and **kept**, not rebuilt: a link that adds a
* fourth map must not put down the three workers that are already open and
* re-read their files. Everything that is not in the new list is destroyed
* here, which is the one place a companion's worker is released other than
* {@link destroy}.
*/
private adopt(wanted: readonly PanelRef[], locals: readonly ResolvedLocal[] = []): void {
// A *queue* per URI, not one slot per URI. The same file twice is a
// legitimate deck — the plainest way to read one map at two colour scales —
// and keyed one-to-one the second slot overwrote the first, so the first
// never appeared in the reuse map, never reached the orphan loop, and kept
// its worker, its h5wasm instance and its dense block for the life of the
// tab with its element already dropped from the grid.
const spare = new Map<string, Slot[]>()
for (const slot of this.slots) {
if (!isMapRef(slot.ref)) continue
const queue = spare.get(slot.ref.uri)
if (queue === undefined) spare.set(slot.ref.uri, [slot])
else queue.push(slot)
}
const reused = new Set<Slot>()
const next: Slot[] = []
this.placed = next
for (const [index, ref] of wanted.slice(0, MAX_PANELS - 1).entries()) {
if (isMapRef(ref)) {
const existing = spare.get(ref.uri)?.shift()
if (existing !== undefined) {
reused.add(existing)
next.push(existing)
continue
}
} else if (ref.kind !== 'vacant') {
// A structure cell is keyed by its kind: the deck holds one (§25), and
// rebuilding it for a link that merely re-lists it would throw away a
// camera the reader had just set.
const existing = this.slots.find((slot) => !reused.has(slot) && slot.ref.kind === ref.kind)
if (existing !== undefined) {
reused.add(existing)
next.push(existing)
continue
}
}
const local = locals.find((entry) => entry.index === index)
// A local ref reaching `build` **must** carry its source. Without one it
// falls through to the remote default, which would fetch a bare file name
// — against the site root on the web, against `app://viewer/` in the
// desktop build — and fail in a way that looks like a broken deck rather
// than a spent grant. `withLocalCompanions` only ever promotes a cell that
// has one, so this pairing holds by construction; the `??` is the belt.
if (ref.kind === 'local' && (local?.source ?? null) === null) {
next.push(this.build({ kind: 'vacant' }, undefined, 'remembered', ref.uri))
continue
}
next.push(
local === undefined
? this.build(ref)
: local.source === null
? this.build(ref, undefined, 'remembered', local.uri)
: this.build(ref, local.source),
)
}
// Swept over what was actually held rather than over what is left in the
// reuse map, which is what brings vacancies into the sweep: a vacancy has no
// URI to be keyed by, so one that disappeared from the list used to be
// dropped from `slots` with its drop rectangle still listening.
for (const slot of this.slots) {
if (reused.has(slot)) continue
this.lock.leave(slot.id)
slot.panel?.destroy()
slot.vacancy?.destroy()
slot.cell?.destroy()
}
this.slots = next
this.placed = []
// A tracks cell built here takes the name and the height its seat was left
// with — before `paintGrid`, whose publish writes both back from the live
// cells and would otherwise write this deck's plain ones over the memory it
// is restoring from. A cell kept from the deck before keeps its own.
const names = this.recallTracksNames()
const heights = this.recallTracksHeights()
next
.filter((slot) => slot.ref.kind === 'tracks')
.forEach((slot, seat) => {
if (reused.has(slot)) return
tracksIn(slot)?.setName(names[seat] ?? null)
tracksIn(slot)?.setHeight(heights[seat] ?? null)
})
// A link, or a restored session, can name fewer maps than the star knew
// about — and a star on a slot that was not rebuilt would leave the Analysis
// column pointed at a picture that is not on screen. Reconciled by
// `paintGrid`, along with every other way the list can change.
this.paintGrid()
}
private build(
ref: PanelRef,
source?: SourceSpec,
origin: VacancyOrigin = 'link',
/** The file a `remembered` vacancy is standing in for. */
name?: string,
/**
* The id to build under, where a cell becomes another kind of cell in place
* — a map hidden from a cell that still has tracks drawn in it becomes that
* cell's tracks, and the tracks are placed by the cell's id ({@link vacateMap}).
*/
id?: string,
): Slot {
// A chain the reader deliberately opened stays open across a rebuild and
// across a restore: a panel put back on the lead would jump to the deck's
// window on the first pan, which is the one thing unhooking it said not to
// do. `locked` where nothing was remembered, which is how a fresh panel
// arrives (§16.2).
const held = isMapRef(ref) ? this.lookFor(ref.uri) : undefined
const slot: Slot = {
id: id ?? `p${nextSlotId++}`,
ref,
panel: null,
vacancy: null,
cell: null,
locked: held?.locked !== false,
}
if (isMapRef(ref) && this.props.mapsAllowed?.() === false) {
// A map named beside a lead that is not one (§25.3): held as the
// cell it would have been, under its name, rather than opened beside a
// browser it could not follow — and rather than dropped from the link,
// which would lose the reader's arrangement for opening it in the
// wrong session.
slot.vacancy = new VacantPanel({
origin: 'remembered',
name: ref.uri,
onOpen: (file) => this.fill(slot, { uri: file.name, source: { kind: 'local', file } }),
onOpenUrl: (url) => this.occupy(slot, { kind: 'remote', uri: url }),
onStructure: (id) => this.putStructure(slot, id),
...(this.takesTracks() ? { onTrack: (id: string) => this.putTrack(slot, id) } : {}),
onPicked: (picked) => this.fill(slot, picked),
onMapRow: (row) => this.putMapRow(slot, row),
onClose: () => this.remove(slot),
})
return slot
}
if (ref.kind === 'structure') {
const shared = this.props.structure
const contacts = shared?.contacts
slot.cell = new StructurePanel({
id: slot.id,
store: () => shared?.store(),
manual: () => shared?.manual?.(),
client: () => shared?.client?.(),
bookmarks: () => shared?.bookmarks?.(),
// Passed only where the session offers it, since the cell offers
// *colour by contacts* on the strength of its presence.
...(contacts === undefined
? {}
: {
contacts: (from: { contig: string; bp: number }, to: ReadonlyArray<{ contig: string; bp: number }>) =>
contacts(from, to),
contactsScale: () => shared?.contactsScale?.() ?? null,
}),
// What the *other* structure cells are drawing, so this one does not
// **fall** to a model already on screen. Only the fallback: a reader
// who picks the same model in two cells gets it in two cells (§25.3),
// and this is about which model a cell nobody has chosen for opens at.
taken: () =>
[...new Set([...this.slots, ...this.placed])]
.filter((held) => held !== slot && held.ref.kind === 'structure')
.map((held) => held.cell?.shownModel?.() ?? null)
.filter((id): id is string => id !== null),
// Which structure cell this is, counting from the left — its **seat**.
// What a cell remembers (its model, its camera) is remembered under it,
// because the deck may now hold several and everything they remember
// used to collide in one slot: two cells restored from a link both
// recalled the one remembered model, so a deck of two views came back
// as the same view twice. The seat and not the slot's id, which is
// minted fresh on every build and would remember nothing across a
// reload; the seats are restored in the order the hash lists them.
seat: () => this.slots.filter((held) => held.ref.kind === 'structure').indexOf(slot),
// Passed straight through: what the column already offers is the
// session's to know — it is the session that puts the cards in it.
...(shared?.sharedElsewhere === undefined
? {}
: { sharedElsewhere: () => shared.sharedElsewhere?.() ?? [] }),
memoryKey: () => this.props.memoryKey(),
onStar: () => this.setStarredStructure(slot.id),
// How many cells the card writes to, and the road to all of them: every
// structure cell while none is starred (§25.3), and this one otherwise.
together: () => (this.starredStructure === null ? this.structureCells().length : 1),
forEachStructure: (act) => {
for (const held of this.structureCells()) act(held)
},
onClose: () => this.remove(slot),
onGoTo: (range) => shared?.onGoTo(range),
onDrop: (file) => shared?.onDrop(file),
onDropUrl: (url) => shared?.onDropUrl(url),
onDragChange: (dragging) => this.setArranging(dragging),
onShownChange: () => this.props.onStructuresChange?.(),
})
// What the maps are looking at, from the moment the cell exists rather
// than from the lead's next pan: the lead's window is where it was.
const windows = this.leadWindows()
if (windows !== null) slot.cell.applyWindow(windows)
return slot
}
if (ref.kind === 'tracks') {
const shared = this.props.tracks
slot.cell = new TracksPanel({
id: slot.id,
context: () => shared?.context(),
onClose: () => this.remove(slot),
onFollow: (range) => this.followColumns(range),
onDragChange: (dragging) => this.setArranging(dragging),
leadSampleWidth: () => this.lead?.laneAcrossPixels() ?? 0,
defaultName: () => this.tracksDefaultName(slot),
onRename: () => {
this.rememberTracksCells()
this.props.onCellRenamed?.()
},
onResize: () => this.rememberTracksCells(),
})
const windows = this.leadWindows()
if (windows !== null) slot.cell.applyWindow(windows)
return slot
}
if (ref.kind === 'vacant') {
slot.vacancy = new VacantPanel({
origin,
...(name === undefined ? {} : { name }),
onOpen: (file) => this.fill(slot, { uri: file.name, source: { kind: 'local', file } }),
// Through `occupy` like the file road, so the cell the reader typed into
// is the cell that opens — {@link add} would look for the *first* empty
// one, which in a 2 × 2 with three gaps is not the one they aimed at.
onOpenUrl: (url) => this.occupy(slot, { kind: 'remote', uri: url }),
onStructure: (id) => this.putStructure(slot, id),
// A track row from the Tracks card, and a row out of the Files panel —
// the two roads an empty cell did not take, so that a cell drawn with
// a `+` takes whatever a deck can hold (§16.9).
...(this.takesTracks() ? { onTrack: (id: string) => this.putTrack(slot, id) } : {}),
onPicked: (picked) => this.fill(slot, picked),
onMapRow: (row) => this.putMapRow(slot, row),
onClose: () => this.remove(slot),
})
return slot
}
slot.panel = new MapPanel({
uri: ref.uri,
source: source ?? { kind: 'remote', url: splitPath(ref.uri) },
// Divided between the cells that hold a **file**, not between the cells.
// An empty card has no worker and no block, so counting it would shrink
// every real panel's allowance to pay for rectangles that cost nothing —
// and under §16.9 a reader draws the empty ones first, so a 2 × 2 deck
// with two maps in it would read both at a quarter of the allowance
// instead of a half. Still a live count, so filling the third cell still
// makes the fourth read smaller (§16.7).
budgetBytes: () => panelBudgetBytes(this.filled, deviceDenseBudgetBytes()),
onSettled: () => this.settle(slot),
onDrawn: () => this.props.onDrawn?.(),
onClose: () => this.hideMap(slot),
onToggleLock: () => this.toggleLock(slot),
onStar: () => this.setStarred(slot.id),
isLocked: () => slot.locked,
lockNote: () => this.lockNote(slot),
// The region names every panel is following are the *lead's*, so the
// lead's reading of its own numerals is the one a companion has to
// resolve them under.
naming: () => this.props.leadNaming?.(),
circular: () => this.props.circular?.() ?? [],
derive: () => this.props.derive?.(),
turn: () => this.props.turn?.(),
annotations: () => this.props.annotations?.(slot.id),
// A track placed on this panel alone changes what every other panel has
// to leave room for, so its own stacks are the deck's business (§16.8).
onLanes: () => this.align(null),
score: () => this.props.score?.(),
// The lead's scale, clip included. A map opened beside another is opened
// to be compared with it, and a comparison whose two halves are on two
// clips is one the eye has to correct for before it can read anything —
// so the honest default is the one that makes the same colour the same
// number, and the reader who knows their libraries differ in depth takes
// this panel off it with one nudge of its own clip. Not the *live* scale
// but `baseScale`, which is the same thing minus whatever a derivation
// borrowed: a lead under a two-file `ratio` is on `log2` and a diverging
// ramp, and a companion drawing plain counts must not inherit that.
initialLook: () => this.leadBaseLook(),
// Read against the ref as it stands rather than against the `ref` captured
// above, because a companion handed a collection resolves itself to one of
// its entries and rewrites the slot ({@link resolveRef}) — and it is the
// resolved URI the look was written under.
remembered: () => (isMapRef(slot.ref) ? this.lookFor(slot.ref.uri) : undefined),
onLook: (look) => {
if (isMapRef(slot.ref)) this.noteLook(slot.ref.uri, { ...look, locked: slot.locked })
},
preferBinsize: () => this.props.binsize?.(),
onResolved: (uri) => this.resolveRef(slot, uri),
onDragChange: (dragging) => this.setArranging(dragging),
// Against the *slot's* ref rather than the one captured above, for
// {@link remembered}'s reason: a companion handed a collection rewrites
// itself into one of its entries, and a name is filed under the file.
label: () => (isMapRef(slot.ref) ? this.props.mapLabel?.(slot.ref.uri) : undefined),
onRename: (name) => {
if (isMapRef(slot.ref)) this.props.onRenameMap?.(slot.ref.uri, name)
},
// A card that was built or rebuilt is the column's business only while
// this map is the starred one; it becomes the column's card then (§16.5).
onCardChange: () => {
if (slot.id !== this.starred) return
this.paintCardsFor()
this.props.onMapCardChange?.()
},
onSelectRegion: (selection) => this.boxDrawn(slot, selection),
// A map reading a window of its own is not one place with the others, so
// the chain's line and the pointer echoes have to be asked again.
onOwnPlace: () => slot.panel?.syncLock(),
onPickSequence: (name) => this.sequencePicked(slot, name),
})
slot.panel.syncLock()
return slot
}
/**
* A sequence picked on a companion's heading (§16.3): that map reads it for
* itself and the others stay where they are. Off the chain first, where it
* was on it — a map on the chain shows the lead's window by definition, and
* the chain is what closing it again gives back.
*/
private sequencePicked(slot: Slot, name: string): void {
if (slot.panel === null) return
if (slot.locked) this.toggleLock(slot)
slot.panel.readSequence(name)
}
/**
* A companion descended into an entry of a collection: publish what it opened.
*
* The link has to name the map rather than the `.mcool` it lives in, and not
* as a nicety: a recipient's deck resolves the root the same way, but against
* *their* lead's bin size, so the same link would show a different rung of
* the ladder to the two people looking at it (§3.4, §16.6).
*/
private resolveRef(slot: Slot, uri: string): void {
if (!isMapRef(slot.ref) || slot.ref.uri === uri) return
slot.ref = { kind: slot.ref.kind, uri }
this.publish()
// A **starred** panel that moved rung is a different file to an analysis:
// the facts it answers with name a URI, and the one it was holding pointed
// at the resolution it used to be at. Nothing else re-reads them — the panel
// fetches them once and keeps them, which is right, so the invalidation has
// to happen where the address changes. Without this, picking `::5000` on the
// starred companion and pressing a task ran it against `::1000` and captioned
// the result with the rung on screen.
if (slot.id !== this.starred || slot.panel === null) return
void slot.panel.prepareAnalysis(() => this.props.onStarChange?.())
this.props.onStarChange?.()
}
/**
* A companion finished a read: join it to the lock, or say why it cannot.
*
* The gate is `spansAgree` and it is checked against the *blocks* rather than
* the files (`panels/lock.ts`). Two panels that resolved the same name to
* spans of different length resolved it against different sequences, whatever
* the name says, and a lock between them would draw one file's coordinate
* under another's. Everything else — a different bin size above all — is
* fine, and being fine is the whole point of panels over a blend.
*
* The currency the panel joins in is {@link lockUnit}'s, which above bin
* level is the cell index rather than base pairs: a cell there is a whole
* sequence and has no width to convert through.
*/
private settle(slot: Slot): void {
if (this.destroyed) return
const map = slot.panel?.map ?? null
if (map === null) {
this.lock.leave(slot.id)
slot.panel?.syncLock()
// A file can open and its first block still fail to draw; it is open
// all the same, and a comparison reads the file rather than the picture.
this.notePeers()
return
}
// Nothing pushed here. A companion opens on the first map's base look and
// its bin size (§3.4, {@link MapPanelProps.initialLook}), and what the two
// buttons in the bar do is a *press* rather than a state a newcomer has to
// be brought into line with.
this.lock.join({
id: slot.id,
unit: () => lockUnit(map),
bpPerCell: () => map.bpPerCell(),
cells: () => map.cellCount(),
locked: () => this.lockNote(slot) === null,
show: (rows, cols) => map.showViewport(rows, cols),
})
map.setViewportListener((rows, cols) => this.lock.report(slot.id, rows, cols))
map.setHoverListener((cell) => this.echoHover(slot.id, map, cell))
map.setLaneHoverListener((at) => this.echoLaneHover(slot.id, map, at))
// Before the lock and before the note: a panel that has just cut its band
// from whatever height its cell had while the grid was settling is put on
// the deck's distance first, so `lockNote` is asked about two bands that
// already agree rather than about a layout race.
this.syncTurnReach()
slot.panel?.syncLock()
this.seedFromLead()
this.lock.catchUp(slot.id)
this.paintBar()
this.notePeers()
}
/**
* Tell the lock where the lead is, for a panel about to be caught up to it.
*
* The lock learns a window from a panel *reporting* one, and a panel reports
* when it draws. Both of the moments a deck catches a panel up are moments
* where the lead may not have drawn since the lock was built:
*
* - a **deck is created** by the reader adding a second map, and the map they
* added it beside was drawn — and reported nothing, because until that press
* there was no lock listening — while they were choosing the file. So every
* pan and zoom they had made up to that point was invisible to the deck, and
* the companion opened on its own fitted view: a whole contig beside a lead
* showing 40 kb of it, under a bar claiming one navigation.
* - a **navigation resets** the window ({@link ViewportLock.reset}), and a
* companion that finishes its read before the lead has drawn the new block
* lands in the same gap.
*
* It worked most of the time, which is what made it worth fixing rather than
* leaving: re-parenting the lead into the grid resizes it, a resize is a
* redraw and a redraw is a report, so the window usually arrived a frame after
* the deck was built and a frame before the companion's file had been fetched
* over the network. A deck that lines up because the network is slower than a
* relayout is not a deck that lines up.
*
* Nothing is seeded from a lead the reader has taken off the lead themselves:
* an unlocked first map is one that is deliberately not driving, and a
* companion arriving beside it should be caught up to wherever the *deck* got
* to, or to nowhere.
*/
private seedFromLead(): void {
if (!this.leadLocked) return
const lead = this.lead
if (lead === null) return
const view = lead.viewport()
if (view === null) return
// In the lead's own currency, which above bin level is the cell index
// rather than base pairs ({@link lockUnit}) — a seed stated in the wrong
// one is the same wrong window as a report in the wrong one, arriving
// before anybody has had the chance to correct it.
const unit = lockUnit(lead)
this.lock.seed(view.rows, view.cols, unit === 'cell' ? 1 : lead.bpPerCell(), unit)
}
/**
* Why this panel is not following the deck, or `null` when it is.
*
* One answer for the chain icon, the panel's own line and the lock itself, so
* a panel that says it is following cannot be one the lock is skipping. That
* disagreement is the only way a navigation lock can be *quietly* wrong, and
* a reader would read the still map as data rather than as a refusal.
*/
private lockNote(slot: Slot): string | null {
if (!slot.locked) return 'moving on its own'
const map = slot.panel?.map ?? null
const lead = this.lead
if (map === null || lead === null) return null
// **Neither panel is compared until both have a block.** A panel that has
// not read one answers `1 × 1` cells, which multiplied by its bin size is a
// span of one bin — and a companion settling while the lead was still
// reading was told "this block spans 16.6 Mb × 16.6 Mb where the first map
// spans 1.0 kb × 1.0 kb. The same name resolved against different
// sequences", which is an accusation about the files built out of a race.
// Nothing is owed here: `settle` runs again when the lead reports, and the
// note is recomputed then against two real blocks.
if (!map.hasBlock || !lead.hasBlock) return null
// **What a cell is has to agree before what it holds is compared.** A cell
// is part of a sequence at bin level and a whole sequence above it, and no
// one number is a window on both — so the lock skips such a pairing
// (`panels/lock.ts`) and this is what keeps the chain icon from saying
// "following" over a panel nothing is driving. It is a transient: the
// companion is mid-read of the level the deck has just moved to, and
// `settle` re-asks the moment that read lands.
const level = map.blockLevel()
if (level !== lead.blockLevel()) {
return (
'not following yet: this map is still drawing the level the deck has just left. A cell ' +
'is part of a sequence at bin level and a whole sequence above it, so one window cannot ' +
'be both. It comes back into step when its own read of this level lands.'
)
}
// The spans, and **not** `cells × bpPerCell`: above bin level a cell is a
// whole sequence, so the cell count is a number of chromosomes and the bin
// size is a fact about the file, and their product is not a length of
// anything. Multiplying them told two roll-ups of one 16-chromosome genome,
// at 1 kb and 5 kb, that they spanned 16 kb and 80 kb and that the same
// names had resolved against different sequences — the false accusation
// this whole gate exists to avoid making (§16.4).
const mine = map.blockSpan()
const theirs = lead.blockSpan()
const rows = spansAgree(
{ spanBp: mine.rows, bpPerCell: map.bpPerCell() },
{ spanBp: theirs.rows, bpPerCell: lead.bpPerCell() },
Math.max(mine.sequences.rows, theirs.sequences.rows),
)
const cols = spansAgree(
{ spanBp: mine.cols, bpPerCell: map.bpPerCell() },
{ spanBp: theirs.cols, bpPerCell: lead.bpPerCell() },
Math.max(mine.sequences.cols, theirs.sequences.cols),
)
if (rows && cols) {
if (level === null || level === 'bin') return null
// Above bin level the deck carries the **cell index** ({@link lockUnit}),
// and that is only honest while cell `i` is the same sequence on both
// sides. Two axes of equal length that agree about how much sequence they
// hold are that; two that rolled the same assembly up into different
// numbers of cells — one of them pooling several small sequences per cell
// because its panel is narrower — are not, and there is no index to
// carry between them.
const cells = map.cellCount()
const leadCells = lead.cellCount()
if (cells.rows === leadCells.rows && cells.cols === leadCells.cols) return null
return (
'not following: this map rolls up into ' +
`${fmt.int(cells.rows)} × ${fmt.int(cells.cols)} cells where the first map makes ` +
`${fmt.int(leadCells.rows)} × ${fmt.int(leadCells.cols)}. Above bin level a window is ` +
'carried as a cell index, and cell for cell these two are not the same sequences. ' +
'Switching back to bin level puts this panel in step.'
)
}
// A turned panel's rows are **separation**, not position, so a row
// disagreement there is a different fact from a column one and must not
// borrow its sentence. The deck cuts every companion's band to the first
// map's reach, in base pairs ({@link syncTurnReach}), so two bands agree by
// construction — except where a companion's block does not hold that much,
// since a band cannot be deeper than its block has cells
// (`render/rotate.ts`'s `turnDepthFor`). That is a real reason not to share
// a row window, and is nothing whatever to do with the sequences agreeing.
// Telling a reader their files resolved one name against different
// sequences when they did not is worse than not telling them anything: it
// is a claim they may act on. A cell is half a bin under a turn and height
// is half of separation, so the number a reader wants is twice the lock's.
if (map.isTurned() && lead.isTurned() && cols) {
return (
'not following while turned: this band reaches ' +
`${fmt.bp(mine.rows * 2)} from the diagonal where the first map ` +
`reaches ${fmt.bp(theirs.rows * 2)}. The deck cuts every band to the first map’s reach, ` +
'and this map’s block does not hold that much — so one row window would be two ' +
'distances. Turning the deck back off puts this panel in step.'
)
}
return (
'not following: this block spans ' +
`${fmt.bp(mine.rows)} × ${fmt.bp(mine.cols)} where the ` +
`first map spans ${fmt.bp(theirs.rows)} × ` +
`${fmt.bp(theirs.cols)}. The same name resolved against different ` +
'sequences, so one window would be two places.'
)
}
/**
* A box drawn on a companion (§16.3). Following the deck, it moves the deck —
* the first map re-reads that window by its own road and every map follows,
* each re-reading it from its own file at its own resolution. Moving on its
* own, it reads that window for this map alone, which is what lets three
* cells of one file be read at 640 kb, 80 kb and 10 kb over three nested
* windows rather than three magnifications of one block.
*/
private boxDrawn(slot: Slot, selection: SelectedRegion): void {
if (slot.panel === null) return
if (slot.locked) {
this.lead?.selectRegion(selection)
return
}
slot.panel.readOwn(selection)
}
private toggleLock(slot: Slot): void {
slot.locked = !slot.locked
// Back on the deck means back on the deck's window: a map the lock follows
// reading somewhere the others are not is two places under one chain.
if (slot.locked) slot.panel?.clearOwnPlace()
slot.panel?.syncLock()
// Recorded beside the scale, because to a reader it is the same kind of
// decision about the same map: *this one is not like the others*. Only a
// slot with a file behind it — a vacancy has no key to be remembered under.
if (isMapRef(slot.ref)) {
const held = this.lookFor(slot.ref.uri) ?? { uri: slot.ref.uri }
this.noteLook(slot.ref.uri, { ...held, locked: slot.locked })
}
if (!slot.locked) return
this.seedFromLead()
this.lock.catchUp(slot.id)
}
/**
* The grid's half of the grip gesture: every cell on screen is a target, the
* lead's included (§16.9).
*
* Delegated to the grid rather than wired per cell, because the cells are
* rebuilt on every change to the deck and a listener per cell is a listener
* per rebuild. The lead used to be excluded — the session's own view, in cell
* 0 for good — and it is a cell like the others now: what moves is where the
* picture stands, and the session is still of the file it was of. Only a
* hidden lead is no target, being nowhere on screen to aim at.
*/
private watchArranging(): void {
const cellAt = (target: EventTarget | null): HTMLElement | null => {
if (!(target instanceof Node)) return null
const node = target instanceof Element ? target : target.parentElement
const cell = node?.closest('.deck-panel') ?? null
if (cell === null || cell.classList.contains('is-parked')) return null
return this.grid.contains(cell) ? (cell as HTMLElement) : null
}
// What stands in a cell of the grid, by its element: the lead's own, or a
// slot's. By identity rather than by position, since the lead can stand
// anywhere and a hidden one is in the grid's children without a place.
const occupant = (cell: HTMLElement): Slot | typeof LEAD_CELL | undefined =>
cell === this.leadCell ? LEAD_CELL : this.slots.find((slot) => elOf(slot) === cell)
this.grid.addEventListener('dragover', (event) => {
// Only a map. A *file* dropped on a cell is a different gesture with a
// different answer, and it is the cell's own (`MapPanel.VacantPanel`).
// A row of the Contact maps card is a map too, and over a cell that
// holds one it is the same exchange a cell's own grip makes.
const card = dragHasMapRow(event)
if (event.dataTransfer?.types.includes(DECK_DRAG_TYPE) !== true && !card) return
const cell = cellAt(event.target)
if (cell === null) return
event.preventDefault()
if (event.dataTransfer !== null) event.dataTransfer.dropEffect = card ? 'copy' : 'move'
for (const other of this.grid.children) other.classList.toggle('is-target', other === cell)
})
this.grid.addEventListener('drop', (event) => {
if (dragHasMapRow(event)) {
const row = readMapRow(event)
const cell = cellAt(event.target)
this.setArranging(false)
if (row === null || cell === null) return
event.preventDefault()
const target = occupant(cell)
if (target === LEAD_CELL) this.putMapRowOnLead(row)
else if (target !== undefined) this.putMapRow(target, row)
return
}
if (event.dataTransfer?.types.includes(DECK_DRAG_TYPE) !== true) return
const cell = cellAt(event.target)
this.setArranging(false)
if (cell === null) return
event.preventDefault()
const from = this.leadCell.classList.contains('is-dragging')
? LEAD_CELL
: this.slots.find((slot) => (slot.panel ?? slot.cell)?.el.classList.contains('is-dragging') === true)
const to = occupant(cell)
if (from !== undefined && to !== undefined) this.exchange(from, to)
})
this.grid.addEventListener('dragleave', (event) => {
if (event.relatedTarget instanceof Node && this.grid.contains(event.relatedTarget)) return
for (const other of this.grid.children) other.classList.remove('is-target')
})
}
/**
* A file dropped on a cell is **that cell's**, wherever on it the hand lets
* go (§16.9).
*
* A companion's map took a file only on its five rectangles — its four edges
* and *on this map* in the middle — and they cover a ring round the picture and
* a square inside it: a file let go between the two, on the lanes under the
* map or on its heading fell through to the content area, which loads every
* drop onto the first map. A tracks cell had no rectangle at all, so a track
* dropped on one was drawn under the first map every time. Now the whole cell
* is the target, and it means what the middle of a map means: the file is
* opened for this cell — a track drawn on that map on its usual edge, an
* overlay on its face, a track in a tracks cell at its foot — by the same two
* roads the rectangles take (`AnnotationContext.loadOnEdge`, `pickOnEdge`).
* What a file *is* is still decided by name where every drop's is, so a
* `.cool` let go on a map is still a map, in a cell of its own.
*
* The rectangles keep their drop, being the more specific aim, and so do an
* empty cell (`VacantPanel`) and a structure cell, which answer for
* themselves. The lead's own cell is not one of these: a drop on it is the
* session's, as it always was. Delegated to the grid, as the grip's half is
* ({@link watchArranging}), because the cells are rebuilt on every change to
* the deck.
*/
private watchFileDrops(): void {
let lit: HTMLElement | null = null
const light = (cell: HTMLElement | null): void => {
if (lit === cell) return
lit?.classList.remove('is-file-target')
lit = cell
cell?.classList.add('is-file-target')
}
// In the capture phase: a map's rectangles stop the `dragover` they answer,
// and the cell has to go dark the moment the hand is over one of them, so
// that one thing on screen at a time says where the file will go.
this.grid.addEventListener('dragover', (event) => light(this.fileAim(event)?.cell ?? null), true)
this.grid.addEventListener('dragleave', (event) => {
if (event.relatedTarget instanceof Node && this.grid.contains(event.relatedTarget)) return
light(null)
})
this.grid.addEventListener('drop', (event) => {
light(null)
const aim = this.fileAim(event)
if (aim === null) return
// Prevented and not stopped: the content area's handler still has its
// highlight to put away, and stands aside for a drop somebody answered.
event.preventDefault()
if (dragHasFileRow(event)) {
aim.context.pickOnEdge?.(event, aim.edge)
return
}
const files = filesFrom(event.dataTransfer)
if (files.length > 0) aim.context.loadOnEdge?.(files, aim.edge)
})
}
/**
* The cell a dragged file is over, where that cell takes a file for itself —
* a companion's map, or a tracks cell — with the edge it means there: `null`
* for a map's middle, *on this map*, and the foot of a tracks cell, where
* every track on one is drawn. `null` for everything else, which is somebody
* else's to answer.
*/
private fileAim(event: DragEvent): { cell: HTMLElement; edge: LaneEdge | null; context: AnnotationContext } | null {
if (!dragHasFiles(event) && !dragHasFileRow(event)) return null
const node = event.target instanceof Node ? event.target : null
const target = node instanceof Element ? node : (node?.parentElement ?? null)
// A map's rectangles, an empty cell and the `+` edges are aimed more
// finely than the cell they are in, and answer for themselves.
if (target === null || target.closest('.lane-drop, .deck-drop, .dropzone') !== null) return null
const cell = target.closest('.deck-panel')
if (!(cell instanceof HTMLElement) || !this.grid.contains(cell)) return null
const slot = this.slots.find((held) => elOf(held) === cell)
if (slot === undefined) return null
const edge: LaneEdge | null | undefined =
slot.panel !== null ? null : slot.cell?.kind === 'tracks' ? 'bottom' : undefined
if (edge === undefined) return null
const context = this.props.annotations?.(slot.id)
const road = dragHasFileRow(event) ? context?.pickOnEdge : context?.loadOnEdge
if (context === undefined || road === undefined) return null
return { cell, edge, context }
}
/**
* Show the tiling while a map is being dragged, and hide it after.
*
* The cells are only worth seeing as *cells* while something is looking for
* one: a permanent outline round every panel would be a grid drawn over four
* pictures for the benefit of a gesture nobody is making.
*/
private setArranging(on: boolean): void {
this.grid.classList.toggle('is-arranging', on)
if (!on) for (const cell of this.grid.children) cell.classList.remove('is-target')
}
/**
* Exchange two cells — the drop half of the grip gesture.
*
* A swap rather than an insert; see {@link swapItems}. Either end may be the
* lead's cell (§16.9): it is not in `slots`, so the exchange is made on the
* grid's own order, and what comes back is the companions in their new order
* and the lead's new place. The hash is rewritten only when the companions'
* order moved — the lead's place is this session's memory, not the link's.
*/
private exchange(a: Slot | typeof LEAD_CELL, b: Slot | typeof LEAD_CELL): void {
const order = this.order()
const from = order.indexOf(a)
const to = order.indexOf(b)
// A drop on itself, or on nothing: `swapItems` answers both with a copy, so
// this would repaint the grid and rewrite the hash with what it had.
if (from === to || from < 0 || to < 0) return
this.reseat(swapItems(order, from, to))
}
/**
* Put the cells in a new reading order, the lead's among them — the one road
* an exchange and a move on the Contact maps card both take.
*
* The link carries the companions' order, so it is written only where that
* moved; where the lead alone moved, the place is this session's memory, as
* the column count is, and the session is told — its card lists the maps in
* the grid's order and its record is of that memory.
*/
private reseat(next: ReadonlyArray<Slot | typeof LEAD_CELL>): void {
const slots = next.filter((cell): cell is Slot => cell !== LEAD_CELL)
const reordered = slots.some((slot, index) => slot !== this.slots[index])
const was = this.leadAt
this.slots = slots
this.placeLead(next.indexOf(LEAD_CELL), this.leadHidden)
this.paintGrid()
if (reordered) this.publish()
else this.paintBar()
if (this.leadAt !== was) this.props.onLeadShownChange?.()
}
/**
* How many maps stand before the session's own in the grid — where its row
* goes on the Contact maps card, which lists the maps in the grid's order.
*/
get leadMapIndex(): number {
return this.order()
.slice(0, this.leadAt)
.filter((cell) => cell !== LEAD_CELL && cell.panel !== null).length
}
/**
* Move one map's cell to before or after another map's — a row of the Contact
* maps card dragged up or down it (§16.9).
*
* An **insertion among the maps**, where a cell's own grip exchanges two cells:
* a list reorders by insertion, and a reader dragging the fourth map to the top
* of the card means *first*, not *swap with the first*. Only the seats maps
* stand in are re-dealt, so a tracks cell, a model or an empty cell keeps its
* place in the grid while the maps move round it. `map` and `onto` are the
* deck's ids for its maps, {@link LEAD_MAP} for the session's own.
*/
moveMap(map: MapId, onto: MapId, after: boolean): void {
const cellOf = (id: MapId): Slot | typeof LEAD_CELL | undefined =>
id === LEAD_MAP ? LEAD_CELL : this.slots.find((slot) => slot.id === id && slot.panel !== null)
const moved = cellOf(map)
const target = cellOf(onto)
if (moved === undefined || target === undefined || moved === target) return
const order = this.order()
const seats = order.flatMap((cell, at) => (cell === LEAD_CELL || cell.panel !== null ? [at] : []))
const maps = seats.map((at) => order[at])
const rest = maps.filter((cell) => cell !== moved)
rest.splice(rest.indexOf(target) + (after ? 1 : 0), 0, moved)
if (rest.every((cell, at) => cell === maps[at])) return
const next = [...order]
seats.forEach((seat, at) => {
next[seat] = rest[at]
})
this.reseat(next)
}
/**
* Arm every map in the deck for placing marks.
*
* The session arms its own panel beside this one and hands both the same
* `onEnd`, so whichever map the reader places on — and whichever one they
* press Escape over — ends the mode everywhere. Without that the gesture would
* be armed on five panels and disarmed on one, and the four left over would
* go on swallowing clicks that the reader had meant as navigation.
*
* @returns a function that disarms every panel this armed.
*/
armPicking(handlers: PickHandlers, onEnd: () => void = () => {}): () => void {
const cancels = this.slots
.map((slot) => slot.panel?.armPicking(handlers, onEnd) ?? slot.cell?.armPicking?.(handlers, onEnd))
.filter((cancel): cancel is () => void => cancel !== undefined)
return () => {
for (const cancel of cancels) cancel()
}
}
/**
* Every map that can be analysed, lead first and then the grid in reading
* order — what "run this on all of them" means.
*
* A companion appears only once it has answered for itself: the two tables an
* analysis needs are fetched on demand, so a panel still reading is a panel a
* batch cannot yet price. Asked again on the next press rather than waited
* for, because a reader pressing the button while a map is still opening has
* asked about the maps that are *there*.
*/
analysable(): Array<{ map: MapId; panel: MapPanel }> {
const out: Array<{ map: MapId; panel: MapPanel }> = []
for (const slot of this.slots) {
if (slot.panel === null) continue
out.push({ map: slot.id, panel: slot.panel })
}
return out
}
/**
* The map an analysis runs against; the lead unless a companion is starred,
* and `null` where the reader has left no map starred — the state in which no
* task can run (§18.1).
*/
get starredMap(): MapId | null {
return this.starred
}
/**
* The starred companion's *Map* card, for the Aesthetics column (§16.5), or
* `null` where the column should show the first map's own: the first map is
* starred, nothing is (the first map's card then sets every map), or the
* starred companion has not drawn its first block yet.
*/
mapCard(): HTMLElement | null {
const panel = this.starredPanel
if (panel === null) return null
const card = panel.card
if (card !== null) return card
// Starred before its map is drawn — still opening, or refused. The first
// map's card must not stand in for it: it would set a map other than the
// one the star is on, under a heading that says nothing about which.
const name = this.props.mapLabel?.(panel.uri) ?? fileLabel(panel.uri)
this.waitingCard.replaceChildren(
cardTitle('Map', 'sliders-horizontal', 'controls-title'),
el(
'p',
{ class: 'map-card-for' },
icon('star', { size: 12, class: 'map-card-star is-on' }),
el('span', { text: name }),
),
el('p', { class: 'clip-note', text: 'Its settings are here once its map is drawn.' }),
)
return this.waitingCard
}
/** What the column shows for a starred map that has no card yet; see {@link mapCard}. */
private readonly waitingCard = el('div', { class: 'controls-card map-card-waiting' })
/**
* The starred **companion**, or `null` when the star is on the lead.
*
* `null` is the ordinary answer and the one the session reads as "carry on as
* before": the lead's own facts are the ones it has always used, and nothing
* about the Analysis column changes while the star has not moved.
*/
get starredPanel(): MapPanel | null {
if (this.starred === null || this.starred === LEAD_MAP) return null
return this.slots.find((slot) => slot.id === this.starred)?.panel ?? null
}
/**
* Move the star — or, pressed where it already is, take it off every map.
*
* A filled star is **live** and not a dead button: pressing it leaves no map
* starred, which is the state in which the *Map* card sets every map at once
* and no task runs (§16.5, §18.1). `null` says so directly.
*
* Silent about a map that is not here: a starred slot that has been closed
* comes back as the lead through {@link keepStarPresent}, and a caller asking
* for one that never existed is asking about a deck it has stale knowledge of.
*/
setStarred(map: MapId | null): void {
const next = map === this.starred ? null : map
if (next !== null && next !== LEAD_MAP && !this.slots.some((slot) => slot.id === next)) return
this.starred = next
remember(this.props.memoryKey(), 'deck:starred', next ?? NO_STAR)
this.paintStars()
// The bar's two switches say which map they read *from*, so moving the star
// rewrites both of them — and applies them, because "fix all scales" over a
// deck whose star has moved means the new map's scale from that moment.
this.paintBar()
// The facts an analysis needs are two reads a drawing panel never makes, so
// they are fetched when the star lands rather than when the panel opens —
// an eight-panel deck does not read sixteen tables to show eight pictures.
// The column re-prices when they land, and again now for the star itself.
const panel = this.starredPanel
if (panel !== null) void panel.prepareAnalysis(() => this.props.onStarChange?.())
this.props.onStarChange?.()
// The column's *Map* card is the starred map's, so it changes with the star.
this.props.onMapCardChange?.()
}
/**
* Put the star back on the lead if the map it was on is not here.
*
* Called from {@link paintGrid}, so it runs on every change to the list
* whatever caused it. A star pointing at a panel that is not on screen is
* worse than one pointing at nothing: the Analysis column goes on offering
* tasks priced against a file the reader cannot see, every result is adopted
* onto a map with no panel to draw it, and no star anywhere is filled — so
* there is no control to move it back with either.
*
* "Not here" and not "closed": the star is *restored* from this file's memory
* (see {@link starred}), and a slot id is minted from a counter that keeps
* climbing for the life of the tab. Across a reload the counter starts again
* and the restored id names the same position in the same link, which is what
* makes remembering it worth doing; within one session it names a slot that
* was thrown away, and only a reconciliation that runs on *arrival* as well as
* on departure catches that.
*/
private keepStarPresent(): void {
// No star is a choice the reader made about *this* deck, and it holds for
// as long as the deck does; a deck put down leaves the next one starting
// where every deck starts, on the first map — or a reader who unstarred,
// closed the deck and opened another a week later would meet a column of
// greyed tasks with nothing on screen having changed.
if (this.starred === null && this.slots.length > 0) return
if (this.starred === LEAD_MAP) return
// A *map* under that id: a cell whose map was hidden can stay as its
// tracks under the same id ({@link vacateMap}), and a star on it would be a
// Map card about a picture that has gone.
if (this.starred !== null && this.slots.some((slot) => slot.id === this.starred && slot.panel !== null)) return
// Back to the lead — or, while the lead is hidden, to the first map still on
// screen, for the reason `hideLead` moves it: a *Map* card setting a picture
// nobody can see reads as a card that does nothing (§16.9).
const shown = this.leadHidden ? this.slots.find((slot) => slot.panel !== null) : undefined
this.starred = shown?.id ?? LEAD_MAP
remember(this.props.memoryKey(), 'deck:starred', this.starred)
this.paintBar()
this.props.onStarChange?.()
this.props.onMapCardChange?.()
}
/**
* A map was renamed: put the new name where the old one was.
*
* Pushed rather than pulled, unlike everything else the deck shares, because
* a name is written into the DOM once and then left alone — the headings are
* not rebuilt per frame, which is the property that lets a reader type into
* one without it being taken away under them.
*/
renamed(): void {
this.paintLeadHead()
for (const slot of this.slots) (slot.panel ?? slot.cell)?.syncName()
}
/** Repaint every star, so at most one of them is filled. */
private paintStars(): void {
this.leadStar.classList.toggle('is-on', this.starred === LEAD_MAP)
this.leadStar.setAttribute('aria-pressed', String(this.starred === LEAD_MAP))
this.leadStar.title = mapStarTitle(this.props.leadName?.() ?? 'this map', this.starred === LEAD_MAP)
for (const slot of this.slots) slot.panel?.setStarred(this.starred === slot.id)
this.paintCardsFor()
}
/**
* Tell every map's *Map* card which map it sets (§16.5): the starred one
* names itself, and with nothing starred the first map's card says it sets
* every map. Nothing at all on a deck with no companion map, where the one
* map there is is the only thing the card could be about.
*/
private paintCardsFor(): void {
const companions = this.slots.filter((slot) => slot.panel !== null)
if (companions.length === 0) {
this.lead?.setCardFor(null)
return
}
const leadName = this.props.leadName?.() ?? 'the first map'
this.lead?.setCardFor(
this.starred === null
? { kind: 'every', maps: companions.length + 1 }
: this.starred === LEAD_MAP
? { kind: 'starred', name: leadName }
: null,
)
for (const slot of companions) {
const panel = slot.panel as MapPanel
panel.setCardFor(
slot.id === this.starred
? { kind: 'starred', name: this.props.mapLabel?.(panel.uri) ?? fileLabel(panel.uri) }
: null,
)
}
}
private remove(slot: Slot): void {
const index = this.slots.indexOf(slot)
if (index < 0) return
// A cell before the lead's leaving moves the lead up one, as it moves every
// cell after it: the grid closes up in reading order, the lead with it.
if (this.order().indexOf(slot) < this.leadAt) this.placeLead(this.leadAt - 1, this.leadHidden)
this.lock.leave(slot.id)
slot.panel?.destroy()
slot.vacancy?.destroy()
slot.cell?.destroy()
this.slots.splice(index, 1)
this.paintGrid()
this.publish()
}
/**
* Fill a vacancy with whatever the file is, in the position it was standing
* in — a map, a structure or a track (§16.9).
*/
private fill(slot: Slot, picked: PickedFile): void {
// The same routing {@link addPicked} does, into *this* cell: a g3d dropped
// on an empty card is the reader saying where the structure goes.
if (isStructurePick(picked)) {
if (picked.source.kind === 'local') this.props.structure?.onDrop(picked.source.file)
else this.props.structure?.onDropUrl(picked.uri)
this.occupy(slot, { kind: 'structure' })
return
}
// A track: a tracks cell opens where it was dropped, and the file is
// loaded into the session's one list of tracks **drawn on that cell** —
// the road a file aimed at a map's edge takes, with the cell as the map.
// Asked by name, as the rest of the app routes a file; a name the router
// does not know is still offered to the map road below, whose refusal is
// the reader's file's own error, in the cell it was dropped on.
if (this.takesTracks() && routeFor(picked.uri, picked.name) === 'genome') {
const built = this.occupy(slot, { kind: 'tracks' })
if (built !== null) this.props.onTrackFile?.(picked, built.id)
return
}
this.occupy(
slot,
{ kind: picked.source.kind === 'local' ? 'local' : 'remote', uri: picked.uri },
picked.source,
)
}
/**
* Whether an empty cell here can take a track: the session carries tracks
* (§8.5), can load one onto a cell, and can build a tracks cell to draw it.
*/
private takesTracks(): boolean {
return (
this.props.tracks !== undefined &&
this.props.onTrackFile !== undefined &&
this.props.annotations?.(LEAD_MAP) !== undefined
)
}
/**
* Turn **this** cell into a tracks cell drawing the track `id` — a row of the
* Tracks card dropped on an empty cell (§16.9).
*
* The track is *placed* on the cell and not moved there: the row stays on
* every map it was drawn on, because a cell somebody made room in is a place
* to look at it again rather than a reason to take it off the map beside.
*/
private putTrack(slot: Slot, id: string): void {
const store = this.props.annotations?.(LEAD_MAP)?.store
if (store === undefined || store.byId(id) === undefined) return
const built = this.occupy(slot, { kind: 'tracks' })
if (built !== null) store.placeAt(id, built.id, placementOn('bottom'))
}
/** Put a file in a cell that had none, leaving every other cell alone. */
private occupy(slot: Slot, ref: PanelRef, source?: SourceSpec): Slot | null {
const index = this.slots.indexOf(slot)
if (index < 0) return null
slot.vacancy?.destroy()
const built = this.build(ref, source)
this.slots[index] = built
this.paintGrid()
this.publish()
if (this.state !== null) (built.panel ?? built.cell)?.apply(this.state)
return built
}
private addUrl(): void {
// Canonicalised here, where the text becomes a URI: a deck member is written
// into `?maps=` and travels in every link this session writes, so what is
// stored has to be the address that opens (SPECS §24.5).
const url = canonicalUrl(this.urlInput.value.trim())
if (url === '') return
this.urlInput.value = ''
this.add({ kind: 'remote', uri: url })
}
private addLocal(file: File): void {
this.addPicked({ uri: file.name, source: { kind: 'local', file } })
}
/**
* One more map from a file that may be anywhere.
*
* The currency the edges and the vacant cells speak, since a row dragged out
* of the Files panel is as likely to be an object on a bucket as a file on the
* disk — and a `PickedFile` is exactly the pair `add` already takes, so this
* is a rename rather than a second road in.
*/
private addPicked(picked: PickedFile): void {
// A structure is a *track* to the session and a *cell* to the deck: the
// file goes to the store by the session's road, and the cell that draws
// the store's structure row opens here (§25.3).
if (isStructurePick(picked)) {
if (picked.source.kind === 'local') this.props.structure?.onDrop(picked.source.file)
else this.props.structure?.onDropUrl(picked.uri)
this.add({ kind: 'structure' })
return
}
this.add(
{ kind: picked.source.kind === 'local' ? 'local' : 'remote', uri: picked.uri },
picked.source,
)
}
/**
* Open one more map: in the first empty cell if there is one, else at the end.
*
* The empty cell comes first because under §16.9 it is *the reader's own
* instruction*. They drew the arrangement before they had the files, so a map
* arriving by any road — the bar's URL box, the file chooser, the command
* palette — belongs in the next place they left for it, and appending past
* their empty cards to a cell they never asked for would make the two ways of
* adding a map disagree about what the deck is.
*/
add(ref: PanelRef, source?: SourceSpec): void {
if (isMapRef(ref) && this.props.mapsAllowed?.() === false) {
this.warn(NO_MAP_LEAD)
return
}
const empty = this.slots.find((slot) => slot.ref.kind === 'vacant')
if (empty !== undefined) {
this.warn('')
this.hideAdd()
this.occupy(empty, ref, source)
return
}
if (this.slots.length + 1 >= MAX_PANELS) {
// In the deck's own bar, not on an error screen — see {@link NO_ROOM}.
// Every other refusal a reader meets here (a name this file has not got,
// a block this share of the budget will not lend) is already a line
// beside the panel it is about.
this.warn(NO_ROOM)
return
}
this.warn('')
const slot = this.build(ref, source)
this.slots.push(slot)
this.hideAdd()
this.paintGrid()
this.publish()
if (this.state !== null) (slot.panel ?? slot.cell)?.apply(this.state)
}
/**
* Open a column of empty cells beside the maps, or a row below them (§16.9).
*
* The deck's own half of the `+` gesture, and the only place the shape is
* written down as a number: every other control here arranges the cells that
* exist, and this one is how a reader says how many there should be.
*
* The maps are **re-seated**, not appended to, and that distinction is the
* whole of {@link grownPlacement}: a cell's position is derived from its index
* and the column count, so widening the deck re-maps every index at once and
* pushing the new cells onto the end turns a 2 × 2 into a 3-wide row with one
* map stranded underneath. Nothing here rebuilds a panel — the slots are the
* same objects in a new order, so re-seating a deck of five costs a
* `replaceChildren` and no reads.
*
* A file arrives with the press when it was **dropped** on the edge rather
* than clicked, and it goes into the first cell that press opened — not into
* the first empty cell in the deck, which is where {@link add} would put it.
* The two rules differ only when the deck already had a hole somewhere, and
* there the gesture is the tie-breaker: a reader who drops on the right edge
* of a deck has aimed at the right edge of it.
*/
grow(direction: GrowDirection, picked?: PickedFile): void {
this.growing(direction, picked)
}
/**
* {@link grow}, answering with the cell the press aimed at — the near end of
* the edge pressed — if it opened any.
*
* `filling`: the caller puts something in that cell at once, and the grid is
* painted and written into the link by whatever fills it rather than here
* first — see {@link growFilled}, the one caller that passes it.
*/
private growing(direction: GrowDirection, picked?: PickedFile, filling = false): Slot | undefined {
const shape = { cells: Math.max(1, this.shownCells), columns: this.columnsNow() }
const next = grownDeck(shape, direction)
if (next.cells > MAX_PANELS) {
// A file that came with the press is not lost with it. There is no room
// for a cell, but there may be an empty one already — and dropping a
// cooler on a full deck to be told a number is a worse answer than
// opening it where the deck has space.
if (picked !== undefined) this.addPicked(picked)
else this.warn(NO_ROOM)
return undefined
}
this.warn('')
// Every cell on screen is re-seated, the lead's among them wherever it
// stands (§16.9): `grownPlacement` maps each old place to its new one, and
// both growths insert only *after* a row's existing cells, so no cell the
// reader placed changes row or column. A hidden lead is not on screen and
// keeps its place in the order, for when it comes back.
const places = grownPlacement(shape, direction)
const held = this.shownOrder()
const seated: Array<Slot | typeof LEAD_CELL> = []
// The near end of the edge that was pressed — the top of the new column,
// the left of the new row — which is where whatever came with the press
// goes. Not simply the first new cell in reading order: a last row the deck
// had not filled gains cells too, and the first of those sits in a row
// above the one the reader pressed for, so a model dropped on the `+` below
// went one cell to the right of where it had been.
const aimed = direction === 'beside' ? next.columns - 1 : places.length - next.columns
let first: Slot | undefined
let opened: Slot | undefined
for (const [index, from] of places.entries()) {
if (from === null) {
// Drawn, not left by a link, and that is all the difference amounts to:
// the card offers to take a map, a track or a structure rather than
// telling the reader that a map they never had used to be there
// (`panels/MapPanel.ts`).
const drawn = this.build({ kind: 'vacant' }, undefined, 'drawn')
opened ??= drawn
if (index === aimed) first = drawn
seated.push(drawn)
} else {
const cell = held[from]
if (cell !== undefined) seated.push(cell)
}
}
first ??= opened
this.columns = next.columns
remember(this.props.memoryKey(), 'deck:columns', next.columns)
this.slots = seated.filter((cell): cell is Slot => cell !== LEAD_CELL)
if (!this.leadHidden) this.placeLead(seated.indexOf(LEAD_CELL), false)
// `first` is the cell the press aimed at (above): the near end of the edge
// that was pressed.
if (picked === undefined || first === undefined) {
if (!filling || first === undefined) {
this.paintGrid()
this.publish()
}
} else {
// Paints and publishes on its way through, with the cell already filled,
// so the hash is written once rather than as a vacancy and then a map.
this.fill(first, picked)
}
this.paintBar()
return picked === undefined ? first : undefined
}
/**
* A row of the Contact maps card dropped on a `+` edge (§16.9): the cells that
* edge names, with that map in the one nearest the edge.
*/
growWithMap(direction: GrowDirection, row: MapRow): void {
const picked = this.mapRowPicked(row)
if (row.kind !== 'companion') {
if (picked !== null) this.grow(direction, picked)
return
}
this.growFilled(direction, (opened) => this.putMapRow(opened, row))
}
/**
* The cells a `+` opens, with `fill` putting something in the one nearest the
* edge — a lane, a model, a row of a card — painted and written into the link
* **once**, filled.
*
* Once because the link is read back a beat later: `SessionDeck.sync` awaits
* before it hands the deck a state, so two writes in one gesture come back as
* two states, and the first of them — the cell still empty — is no longer
* what this deck holds. Read as a link the deck had not written, it rebuilt
* the cells from it: the cell the second write filled came back empty, and a
* lane let go on a `+` was put back on the map it had left.
*
* Whatever `fill` did not write — there was nothing to put there after all —
* is written here, so the cells the press opened are on screen either way.
*/
private growFilled(direction: GrowDirection, fill: (opened: Slot) => void): void {
const opened = this.growing(direction, undefined, true)
if (opened === undefined) return
const written = this.writes
fill(opened)
if (this.writes === written) {
this.paintGrid()
this.publish()
}
}
/**
* A row of the Structures card dropped on a `+` edge (§16.9): the cells that
* edge names, with that model in the one nearest the edge — **moved** there,
* as a lane dragged to a `+` leaves the map it was on. A cell that was
* drawing it is left **empty where it stands** rather than closed: closing it
* would close the grid up in reading order, and the new cell — the last in
* it — slid into the place the model had just left, which read as a drop
* that did nothing but add two empty cells. The eye opens a model where
* there is room; this puts it where the reader aimed.
*/
growWithStructure(direction: GrowDirection, id: string): void {
this.growFilled(direction, (opened) => {
for (const slot of [...this.slots]) {
if (slot.ref.kind === 'structure' && slot.cell?.shownModel?.() === id) this.emptyInPlace(slot)
}
this.occupy(opened, { kind: 'structure' })?.cell?.showModel?.(id)
})
}
/**
* Take whatever a cell holds out of it, leaving an empty cell where it stood
* — the grid painted and written by whoever asked, which is why this does
* neither: it is one half of a gesture whose other half writes the deck.
*/
private emptyInPlace(slot: Slot): void {
const index = this.slots.indexOf(slot)
if (index < 0) return
this.lock.leave(slot.id)
slot.panel?.destroy()
slot.cell?.destroy()
this.slots[index] = this.build({ kind: 'vacant' }, undefined, 'drawn')
}
/**
* A row of the Tracks card dropped on a `+` edge: the cells that edge names,
* with that track drawn alone in the first — a tracks cell, the 1D browser of
* it (§16.9). *Placed*, as a row dropped on an empty cell is: the card's row
* says which track, not which map it leaves, and it stays on every map it was
* drawn on.
*/
growWithTrack(direction: GrowDirection, id: string): void {
if (!this.takesTracks()) return
this.growFilled(direction, (opened) => this.putTrack(opened, id))
}
/**
* The deck's places a lane carried off a map by its grip can land
* (`ui/laneCarry.ts`, §16.9): an empty cell and a `+` edge open a tracks
* cell drawing it, and a tracks cell draws it too. The maps' own edges are
* the maps' to answer. Every one is a **move**: the lane leaves the map it
* came from.
*/
private readonly laneSurface: LaneSurface = {
landingAt: (x, y, carry) => {
if (!this.takesTracks()) return null
const direction = this.edges.edgeAt(x, y)
if (direction !== null) {
return {
light: (on) => this.edges.lightEdge(direction, on),
take: (moved) => this.landLaneGrowing(direction, moved),
}
}
for (const slot of this.slots) {
const node = elOf(slot)
if (node === undefined || !within(node, x, y)) continue
const lit = (on: boolean): void => {
node.classList.toggle('is-target', on)
}
if (slot.ref.kind === 'vacant') return { light: lit, take: (moved) => this.landLane(slot, moved) }
if (slot.cell?.kind === 'tracks' && slot.id !== carry.from) {
return { light: lit, take: (moved) => this.moveLane(moved, slot.id) }
}
return null
}
return null
},
// The tiling, as a map's grip shows it: the cells are only worth seeing as
// cells while something is looking for one.
carrying: (carry) => this.setArranging(carry !== null),
}
/** A carried lane let go on a `+` edge: the cells that edge names, the lane in the first. */
landLaneGrowing(direction: GrowDirection, carry: LaneCarry): void {
if (!this.takesTracks()) return
this.growFilled(direction, (opened) => this.landLane(opened, carry))
}
/** A carried lane let go on an empty cell: a tracks cell there, drawing it. */
private landLane(slot: Slot, carry: LaneCarry): void {
const built = this.occupy(slot, { kind: 'tracks' })
if (built !== null) this.moveLane(carry, built.id)
}
/** Draw a carried lane on `to`, and take it off the edge it came from. */
private moveLane(carry: LaneCarry, to: MapId): void {
const store = this.props.annotations?.(LEAD_MAP)?.store
if (store === undefined) return
for (const id of carry.ids) {
// That edge only: a track on two sides of a map, one of them carried to a
// cell of its own, is still on the other (§16.9). Taken off first, as
// `LaneGestures.takeLane` does and for its reason: what stays behind may
// turn, and the lane here must not turn with it.
if (carry.from !== to) store.unplaceEdge(id, carry.from, carry.edge)
store.placeAt(id, to, placementOn('bottom'))
}
}
/**
* Put the map a row of the Contact maps card names into **this** cell
* (§16.9).
*
* A companion is *moved* — exchanged with whatever was here, as its cell's own
* grip does, so nothing is closed by a drop. The first map, or the one in its
* lower triangle, is *opened* here, and only in an empty cell: it is the
* session's own file, which stays where it is, and a second picture of it is
* the plainest way to read one map at two windows or two colour scales.
*/
putMapRow(slot: Slot, row: MapRow): void {
const at = this.slots.indexOf(slot)
if (at < 0) return
if (row.kind === 'companion') {
const from = this.slots.find((held) => held.id === row.id)
if (from !== undefined) this.exchange(from, slot)
return
}
// The first map's row onto a cell that holds something moves the first map
// there, as its cell's own grip would; onto an empty one it opens a second
// picture of it, below.
if (row.kind === 'lead' && slot.ref.kind !== 'vacant' && !this.leadHidden) {
this.exchange(LEAD_CELL, slot)
return
}
if (slot.ref.kind !== 'vacant') return
const picked = this.mapRowPicked(row)
if (picked !== null) this.fill(slot, picked)
}
/**
* A row of the Contact maps card dropped on the lead's own cell: a
* companion's row exchanges the two, as that companion's grip would. The
* first map's own row, and a file that is not in a cell, have nothing to do
* there — the cell is full, and it is not a companion's to fill.
*/
private putMapRowOnLead(row: MapRow): void {
if (row.kind !== 'companion') return
const from = this.slots.find((held) => held.id === row.id)
if (from !== undefined) this.exchange(from, LEAD_CELL)
}
/** The file a card row names, where it is one a cell can open. */
private mapRowPicked(row: MapRow): PickedFile | null {
if (row.kind === 'lead') return this.props.leadPicked?.() ?? null
if (row.kind === 'compare') return this.props.comparePicked?.() ?? null
if (row.kind === 'hidden') return this.props.hiddenPicked?.(row.id) ?? null
return null
}
/**
* Take one companion out of its cell and hand back what opens it again — the
* eye on its row of the Contact maps card (§16.9), as the eye on a
* Structures row closes that model's cell (§25.3). The cell goes exactly as
* its × would take it; the map is the session's to hold, hidden, until
* {@link showMap} puts it back. Its looks stay remembered by its file, so it
* comes back drawn as it was.
*/
takeMap(id: string): PickedFile | null {
const slot = this.slots.find((held) => held.id === id)
if (slot === undefined || slot.panel === null || !isMapRef(slot.ref)) return null
const picked: PickedFile = { uri: slot.ref.uri, source: slot.panel.sourceSpec }
this.vacateMap(slot)
return picked
}
/**
* The × on a map's own heading: the map is **hidden**, not let go (§16.9) —
* handed to the session, which lists it on the Contact maps card with its eye
* dark, as the eye itself would. Letting go of a map is the card's ×, the one
* place every map the session holds is listed.
*/
private hideMap(slot: Slot): void {
const picked = this.takeMap(slot.id)
if (picked !== null) this.props.onMapHidden?.(picked)
}
/**
* Take the map out of its cell, and the cell with it **only where the map
* was all it held**.
*
* A track dropped on a companion's edge is drawn in that cell and nowhere
* else, and closing the map used to close the cell, park the track's lane on
* the first map and leave the reader looking for it. So a cell with tracks
* drawn in it stays, as the tracks cell those tracks make — built under the
* **same id**, which is what the tracks are placed by, so they are in it
* without being moved. A cell that held the map alone goes, as the × always
* took it.
*/
private vacateMap(slot: Slot): void {
const index = this.slots.indexOf(slot)
if (index < 0) return
if (!this.hasTracksIn(slot) || this.props.tracks === undefined) {
this.remove(slot)
return
}
this.lock.leave(slot.id)
slot.panel?.destroy()
const built = this.build({ kind: 'tracks' }, undefined, 'drawn', undefined, slot.id)
this.slots[index] = built
this.paintGrid()
this.publish()
if (this.state !== null) built.cell?.apply(this.state)
}
/** Whether any track is drawn in this cell: a lane placed on it, of a file the reader loaded. */
private hasTracksIn(slot: Slot): boolean {
const store = this.props.annotations?.(LEAD_MAP)?.store
if (store === undefined) return false
// Not the map's own overlays — the 4C profile is the map's, and goes with it.
return store.entriesOn(slot.id).some((entry) => entry.card !== 'overlay' && entry.kind !== 'structure')
}
/**
* A hidden map's eye pressed: it opens in the first empty cell, or in a new
* one — {@link add}'s road, the one every map that names no position takes.
*/
showMap(picked: PickedFile): void {
this.add({ kind: picked.source.kind === 'local' ? 'local' : 'remote', uri: picked.uri }, picked.source)
}
/**
* The maps in the deck's other cells, in grid order, as the Contact maps card
* lists them (§16.9) — named as they are named everywhere else.
*/
companionMaps(): Array<{ id: string; label: string; uri: string }> {
const out: Array<{ id: string; label: string; uri: string }> = []
for (const slot of this.slots) {
if (slot.panel === null) continue
const uri = slot.panel.uri
out.push({ id: slot.id, uri, label: this.props.mapLabel?.(uri) ?? fileLabel(uri) })
}
return out
}
/**
* Let go of one cell's map by the deck's id for it — the × on the card's row.
* The cell goes with it only where the map was all it held, as when a map is
* hidden ({@link vacateMap}).
*/
closeCell(id: string): void {
const slot = this.slots.find((held) => held.id === id)
if (slot === undefined) return
if (slot.panel !== null) this.vacateMap(slot)
else this.remove(slot)
}
/** Show the tiling while a map is dragged towards a cell from outside the grid. */
showTiling(on: boolean): void {
this.setArranging(on)
}
/**
* Write the deck into the hash.
*
* A local companion becomes `~` on the way out and stays open here, so the
* link a reader copies has a slot where their file is and the deck they are
* looking at is untouched. See {@link serialiseMaps}.
*/
private publish(): void {
this.writes++
const refs = this.slots.map((slot) => slot.ref)
const value = serialiseMaps(refs)
this.published = { value }
// …and the half the hash cannot carry, into this session's own memory
// beside the columns and the star. Written on every publish rather than on
// a save, for the reason every other scope here is: what storage holds *is*
// the session, so a reload and an exported workspace restore the same deck.
remember(this.props.memoryKey(), 'deck:locals', localCompanions(refs))
this.rememberTracksCells()
this.paintBar()
this.props.onMapsChange(value)
// A structure cell opened or closed is a change to which models are on
// screen, told after the maps so the card is asked about the deck it sees.
this.props.onStructuresChange?.()
this.notePeers()
}
/**
* Tell the session when the maps that have opened change — and only then.
*
* Asked after every publish, which is a cell added or closed, and after every
* settle, which is a companion's read landing: its first, which is its file
* opening, or one after a change of rung. Most settles are a pan and change
* nothing here, so the answer is compared with the last one told rather than
* sent each time — the Analysis column it refreshes walks every task.
*/
private notePeers(): void {
const told = this.analysable()
.map(({ map, panel }) => {
const info = panel.openInfo
return info === null ? '' : `${map} ${panel.uri} ${info.binsize ?? 0}`
})
.filter((line) => line !== '')
.join('\n')
if (told === this.peersTold) return
this.peersTold = told
this.props.onPeersChange?.()
}
/**
* Every tracks cell's name and height, into this session's memory by
* **seat** — which tracks cell it is, counting from the left: the structure
* cells' rule, for their reason, since a slot's id is minted per build and
* would name nothing after a reload. Written from the live cells on every
* publish as well as on a rename or a resize, so a cell moved, closed or
* opened takes its name and its height with it rather than leaving them on a
* seat for whichever cell sits there next.
*/
private rememberTracksCells(): void {
const cells = this.slots.filter((slot) => slot.ref.kind === 'tracks').map(tracksIn)
const names = cells.map((cell) => cell?.customName() ?? '')
const heights = cells.map((cell) => cell?.customHeight() ?? null)
remember(this.props.memoryKey(), TRACKS_NAMES_SCOPE, names.some((name) => name !== '') ? names : null)
remember(
this.props.memoryKey(),
TRACKS_HEIGHTS_SCOPE,
heights.some((height) => height !== null) ? heights : null,
)
}
/**
* What a tracks cell nobody named is called: `tracks`, and `tracks 2`, `tracks 3`
* for the ones after it, counting from the left — the seat again.
*/
private tracksDefaultName(slot: Slot): string {
const seat = this.slots.filter((held) => held.ref.kind === 'tracks').indexOf(slot)
return seat <= 0 ? TRACKS_CELL_NAME : `${TRACKS_CELL_NAME} ${seat + 1}`
}
/** The names {@link rememberTracksCells} wrote, by seat; `''` for a cell nobody named. */
private recallTracksNames(): string[] {
const stored = recall<unknown>(this.props.memoryKey(), TRACKS_NAMES_SCOPE)
return Array.isArray(stored) ? stored.map((name) => (typeof name === 'string' ? name : '')) : []
}
/** The heights {@link rememberTracksCells} wrote, by seat; `null` for a cell as tall as its row. */
private recallTracksHeights(): Array<number | null> {
const stored = recall<unknown>(this.props.memoryKey(), TRACKS_HEIGHTS_SCOPE)
return Array.isArray(stored) ? stored.map(cellHeightOf) : []
}
// -------------------------------------------------------------------------
// Painting
// -------------------------------------------------------------------------
private paintGrid(): void {
// A hidden lead with nothing left beside it comes back: a deck of no cell
// on screen is a blank page, and the session is about to put the deck down
// and hand the view its own frame again — where it must not arrive hidden.
if (this.leadHidden && this.slots.length === 0) this.placeLead(this.leadAt, false)
// The cells in the order they stand, the lead's among them. A hidden lead
// stays in the grid's children, **parked** — laid out at a cell's width and
// out of sight rather than removed — because it is not a picture that has
// gone but the view the others follow: its map goes on reporting the window
// the lock and the cells read, and a view taken out of the document would
// measure nothing and report nothing (`ui/styles.css`, `.is-parked`).
this.leadCell.classList.toggle('is-parked', this.leadHidden)
this.leadCell.setAttribute('aria-hidden', String(this.leadHidden))
// One cell on screen and no map in its row to take a height from: the model
// or the tracks take the height a map would (`ui/styles.css`, `.is-alone`).
this.grid.classList.toggle('is-alone', this.shownCells === 1)
this.grid.replaceChildren(
...this.shownOrder().map((cell) => (cell === LEAD_CELL ? this.leadCell : (elOf(cell) ?? el('div')))),
...(this.leadHidden ? [this.leadCell] : []),
)
// Its × only with another cell beside it: closing the one cell of a deck
// would leave a deck of nothing.
this.leadClose.classList.toggle('hidden', this.slots.length === 0)
// Every panel that has just been built needs to be told whether its star is
// filled: which one it is belongs to the deck, and a panel has no way to
// ask (see {@link starred}).
// Before the stars are painted, because it decides which one is filled, and
// here rather than at each of the places a cell leaves. It used to be called
// from `adopt`, `remove` and `closeDeck`, which is every way a slot can
// *depart* and not the way a dangling star actually arises: the star is
// restored from this file's memory in the constructor, `adopt` runs only
// when the hash names a different list from the one this deck published, and
// a deck built by "add a map" publishes an empty list and matches. So a
// reader who starred a companion, closed the deck and opened another one got
// a deck whose star named a slot it had never built — no star filled
// anywhere, the lead's own offering to make it the target it already was,
// and every task's result adopted onto a map with no panel to draw it.
this.keepStarPresent()
this.paintStars()
this.paintStructureStars()
// A tracks cell nobody named is numbered by where it stands among the
// others, so a cell arriving, leaving or moving can renumber the rest.
for (const slot of this.slots) tracksIn(slot)?.syncName()
this.keepLanesOnLiveMaps()
this.applyLayout()
}
/**
* The heading over the session's own cell: the heading every cell has — a
* grip, a name, its star and chain, and a × (§16.9).
*
* It used to be a name alone, with no grip and no ×, because the first map
* is the session's view re-parented into the grid and "which file is this
* session of" is not a thing a drag should change. Nor does either change it:
* the grip moves where the picture stands and the × takes the picture off the
* screen, and the breadcrumb, the tables and the tracks are the same file's
* throughout. A deck whose first cell could not be moved or closed was a
* deck with a cell unlike every other, and a figure of a model beside its map
* — or of the model alone — could not be drawn with it.
*/
private paintLeadHead(): void {
const name = this.props.leadName?.()
if (name === undefined) {
this.leadHead.replaceChildren()
this.leadHead.classList.add('hidden')
return
}
this.leadHead.classList.remove('hidden')
const browser = this.lead === null && this.leadAxis !== null
const title = browser
? `${name} — the tracks this session is of, and the window the other cells follow`
: `${name} — the map this session is of, and the one the others follow`
const rename = this.props.onRenameLead
this.leadGrip.title = `Drag to move ${name} to another cell of the deck`
this.leadGrip.setAttribute('aria-label', `Move ${name}`)
this.leadClose.title = browser
? `Hide ${name}'s tracks — the other cells go on following its window, and the bar's show ${name} brings them back`
: `Hide ${name} — it stays on the Contact maps card, whose eye brings it back; the other maps go on following it`
this.leadClose.setAttribute('aria-label', `Hide ${name}`)
this.leadHead.replaceChildren(
this.leadGrip,
rename === undefined
? el('span', { class: 'deck-name', text: name, title })
: renameBox(name, title, rename),
deckTools(this.leadSequence, this.leadStar, this.leadLock, this.leadClose),
)
this.leadClose.classList.toggle('hidden', this.slots.length === 0)
this.paintStars()
this.syncLeadLock()
this.syncLeadSequence(true)
}
/**
* Say on the first map's picker which sequence its block is of.
*
* Asked on every report of the lead's, which is every frame of a pan, so it
* repaints only when what it would say has changed — or when `force`d, by a
* heading painted afresh.
*/
private syncLeadSequence(force = false): void {
const names = this.props.leadSequences?.() ?? null
const lead = this.lead
if (names === null || lead === null || this.props.onLeadSequence === undefined) {
this.leadSequence.classList.add('hidden')
this.leadSequenceKey = ''
return
}
const block = lead.blockSequences()
const key = `${names.length}\u0000${block.rows.join('\u0000')}\u0001${block.cols.join('\u0000')}`
if (!force && key === this.leadSequenceKey) return
this.leadSequenceKey = key
paintSequencePicker(
this.leadSequence,
names,
shownSequence(block.rows, block.cols),
'The sequence this map shows. Pick another to go there — as the locus box would, so every map ' +
'following this one goes with it; a map moving on its own has a picker of its own.',
)
}
/**
* The lead's grip, wired once: the same drag a companion's grip starts, with
* the lead's cell marked as the one on the move ({@link watchArranging}).
*/
private wireLeadGrip(): void {
this.leadGrip.append(icon('grip-vertical', { size: 12 }))
this.leadGrip.addEventListener('dragstart', (event) => {
event.dataTransfer?.setData(DECK_DRAG_TYPE, this.props.leadName?.() ?? LEAD)
if (event.dataTransfer !== null) event.dataTransfer.effectAllowed = 'move'
this.leadCell.classList.add('is-dragging')
this.setArranging(true)
})
this.leadGrip.addEventListener('dragend', () => {
this.leadCell.classList.remove('is-dragging')
this.setArranging(false)
})
// The heading's own gestures are not the map's: a press on the grip must
// not reach a view below that would read it as the start of a pan.
this.leadGrip.addEventListener('pointerdown', (event) => event.stopPropagation())
}
/**
* Take the session's own cell off the screen — the × on its heading, and the
* eye on its row of the Contact maps card (§16.9).
*
* **Parked, not closed.** The view stays mounted behind the grid at a cell's
* width, so everything that follows it goes on following it: the maps' lock,
* the window a structure or tracks cell lights, the heading above the grid
* whose locus box steers the deck. The session is still of this file, and its
* tables, tracks and star are what they were. Refused while nothing else is
* in the deck, which would leave nothing on screen.
*/
hideLead(): void {
if (this.leadHidden || this.slots.length === 0) return
this.placeLead(this.leadAt, true)
this.paintGrid()
// The star goes to the first map still on screen, where there is one: the
// *Map* card is the starred map's, and a card setting a picture nobody can
// see reads as a card that does nothing. Where no other map is on screen it
// stays — the session is still of this map, and a task still runs on it.
if (this.starred === LEAD_MAP) {
const shown = this.slots.find((slot) => slot.panel !== null)
if (shown !== undefined) this.setStarred(shown.id)
}
this.paintBar()
this.props.onLeadShownChange?.()
}
/** Put the session's own cell back where it stood. */
showLead(): void {
if (!this.leadHidden) return
this.placeLead(this.leadAt, false)
this.paintGrid()
this.paintBar()
this.props.onLeadShownChange?.()
}
/** Whether the session's own cell is on screen; see {@link hideLead}. */
get leadShown(): boolean {
return !this.leadHidden
}
/** Where the lead stands and whether it is on screen, kept and remembered. */
private placeLead(at: number, hidden: boolean): void {
const place = Math.max(0, Math.min(Math.floor(at), this.slots.length))
if (place === this.leadAt && hidden === this.leadHidden) return
this.leadAt = place
this.leadHidden = hidden
this.rememberLead()
}
/**
* The lead's record in this file's memory: its place, whether it is shown,
* and its chain where it is open. One record written whole by both of the
* things that change it, so moving the first map cannot forget its chain.
*/
private rememberLead(): void {
const lead: DeckLead = {
at: this.leadAt,
hidden: this.leadHidden,
...(this.leadLocked ? {} : { locked: false }),
}
remember(this.props.memoryKey(), LEAD_SCOPE, lead)
}
/**
* Every cell in reading order, the lead's among them at its place — hidden
* or not, since a hidden one keeps its place for when it comes back.
*/
private order(): Array<Slot | typeof LEAD_CELL> {
return withLead<Slot, typeof LEAD_CELL>(this.slots, LEAD_CELL, this.leadAt)
}
/** The cells on screen, in reading order: {@link order} without a hidden lead. */
private shownOrder(): Array<Slot | typeof LEAD_CELL> {
return this.leadHidden ? [...this.slots] : this.order()
}
/** How many cells are on screen: every companion, and the lead unless hidden. */
private get shownCells(): number {
return this.slots.length + (this.leadHidden ? 0 : 1)
}
/**
* The first map's chain: take it off the deck's navigation, or put it back.
*
* Seeding before the catch-up, so putting the first map back in step over a
* deck that has not moved leaves the deck knowing where it is looking rather
* than nowhere — which is what the next companion catches up to.
*/
private toggleLeadLock(): void {
this.leadLocked = !this.leadLocked
// Kept per file, as a companion's chain is with its look (§16.6).
this.rememberLead()
if (this.leadLocked) {
this.seedFromLead()
this.lock.catchUp(LEAD)
}
this.syncLeadLock()
}
/**
* Draw and name the lead's chain from the state it is in.
*
* The same two sentences a companion's chain says (`MapPanel.syncLock`) and a
* tracks cell's: what it is doing now, then what a click does. One icon
* saying *press* on one cell and *click* on another, and *unhook* on one and
* *move it on its own* on the next, read as three controls (§25.3).
*/
private syncLeadLock(): void {
this.leadLock.replaceChildren(icon(this.leadLocked ? 'link' : 'unlink', { size: 14 }))
// By its name, not by its place: the first map can stand anywhere (§16.9).
const name = this.props.leadName?.() ?? 'This map'
this.leadLock.title = this.leadLocked
? `${name} is driving the deck. Click to move it on its own.`
: `${name} is moving on its own. Click to put it back in step.`
this.leadLock.setAttribute('aria-label', this.leadLock.title)
setPressed(this.leadLock, this.leadLocked)
}
private applyLayout(): void {
const shape = { cells: this.shownCells, columns: this.columnsNow() }
this.grid.style.setProperty('--deck-columns', String(shape.columns))
// Asked of the same arithmetic the press will run, rather than of the panel
// count, so an edge is lit exactly when pressing it would do something. A
// deck of two rows has room for another row of two and not for another
// column of two at five cells, and one answer for both edges would either
// grey an edge that works or offer one that refuses.
this.edges.setRoom(
{
beside: grownDeck(shape, 'beside').cells <= MAX_PANELS,
below: grownDeck(shape, 'below').cells <= MAX_PANELS,
},
NO_ROOM,
)
for (const slot of this.slots) (slot.panel ?? slot.cell)?.remeasure()
}
/**
* Cells in a row, right now.
*
* Clamped to the number of cells, because a `repeat(3, 1fr)` grid holding two
* items draws them two thirds of the way across and leaves a third of the
* width empty — which reads as a map that failed to load rather than as a
* deck with a column fewer than it had.
*/
private columnsNow(): number {
// The cells on screen: a hidden lead takes no column (§16.9).
const cells = Math.max(1, this.shownCells)
// One row of everything until somebody says otherwise, which is what a deck
// assembled a file at a time — through the palette, or from a link — has
// always been: side by side is how a figure compares conditions.
if (this.columns === null) return cells
return Math.min(Math.max(1, this.columns), cells)
}
/** Cells with a file in them, lead included — the budget's divisor. */
private get filled(): number {
return 1 + this.slots.filter((slot) => isMapRef(slot.ref)).length
}
/**
* The bar above the grid: how many maps, how they are laid out, and the two
* switches that are about the deck rather than about one panel.
*
* Repainted wholesale because it is a dozen nodes and it changes on every
* addition; the panels below it are the expensive things and they are kept.
*/
private paintBar(): void {
const cells = Math.max(1, this.shownCells)
// The maps on screen, for the count in the heading: the lead's unless it is
// the 1D browser or hidden (§16.9), and every companion's. Not `filled`,
// which is the budget's divisor — a hidden lead is still holding its block
// — and which counted a browser lead as a map it is not.
const leadMap = this.leadAxis === null && !this.leadHidden ? 1 : 0
const maps = leadMap + this.slots.filter((slot) => isMapRef(slot.ref)).length
// The cards with nothing in them — not `cells - filled`, which would count
// a structure cell as a gap (§25): it holds no *file*, and a file is what
// the budget divides by, but it is not empty.
const empty = this.slots.filter((slot) => slot.ref.kind === 'vacant').length
// The one control that puts a cell *into* the deck, and the reason it is
// here: the row of boxes below the bar takes a file or a URL, and until now
// nothing on screen opened it. It was reachable from the command palette
// alone — so a reader with a published cooler and a deck in front of them
// had a drop rectangle for a local file and no way at all to name a remote
// one, which is the road §11 exists for. A `+` on an edge draws an *empty*
// cell (§16.9); this one opens a cell with something in it.
//
// **`add a cell…`, not `add a map…`.** The row it opens ends in a structure
// cell and a tracks cell, and the tracks cell has no other road on screen —
// so the promise of a map was hiding the two cells that are not one, under
// the deck's own word for its occupants (§16.11).
const adding = !this.addRow.classList.contains('hidden')
const cellsOnly = this.props.mapsAllowed?.() === false
this.structureButton.disabled = false
this.structureButton.title = ADD_STRUCTURE
this.addRow.classList.toggle('is-cells-only', cellsOnly)
// And the `+` edges say the same thing the row does: what a cell here can
// hold. Told on every paint, because a session moves between a map lead and
// the browser with the deck intact.
this.edges.setHolds(cellsOnly ? 'cells' : 'maps')
const addMap = button(
adding ? 'cancel' : 'add a cell…',
() => (adding ? this.hideAdd() : this.promptAdd()),
{
// **Not lit while the row is open.** Lit means *on* in this application
// (§26.3), and a control reading `cancel` drawn like a mode that is on
// is the way out of the row wearing the look of a state to leave. It is
// bordered, like the row it opens and like the drawer's own cancel.
class: 'btn deck-add-toggle',
title: adding
? 'Put the row away without opening anything.'
: cellsOnly
? 'Open one more cell beside these: this tab’s 3D structure, or tracks alone.'
: 'Open one more cell beside these: a map from a file or a URL, this tab’s 3D ' +
'structure, or tracks alone.',
},
)
// **Two actions, not two modes**, and bordered like everything else here
// because that is what they are: things that *do* something, pressed once
// and finished, in a bar whose other members are the download and the copy.
//
// A mode here made a promise it could not keep. `one scale`, left on, meant
// that every later nudge of any panel's clip either had to be undone or left
// the deck claiming a shared scale it no longer had; and a resolution mode
// has the same problem the moment a reader picks a rung on one panel. A
// press says a thing that stays true — *these are all on that one's numbers
// now* — and the very next nudge is honestly their own again.
//
// **`match`, not `fix`.** Nothing here is broken, and a reader who has used
// Juicebox or HiGlass reads *fix* as repair; `match` is the verb for the
// one-off act of putting every picture on one map's footing, which is
// exactly what these two do.
//
// Both read from the **starred** map, which is the one every other "all of
// them" in this app is measured from: it is what a task runs against
// (§18.2), and making it what the scale and the rung come from too is one
// idea rather than three.
//
// The tooltips say what the press does and what it does not promise, in one
// sentence each: the argument for a press rather than a setting is this
// comment's job and the spec's, not the cursor's (§26.4).
const starName = this.starredName()
// With no map starred there is nothing to match *to*, and both are greyed
// with that reason on them rather than quietly reading the first map: the
// card beside the deck is setting every map at once in that state anyway.
const unstarred =
'No map is starred, so there is nothing to match the others to. Star the map to match them to.'
const share = button('match all scales', () => this.matchScales(), {
class: 'btn deck-share',
title:
this.starred === null
? unstarred
: `Draw every panel on ${starName}’s clip, so one colour is one number of contacts ` +
'across the deck. A press rather than a setting: nudge a panel’s clip afterwards and ' +
'it is on its own values again.',
})
share.disabled = this.starred === null
const resolutions = button('match all resolutions', () => this.matchResolutions(), {
class: 'btn deck-resolutions',
title:
this.starred === null
? unstarred
: `Read every panel at ${starName}’s bin size; a file with no such level stays where ` +
'it is and says so under its own map.',
})
resolutions.disabled = this.starred === null
// The preset row's honest replacement, and the only control here that is
// about the deck's *shape*. Without it a deck that arrived in a link could
// never be reshaped at all: a `+` only ever grows one.
const columns = el('select', { class: 'select select-tiny deck-columns' })
for (let n = 1; n <= cells; n++) {
columns.appendChild(el('option', { value: String(n), text: `${n} across` }))
}
columns.value = String(this.columnsNow())
// Cells, not maps: this lays out the structure and tracks cells too, and it
// offers `3 across` over a deck whose summary says one map. And the mark is
// written plain — a backtick in a `title` is drawn as a backtick, which
// reads as a typo (§26.4).
columns.title = 'How many cells in a row. The + on an edge opens cells; this arranges them.'
columns.addEventListener('change', () => this.setColumns(Number(columns.value)))
const save = iconButton(
'download',
'Save the whole deck as one figure, laid out as it is on screen',
() => void this.saveDeck(),
{ class: 'btn btn-icon deck-save', size: 14 },
)
// Beside the download, exactly as it is on a single map's Export card: they
// are the same figure going to two places, and ⌘C is the key that reaches
// this one (`ui/commands.ts`'s `copyPlot`, routed here by `app/Session.ts`
// whenever a deck is on).
const copy = iconButton(
'clipboard-copy',
withKey('Copy the whole deck as one PNG, laid out as it is on screen', KEYS.copyPlot),
() => void this.copyDeck(),
{ class: 'btn btn-icon deck-copy', size: 14 },
)
// The one control that takes the deck away, and the only one on the right.
//
// Every button in this bar acts on the deck as it stands; this one ends it,
// and a destructive control sitting in the middle of a row of adjustments is
// one a hand reaches by accident. So the row is read from the left and this
// is at the far end of it, which is where a window's close has been for
// thirty years. What it closes is stated rather than implied — the maps and
// whatever was loaded only for them ({@link closeDeck}).
//
// **A bordered word, not a bare ×.** It was the same 14 px mark a cell's own
// close is, on the argument that the two would read as one gesture at two
// scales — and on screen they read as one gesture full stop: two identical
// marks a finger's width apart, one taking a cell and the other taking every
// companion and the tracks loaded for them, which back navigation does not
// bring back. The bar already speaks in words, and §5.4's own rule is that a
// control styled unlike its neighbours is one a reader wonders about. So the
// bare mark stays the cell's, and the deck's says what it is.
const leadName = this.props.leadName?.() ?? (this.lead === null ? 'the tracks' : 'this map')
// The browser as lead is shown as what it is: its name is the genome's —
// for a model that opened the session, the model's own file — and `show
// yeast.bed3d` over a cell drawing yeast.bed3d reads as a button for the
// picture already on screen.
const leadShown = this.lead === null && this.leadAxis !== null ? 'the 1D browser' : leadName
const close = button('close deck', () => this.closeDeck(), {
class: 'btn deck-close',
title:
`Every cell but ${leadName}’s closes. Their maps stay on the Contact maps card, hidden, ` +
`and their tracks on the Tracks card; ${leadName}, and everything drawn on it, stays — ` +
'on screen again if it was hidden.',
})
// The way back for a hidden lead, where the reader is looking when it has
// gone: the bar of the deck it left (§16.9). A map's row on the Contact maps
// card has an eye for the same act; the 1D browser has no row there, and
// this is its only road back.
const showLead = this.leadHidden
? [
button(`show ${leadShown}`, () => this.showLead(), {
class: 'btn deck-show-lead',
title: `Put ${leadShown} back in the deck, in the cell it stood in`,
}),
]
: []
// How many maps is a fact about *what is being looked at*, so it goes in the
// line that already says that — beside the block's size and the window's
// span, in the view's own summary — rather than in a bar of controls. The
// empty cells are counted apart rather than folded in, because "4 maps"
// over a 2 × 2 grid with two rectangles in it is the deck telling the reader
// something they can see is untrue.
// The separator only where there is something in front of it — the summary
// is empty until the first block lands, and a line opening with a bullet is
// a sentence with its first clause missing. Drawn by the stylesheet
// (`.summary:not(:empty) + .deck-maps::before`) rather than written here,
// because the summary is rewritten on every pan and this line is not: a
// separator decided when the count was written was missing whenever the
// count landed before the first block did, and stayed missing.
// Singular where there is one, which is a state a reader does see: asking
// for a map builds the deck and shows its bar *before* a file has been
// chosen, and "1 maps" over one map is the deck's first sentence.
// The empty cells counted beside the maps and not *towards* them: it used
// to read `2 of 3 maps`, which was a promise of a third map from a cell
// that now takes a track or a structure as readily (§16.9).
// No count at all for a deck of no map — a structure beside the 1D browser
// is not *0 maps*, and it was *1 map*, counting the browser as one.
const counted = maps === 0 ? '' : `${maps} map${maps === 1 ? '' : 's'}`
const gaps = empty === 0 ? '' : `${empty} empty cell${empty === 1 ? '' : 's'}`
const count = [counted, gaps].filter((part) => part !== '').join(' · ')
this.deckNote.textContent = count
// Two sentences (§26.4). What the deck's own controls do is on them, and
// what a chain does is on the chain — said once, at the control, rather
// than a third time in a paragraph hanging off a count.
this.deckNote.title =
`A deck of ${this.rows()} × ${this.columnsNow()}` +
(empty === 0 ? '' : `, ${empty} empty — drop a file on one to open it there`) +
'. One navigation across every panel, and each panel keeps its own colour scale.'
// One left-aligned run, and one button at the far right.
//
// The spacer used to sit second, which split the bar into a chain on the
// left and three controls floated over against the right-hand edge — two
// groups, for a row that is one group. On a wide window the two halves ended
// up a screen apart, so reading the bar meant looking in two places, and
// which half a control was in said nothing about what it did. Everything
// that *adjusts* the deck now reads left to right in one run, and the only
// thing across the gap is the one that ends it.
// Adding a cell first, then the two presses, then the shape, then the two
// exports — which is the order a reader works in: get the maps on screen,
// put them on one footing, arrange them, take the picture. The one control
// that ends the deck stays across the gap.
//
// **The chain is not here any more.** It was the *first map's* own lock
// wearing the deck's bar, so one glyph sat at two heights meaning the same
// per-cell thing — and the one in the bar, among controls that act on every
// cell, read as a lock over the whole deck. It now sits in the lead cell's
// heading beside its star, where every other cell's chain is (§16.5).
this.toolbar.replaceChildren(
addMap,
...showLead,
// Only where a map can be: a deck beside the 1D browser holds tracks and
// structures (§25.3), and a press to match maps' scales there was
// a button with nothing to act on.
...(cellsOnly ? [] : [share, resolutions]),
columns,
save,
copy,
el('span', { class: 'deck-spacer' }),
close,
)
}
/**
* Put the whole deck down: every companion, and every lane that was on one.
*
* The maps are the easy half. The other half is the tracks, and the rule is
* that a deck put down is a statement about **layout** and never about what
* the reader has imported. A bigWig dropped on a companion's edge is an import
* into the session's one track list (`annotations/placement.ts`), and the
* lanes it had on the maps that are leaving go with them — but the track
* itself stays, as a row on the Annotations panel that is drawn nowhere, which
* is a state the model has always had and is one tick from being on the lead.
*
* It used to be a deletion, and the deletion was uneven in a way that read as
* a bug: a track the reader had *also* put on the lead survived, and one they
* had only ever put on a companion did not — so opening four replicates,
* giving each its own bigWig and then closing the deck lost three imports to a
* gesture about how many pictures are on screen.
*
* The lead is not in `slots` and is untouched throughout: §16.9's rule is that
* the first map is the session's own view, and closing a deck must leave the
* session exactly where closing the last companion one at a time would.
*/
private closeDeck(): void {
if (this.slots.length === 0) return
// The maps are put away, not let go (§16.9): each is handed to the session
// to hold hidden on the Contact maps card, as the × on its own cell does —
// after the grid is empty, so the session does not count them as shown.
const putAway: PickedFile[] = []
for (const slot of this.slots) {
if (slot.panel !== null && isMapRef(slot.ref)) putAway.push({ uri: slot.ref.uri, source: slot.panel.sourceSpec })
}
for (const slot of this.slots) {
this.lock.leave(slot.id)
slot.panel?.destroy()
slot.vacancy?.destroy()
slot.cell?.destroy()
}
this.slots = []
// The star comes back to the lead and the lanes go with the maps, the
// tracks staying behind — both from `paintGrid`, which runs for every other
// way a cell can leave as well ({@link keepStarPresent},
// {@link keepLanesOnLiveMaps}).
this.paintGrid()
for (const picked of putAway) this.props.onMapHidden?.(picked)
// Which leaves the deck empty, so the session's next render puts it down and
// hands the view back its own frame (`app/SessionDeck.ts`'s `sync`).
this.publish()
}
/**
* Take a departed map's tracks *off the map*, and keep the tracks.
*
* A track and its placement are two different things (`annotations/placement.ts`),
* and a map leaving the deck is a statement about the second. The map is gone,
* so its lanes are gone with it — but the *import* is a file the reader
* dropped, parsed once, named, coloured and possibly edited, and a cell being
* closed is not a reason to have thrown it away. A track with no lanes is a
* state the model has always had and is exactly the one this leaves: still on
* the Annotations panel, drawn nowhere, one tick from being on the lead.
*
* It used to `remove` any track the departing maps were the only reason for,
* which meant a reader who opened four replicates, gave each its own bigWig
* and then closed the deck lost three imports to a gesture about layout. The
* ones they had also put on the lead survived, which made the loss look
* arbitrary rather than deliberate.
*
* **From `paintGrid`, so it runs wherever the list changes**, which is
* `keepMaps`'s own stated contract — "reconciled against the deck rather than
* driven by an event … doing it once per render cannot go stale" — and which
* it was not getting. The only caller was the deck's own close, so closing
* *one* companion out of four, or following a link that named fewer maps than
* the deck held, left that map's lanes in the store bound to a slot id nothing
* would ever mint again: invisible, because the placement control lists the
* maps that exist and a lane on one that does not has no row to be unticked
* from, and still counted by everything that asks a track how many maps it is
* on.
*
* Keyed on the **slots**, not on the panels. A companion whose current view is
* a table has no `MatrixPanel` for a moment (`panels/MapPanel.ts` drops it for
* a plan of `none`) and is still very much a map in the deck; pruning against
* the panels would delete the reader's placements the first time they opened a
* genomes table.
*/
private keepLanesOnLiveMaps(): void {
const store = this.props.annotations?.(LEAD_MAP)?.store
if (store === undefined) return
// Which file each cell is showing, told to the store *while the cell is
// alive* — a slot id is minted per deck and never minted again, so the
// moment a map leaves there is nothing left to say which file it was. The
// panel's own URI where there is one, so a companion that descended into an
// entry of a collection is keyed by the map it is actually drawing.
// A tracks cell, which has no file, by its seat (`tracksCellKey`): the tracks
// placed on it are then parked, persisted and handed back exactly as a
// companion's are, where before they were kept against nothing and lost.
const files = new Map<MapId, string>()
const tracksCells = this.slots.filter((slot) => slot.ref.kind === 'tracks')
for (const slot of this.slots) {
const uri =
slot.ref.kind === 'tracks'
? tracksCellKey(tracksCells.indexOf(slot))
: (slot.panel?.uri ?? (isMapRef(slot.ref) ? slot.ref.uri : undefined))
if (uri !== undefined) files.set(slot.id, uri)
}
store.noteMapFiles(files)
// Parks what left onto the lead, keyed by that file…
store.keepMaps(new Set<MapId>([LEAD_MAP, ...this.slots.map((slot) => slot.id)]))
// …and hands it back to whichever cell is showing that file now, which is
// what makes closing a deck and opening it again put the tracks back where
// the reader had them. Both directions in one pass, on every render, for
// `keepMaps`'s own reason: a reconciliation cannot go stale and an event can.
for (const [map, uri] of files) store.adoptHome(map, uri)
}
/**
* Save the whole deck as one figure — the download in the bar.
*
* The picture is `deckFigure.ts`'s, from {@link deckFigures}; this is the
* half that names a file and hands it to the browser. Its twin is
* {@link copyDeck}, and the two share the drawing for the reason a single
* map's save and copy do: they are the same figure going to two places, and a
* second composition would be a second thing to keep in step.
*
* The PDF is a **vector page**, each cell drawn on it as its own PDF draws it
* — a map's cells the one image, everything else paths and text — laid out by
* the same composition the PNG is. It used to be the PNG on a page, which
* kept every axis and track name of six panels as pixels in the one file
* meant to be a drawing. So its name carries no dpi: a vector page has none.
*/
private async saveDeck(format: ExportFormat = 'png', dpi = DECK_EXPORT_DPI): Promise<void> {
const now = new Date()
// Where it goes first, while the press is still the reader's: composing six
// panels at 300 dpi can outlast the moment a browser will still open a save
// dialog for (`ui/export.ts`).
const target = await chooseSaveTarget(
format === 'pdf' ? `deck-${fileStamp(now)}.pdf` : `deck-${fileStamp(now)}-${dpi}dpi.png`,
format === 'pdf' ? 'application/pdf' : 'image/png',
)
if (target === null) return
const figures = this.deckFigures(now)
if (format === 'pdf') {
const page = vectorDeck(figures, this.columnsNow(), FIGURE_BACKGROUND)
const blob = await page.toBlob({ title: 'deck', created: now })
await target.write(blob)
return
}
const out = rasterDeck(figures, this.columnsNow(), FIGURE_BACKGROUND, dpi)
if (out === null) return
const blob = await new Promise<Blob | null>((resolve) => out.toBlob(resolve, 'image/png'))
if (blob === null) return
await target.write(blob)
}
/**
* The lead panel's Export card, answered by the deck.
*
* The card and the `S` key belong to the lead, and with maps beside it a
* reader pressing either is asking for the arrangement they made — the same
* reasoning `copyDeck` gives for ⌘C. A deck with nothing drawn beside the
* first map — every other cell empty — declines, and the panel exports its
* own figure, vector PDF and all.
*/
private readonly deckExport: DeckExport = {
save: async (format, dpi) => {
if (!this.hasOtherCells()) return false
await this.saveDeck(format, dpi)
return true
},
copy: async (dpi) => {
if (!this.hasOtherCells()) return false
await this.copyDeck(dpi)
return true
},
}
/**
* A tracks cell was panned: the lead goes there on its column axis, and
* reports through the lock to every other map (§25.3). One road in, so a
* cell never drives a companion the lead is not driving. A browser lead is
* taken there the same way, and tells the cells itself.
*/
private followColumns(range: { contig: string; start: number; end: number }): void {
if (this.lead !== null) this.lead.showLocusOnColumns(range)
else this.leadAxis?.show(range)
}
/**
* The lead the session mounted when it is **not a map** — its browser
* (§25.3). `null` when the lead is a map, or nothing.
*
* The map road is {@link setLead}; the two are exclusive, and the session
* calls the one for the view it mounted. The cells are told where the new
* lead is looking at once, since a browser reports nothing until it moves.
*/
setLeadAxis(axis: LeadAxis | null): void {
if (this.leadAxis !== null && this.leadAxis !== axis) this.leadAxis.setDeckExport?.(null)
const changed = (this.leadAxis === null) !== (axis === null)
this.leadAxis = axis
axis?.setDeckExport?.(this.deckExport)
// What the lead's heading and the bar say depends on which kind it is — a
// map is counted and hidden onto the Contact maps card, the browser is
// neither — so both are repainted when the kind changes.
if (changed) {
this.paintLeadHead()
this.paintBar()
}
if (axis !== null) this.leadMoved()
}
/** The browser lead moved: the cells follow, as they do a map's pan. */
leadMoved(): void {
const windows = this.leadWindows()
if (windows === null) return
for (const slot of this.slots) slot.cell?.applyWindow(windows)
}
/** Where the lead is looking, whichever shape it has, or `null` for none. */
private leadWindows(): { rows: LocusWindow[]; cols: LocusWindow[] } | null {
if (this.lead !== null) return this.lead.framedRanges()
return this.leadAxis?.windows() ?? null
}
/** Whether the deck holds any structure cell at all (§25). */
hasStructure(): boolean {
return this.slots.some((slot) => slot.ref.kind === 'structure')
}
/**
* Draw this structure row in **its own cell**, opening one if no cell is
* drawing it. The Structures card's eye lands here.
*
* It used to be one cell per deck: a second model took the cell the first
* was in, so a reader with two models could compare them only by swapping
* back and forth, and a reconstruction landing destroyed the picture it was
* to be judged against. A model gets a cell of its own now, and a cell keeps
* the model it was given — which is what makes two of them a comparison.
*
* Nothing happens where a cell already draws it: the eye is a state, and
* pressing a lit one is {@link hideStructure}'s business.
*/
showStructure(id: string): void {
for (const slot of this.slots) {
if (slot.cell?.shownModel?.() === id) return
}
// An empty structure cell first — one whose row has gone, or one opened
// from the bar before any model arrived — because a reader who made room
// meant it to be filled.
const empty = this.slots.find(
(slot) => slot.ref.kind === 'structure' && (slot.cell?.shownModel?.() ?? null) === null,
)
if (empty !== undefined) {
empty.cell?.showModel?.(id)
return
}
// The slots this deck held before the cell was opened, so the new one can
// be told apart: a fresh structure cell falls back to the first row the
// moment it syncs, so *the one with no model* would never find it.
const before = new Set(this.slots.filter((slot) => slot.ref.kind === 'structure'))
this.add({ kind: 'structure' })
const opened = this.slots.find((slot) => slot.ref.kind === 'structure' && !before.has(slot))
opened?.cell?.showModel?.(id)
}
/**
* Turn **this** cell into a structure cell drawing `id`.
*
* Where a row of the Structures card is dragged onto an empty cell, which is
* the gesture that says *where* as well as *which* (§25.3). {@link
* showStructure} — the eye — answers only *which*, so it picks the cell; a
* drop has already picked it, and going through the eye's road would open a
* different one and leave the cell that was aimed at empty.
*
* A model another cell is already drawing is drawn here **too**: two cells of
* one model are two views of it, and the reader dropping the row on this cell
* has said so about as plainly as it can be said.
*/
private putStructure(slot: Slot, id: string): void {
// The **built** cell and not the slot that was dropped on: `occupy`
// replaces the slot with the one it made, so the vacancy this was called
// for is no longer in the deck by the time the model is handed over.
this.occupy(slot, { kind: 'structure' })?.cell?.showModel?.(id)
}
/**
* Take a structure cell out of the deck: the one drawing `id`, or every one
* where no id is given.
*
* The counterpart of {@link showStructure}, for the eye on a Structures row:
* showing a model opens its cell, hiding it closes that cell again. The deck
* publishes as ever, so a deck left with nothing in it goes with it.
*/
hideStructure(id?: string): void {
for (const slot of [...this.slots]) {
if (slot.ref.kind !== 'structure') continue
if (id !== undefined && slot.cell?.shownModel?.() !== id) continue
this.remove(slot)
}
}
/**
* The **starred** structure cell's settings card, for the Aesthetics panel
* (§25.3), or `null` where there is no structure cell.
*
* The star and never the first cell in the list. A deck may hold several
* models and the column holds one card, so a reader with two of them was
* dragging sliders and watching the other picture change — and had no way
* at all to reach the second model's settings. The fallback is the first
* cell, for the deck that has never been asked: one model is not a choice.
*/
structureSettings(): HTMLElement | null {
const starred = this.slots.find((slot) => slot.id === this.starredStructure && slot.cell?.settings !== undefined)
const cell = starred ?? this.slots.find((slot) => slot.cell?.settings !== undefined)
return cell?.cell?.settings?.() ?? null
}
/** The structure cells, in the order they stand in the grid. */
private structureCells(): StructurePanel[] {
return this.slots
.map((slot) => slot.cell)
.filter((cell): cell is StructurePanel => cell instanceof StructurePanel)
}
/**
* Point the *3D structure* card at this cell, and fill its star alone — or,
* pressed where the star already is, take it off every cell.
*
* A radio, like the maps' star, because the card is one card: two filled
* stars would be two cells claiming one column. **With none filled** the
* card sets every structure cell at once (§25.3), which is the one way to
* draw a deck of models alike without setting each in turn.
*/
private setStarredStructure(id: string): void {
const next = this.starredStructure === id ? null : id
this.starredStructure = next
remember(this.props.memoryKey(), STRUCTURE_STAR_SCOPE, next ?? NO_STAR)
this.paintStructureStars()
// The card itself changes, so the column has to be rebuilt round it — the
// session owns where it goes (§25.3) and is the only thing that can move
// it.
this.props.onStructureStarChange?.()
}
/**
* Fill exactly one structure cell's star, and show them only where there is
* a choice to make.
*
* Called wherever the set of structure cells changes, for `paintStars`'
* reason: which cell is starred belongs to the deck and a cell has no way to
* ask. A star on a deck of one model is a radio with one option — a button
* that does nothing — so it appears with the second cell and goes with it.
*/
private paintStructureStars(): void {
const cells = this.slots.filter((slot) => slot.ref.kind === 'structure' && slot.cell !== null)
// The star follows the cells: one closed while it held the star leaves the
// card pointing at a cell that is gone, which is a column of controls for
// a picture nobody can see. *None* holds while there are cells for it to
// be about, and goes with the last of them, so the next model to arrive
// is starred the way every first one is.
if (cells.length === 0) {
if (this.starredStructure !== '') {
this.starredStructure = ''
remember(this.props.memoryKey(), STRUCTURE_STAR_SCOPE, '')
}
} else if (this.starredStructure !== null && !cells.some((slot) => slot.id === this.starredStructure)) {
this.starredStructure = cells[0]?.id ?? ''
remember(this.props.memoryKey(), STRUCTURE_STAR_SCOPE, this.starredStructure)
}
for (const slot of cells) {
slot.cell?.setStarred?.(slot.id === this.starredStructure)
slot.cell?.showStar?.(cells.length > 1)
}
}
/** The cells' commands, for the palette and its keys. */
cellCommands(): Command[] {
const out: Command[] = []
for (const slot of this.slots) out.push(...(slot.cell?.commands?.() ?? []))
return out
}
/** Every structure row the deck is drawing, one per structure cell. */
shownStructures(): string[] {
const out: string[] = []
for (const slot of this.slots) {
const shown = slot.cell?.shownModel?.()
if (shown !== undefined && shown !== null && !out.includes(shown)) out.push(shown)
}
return out
}
/**
* Whether any cell beside the lead has a picture of its own to export — a
* map, a structure, a stack of tracks.
*
* Every kind and not the maps alone: the Export card asks this to decide
* between the lead's own figure and the deck's, and a deck of the first map
* beside its 3D model answered *no maps beside it*, so saving or copying from
* the card wrote the map and left out the model the reader had arranged next
* to it. An empty cell still has nothing to say.
*/
private hasOtherCells(): boolean {
return this.slots.some((slot) => (slot.panel?.map ?? null) !== null || slot.cell !== null)
}
/**
* The same figure onto the clipboard — ⌘C, and the button beside the save.
*
* The key already copied *a* plot while a deck was on, and it copied the lead:
* one cell out of six, which on a screen showing six is the answer to a
* question nobody asked. With a deck up, "the figure" is the deck — that is
* what the reader arranged and what they are looking at — so the key follows
* the picture rather than the panel it happens to have been bound to
* (`app/Session.ts`).
*
* PNG, like every other clipboard export here: a clipboard holds an image, and
* a PDF pasted into a slide arrives as a file attachment instead of a picture.
*/
async copyDeck(dpi = DECK_EXPORT_DPI): Promise<void> {
const out = rasterDeck(this.deckFigures(new Date()), this.columnsNow(), FIGURE_BACKGROUND, dpi)
if (out === null) return
try {
await copyPngToClipboard(canvasToPng(out))
this.warn('')
} catch (err) {
// In the deck's own bar, where its other refusals go — see {@link NO_ROOM}.
// A clipboard write can be refused outright by a browser that has not been
// given permission, and a key that silently does nothing reads as broken.
this.warn(err instanceof Error ? `copy failed: ${err.message}` : 'copy failed')
}
}
/**
* Every cell's picture for the deck's figure, in the order they stand on
* screen (`panels/deckFigure.ts`).
*
* The thing somebody assembling a figure actually wants, and the one export
* no panel can produce for itself. Each cell draws its own — a map the same
* figure its own Export card saves, with its own key in its own corner and its
* own caption under it; a model, the tracks, the browser as lead each theirs —
* and the composition places them into the grid the reader drew. An empty
* cell is `null`, and stays a cell.
*/
private deckFigures(now: Date): Array<CellFigure | null> {
// The lead's wherever it was moved to and not at all while it is hidden
// (§16.9): the figure is the arrangement.
const leadAxis = this.leadAxis
return this.shownOrder().map((cell) => {
try {
if (cell !== LEAD_CELL) return cell.panel?.map?.deckFigure(now) ?? cell.cell?.figure(now) ?? null
// The browser as lead draws its own cell (§25.3) — it was a gap
// in the figure where the tracks stood on screen.
if (this.lead === null) return leadAxis?.figure?.(now) ?? null
return this.lead.deckFigure(now)
} catch {
// A cell that cannot even say how big it is leaves its place empty,
// and every other cell is right.
return null
}
})
}
private warn(message: string): void {
this.warning.textContent = message
this.warning.classList.toggle('hidden', message === '')
}
/** Rows the grid needs for the cells it has, at the current column count. */
private rows(): number {
return Math.ceil(Math.max(1, this.shownCells) / this.columnsNow())
}
private setColumns(columns: number): void {
this.columns = columns
remember(this.props.memoryKey(), 'deck:columns', columns)
this.applyLayout()
this.paintBar()
}
/** What to call the starred map in a sentence about it. */
private starredName(): string {
if (this.starred === null) return 'the starred map'
if (this.starred === LEAD_MAP) return this.props.leadName?.() ?? 'the first map'
const panel = this.starredPanel
return panel === null ? 'the starred map' : fileLabel(panel.uri)
}
/** The lead's colour scale, for the panels that have opted to share it. */
private leadLook(): ScaleState {
const scale = this.lead?.scale()
return scale === undefined ? {} : scaleState(scale)
}
/**
* The lead's scale **without** whatever a derivation borrowed from it (§7.5).
*
* What a new companion opens on, and deliberately not {@link leadLook}. The
* two differ exactly when the lead is drawing a derived field, and the case
* that matters is the one a companion cannot share: two files in the lead's
* square under `ratio` put it on `log2` and a diverging ramp, and a companion
* has one file and draws plain counts. Seeded with the live look it would draw
* them on `log2`, where every empty cell of a sparse block is `-Infinity` and
* the ramp's middle means nothing — a broken picture, from a control the
* reader never pointed at it.
*
* The derivations the deck *does* share need no exception: a companion turns
* them on for itself and reaches the same presentation by the same route.
*/
private leadBaseLook(): ScaleState {
const base = this.lead?.baseScale()
if (base === undefined) return this.leadLook()
return {
transform: base.transform,
colormap: base.colormap,
...(base.vmin === undefined ? {} : { vmin: base.vmin }),
...(base.vmax === undefined ? {} : { vmax: base.vmax }),
}
}
/**
* The drawn column count, if this file's deck had one.
*
* Validated rather than trusted: stored state outlives the code that wrote it
* (§8.6), and a `columns` of `0` or `NaN` coming back from a session written
* by an older build would divide the grid into no columns at all.
*/
private recallColumns(): number | null {
const stored = recall<number>(this.props.memoryKey(), 'deck:columns')
if (typeof stored !== 'number' || !Number.isFinite(stored) || stored < 1) return null
return Math.min(Math.floor(stored), MAX_PANELS)
}
/** What a previous visit remembered about how each companion was drawn. */
private recallLooks(): DeckLook[] {
const stored = recall<unknown>(this.props.memoryKey(), LOOKS_SCOPE)
if (!Array.isArray(stored)) return []
const out: DeckLook[] = []
for (const entry of stored as unknown[]) {
const look = readDeckLook(entry)
if (look !== null) out.push(look)
}
return out
}
/** This companion's remembered look, for the panel about to draw it. */
private lookFor(uri: string): DeckLook | undefined {
return this.looks.find((look) => look.uri === uri)
}
/**
* Write down how one companion is drawn.
*
* Keyed by the file rather than by the slot, and merged rather than appended:
* the reasons are `DeckLook`'s own. Written on every change rather than on a
* save, for the reason every other scope here is written that way — what
* storage holds *is* the session, so a reload, a durable restore and an
* exported workspace all describe the same deck.
*/
private noteLook(uri: string, look: Omit<DeckLook, 'uri'>): void {
this.looks = withLook(this.looks, { ...look, uri })
remember(this.props.memoryKey(), LOOKS_SCOPE, this.looks)
this.props.onLooksChange?.()
}
}
/** Where the tracks cells' names live in this session's memory, by seat (§25.3). */
const TRACKS_NAMES_SCOPE = 'deck:tracksNames'
/** …and their heights, where the reader set one with the bar under the stack. */
const TRACKS_HEIGHTS_SCOPE = 'deck:tracksHeights'
/** The tracks cell a slot holds, or `null` for a map, a structure or a gap. */
function tracksIn(slot: Slot): TracksPanel | null {
return slot.cell instanceof TracksPanel ? slot.cell : null
}
/** Where a deck's per-companion presentation lives in this session's memory. */
const LOOKS_SCOPE = 'deck:looks'
/** Where the starred structure cell is remembered (§25.3), by slot id. */
const STRUCTURE_STAR_SCOPE = 'deck:starredStructure'
/**
* How *no star* is written into this session's memory, for the maps' star and
* the structure cells' alike. A word no slot id can be — ids are minted as
* `p1`, `p2`… and the lead is `lead` — rather than `null`, which a recall
* cannot tell from nothing having been remembered at all.
*/
const NO_STAR = 'none'
/** The first map's settings as its card sets them, for {@link PanelDeck.mirrorLead}. */
interface LeadSettings {
score: string | undefined
oe: boolean
smooth: string
arms: number | undefined
transform: ScaleState['transform']
colormap: string | undefined
vmin: number | undefined
vmax: number | undefined
}
/**
* A panel's live scale as the thing another panel can be handed.
*
* `NaN` is how a `ColorScale` spells *auto* and `undefined` is how a
* {@link ScaleState} does, so the two cannot simply be copied across: a `NaN`
* passed on as a clip is a clip nothing is ever inside.
*/
function scaleState(scale: {
transform: ScaleState['transform']
colormap: string
vmin: number
vmax: number
}): ScaleState {
return {
transform: scale.transform,
colormap: scale.colormap,
...(Number.isFinite(scale.vmin) ? { vmin: scale.vmin } : {}),
...(Number.isFinite(scale.vmax) ? { vmax: scale.vmax } : {}),
}
}
/** The file half of a `file::group` URI — what a byte source is pointed at. */
function splitPath(uri: string): string {
const index = uri.indexOf('::')
return index < 0 ? uri : uri.slice(0, index)
}
/**
* What identifies the *block* a state selects, for the lock's purposes.
*
* The keys that choose data, and none of the ones that choose how it is drawn:
* a clip nudge must not reset the deck's window, and a change of region must.
* `level` is in it because a contig-level cell is a whole sequence rather than a
* stretch of one, so the two grids are not the same grid however similar the
* request looks.
*/
function placeKey(state: ViewState): string {
return JSON.stringify([
state.uri,
state.view,
state.genome,
state.genome2,
state.genomes,
state.region,
state.region2,
state.regions,
state.locus,
state.level,
])
}
|