obsidian-typings 3.9.6 → 3.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/implementations.d.cts +173 -266
- package/dist/cjs/types.d.cts +181 -266
- package/dist/obsidian-typings.api.json +353 -98
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -9,7 +9,7 @@ import type { App as App$1, BrowserWindow } from 'electron';
|
|
|
9
9
|
import type { default as moment$1 } from 'moment';
|
|
10
10
|
import type { FSWatcher } from 'node:fs';
|
|
11
11
|
import type { App, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Platform, Plugin as Plugin, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
|
|
12
|
-
import type { Application, Container, Graphics, ICanvas, Text as Text$1, TextStyle } from 'pixi.js';
|
|
12
|
+
import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
15
|
* @todo Documentation incomplete.
|
|
@@ -1414,29 +1414,17 @@ export interface BaseEditor {
|
|
|
1414
1414
|
* @unofficial
|
|
1415
1415
|
*/
|
|
1416
1416
|
export interface BasesFunction {
|
|
1417
|
-
/**
|
|
1418
|
-
* @todo Documentation incomplete.
|
|
1419
|
-
*/
|
|
1417
|
+
/** @todo Documentation incomplete. */
|
|
1420
1418
|
app: App;
|
|
1421
|
-
/**
|
|
1422
|
-
* @todo Documentation incomplete.
|
|
1423
|
-
*/
|
|
1419
|
+
/** @todo Documentation incomplete. */
|
|
1424
1420
|
args: BasesFunctionArg[];
|
|
1425
|
-
/**
|
|
1426
|
-
* @todo Documentation incomplete.
|
|
1427
|
-
*/
|
|
1421
|
+
/** @todo Documentation incomplete. */
|
|
1428
1422
|
isOperator: boolean;
|
|
1429
|
-
/**
|
|
1430
|
-
* @todo Documentation incomplete.
|
|
1431
|
-
*/
|
|
1423
|
+
/** @todo Documentation incomplete. */
|
|
1432
1424
|
name: string;
|
|
1433
|
-
/**
|
|
1434
|
-
* @todo Documentation incomplete.
|
|
1435
|
-
*/
|
|
1425
|
+
/** @todo Documentation incomplete. */
|
|
1436
1426
|
returnType: string;
|
|
1437
|
-
/**
|
|
1438
|
-
* @todo Documentation incomplete.
|
|
1439
|
-
*/
|
|
1427
|
+
/** @todo Documentation incomplete. */
|
|
1440
1428
|
apply(...args: unknown[]): unknown;
|
|
1441
1429
|
/** @todo Documentation incomplete */
|
|
1442
1430
|
serialize(...args: unknown[]): string;
|
|
@@ -1447,25 +1435,15 @@ export interface BasesFunction {
|
|
|
1447
1435
|
* @unofficial
|
|
1448
1436
|
*/
|
|
1449
1437
|
export interface BasesFunctionArg {
|
|
1450
|
-
/**
|
|
1451
|
-
* @todo Documentation incomplete.
|
|
1452
|
-
*/
|
|
1438
|
+
/** @todo Documentation incomplete. */
|
|
1453
1439
|
include_custom_types?: boolean;
|
|
1454
|
-
/**
|
|
1455
|
-
* @todo Documentation incomplete.
|
|
1456
|
-
*/
|
|
1440
|
+
/** @todo Documentation incomplete. */
|
|
1457
1441
|
name: string;
|
|
1458
|
-
/**
|
|
1459
|
-
* @todo Documentation incomplete.
|
|
1460
|
-
*/
|
|
1442
|
+
/** @todo Documentation incomplete. */
|
|
1461
1443
|
optional?: boolean;
|
|
1462
|
-
/**
|
|
1463
|
-
* @todo Documentation incomplete.
|
|
1464
|
-
*/
|
|
1444
|
+
/** @todo Documentation incomplete. */
|
|
1465
1445
|
type: string[];
|
|
1466
|
-
/**
|
|
1467
|
-
* @todo Documentation incomplete.
|
|
1468
|
-
*/
|
|
1446
|
+
/** @todo Documentation incomplete. */
|
|
1469
1447
|
variadic?: boolean;
|
|
1470
1448
|
}
|
|
1471
1449
|
/**
|
|
@@ -1474,193 +1452,99 @@ export interface BasesFunctionArg {
|
|
|
1474
1452
|
* @unofficial
|
|
1475
1453
|
*/
|
|
1476
1454
|
export interface BasesFunctions {
|
|
1477
|
-
/**
|
|
1478
|
-
* @todo Documentation incomplete.
|
|
1479
|
-
*/
|
|
1455
|
+
/** @todo Documentation incomplete. */
|
|
1480
1456
|
"!=": NotEqualFunction;
|
|
1481
|
-
/**
|
|
1482
|
-
* @todo Documentation incomplete.
|
|
1483
|
-
*/
|
|
1457
|
+
/** @todo Documentation incomplete. */
|
|
1484
1458
|
"<": LessFunction;
|
|
1485
|
-
/**
|
|
1486
|
-
* @todo Documentation incomplete.
|
|
1487
|
-
*/
|
|
1459
|
+
/** @todo Documentation incomplete. */
|
|
1488
1460
|
"<=": LessOrEqualFunction;
|
|
1489
|
-
/**
|
|
1490
|
-
* @todo Documentation incomplete.
|
|
1491
|
-
*/
|
|
1461
|
+
/** @todo Documentation incomplete. */
|
|
1492
1462
|
"==": EqualFunction;
|
|
1493
|
-
/**
|
|
1494
|
-
* @todo Documentation incomplete.
|
|
1495
|
-
*/
|
|
1463
|
+
/** @todo Documentation incomplete. */
|
|
1496
1464
|
">": GreaterFunction;
|
|
1497
|
-
/**
|
|
1498
|
-
* @todo Documentation incomplete.
|
|
1499
|
-
*/
|
|
1465
|
+
/** @todo Documentation incomplete. */
|
|
1500
1466
|
">=": GreaterOrEqualFunction;
|
|
1501
|
-
/**
|
|
1502
|
-
* @todo Documentation incomplete.
|
|
1503
|
-
*/
|
|
1467
|
+
/** @todo Documentation incomplete. */
|
|
1504
1468
|
abs: AbsFunction;
|
|
1505
|
-
/**
|
|
1506
|
-
* @todo Documentation incomplete.
|
|
1507
|
-
*/
|
|
1469
|
+
/** @todo Documentation incomplete. */
|
|
1508
1470
|
ceil: CeilFunction;
|
|
1509
|
-
/**
|
|
1510
|
-
* @todo Documentation incomplete.
|
|
1511
|
-
*/
|
|
1471
|
+
/** @todo Documentation incomplete. */
|
|
1512
1472
|
concat: ConcatFunction;
|
|
1513
|
-
/**
|
|
1514
|
-
* @todo Documentation incomplete.
|
|
1515
|
-
*/
|
|
1473
|
+
/** @todo Documentation incomplete. */
|
|
1516
1474
|
contains: ContainsFunction;
|
|
1517
|
-
/**
|
|
1518
|
-
* @todo Documentation incomplete.
|
|
1519
|
-
*/
|
|
1475
|
+
/** @todo Documentation incomplete. */
|
|
1520
1476
|
containsAll: ContainsAllFunction;
|
|
1521
|
-
/**
|
|
1522
|
-
* @todo Documentation incomplete.
|
|
1523
|
-
*/
|
|
1477
|
+
/** @todo Documentation incomplete. */
|
|
1524
1478
|
containsAny: ContainsAnyFunction;
|
|
1525
|
-
/**
|
|
1526
|
-
* @todo Documentation incomplete.
|
|
1527
|
-
*/
|
|
1479
|
+
/** @todo Documentation incomplete. */
|
|
1528
1480
|
containsNone: ContainsNoneFunction;
|
|
1529
|
-
/**
|
|
1530
|
-
* @todo Documentation incomplete.
|
|
1531
|
-
*/
|
|
1481
|
+
/** @todo Documentation incomplete. */
|
|
1532
1482
|
dateAfter: DateAfterFunction;
|
|
1533
|
-
/**
|
|
1534
|
-
* @todo Documentation incomplete.
|
|
1535
|
-
*/
|
|
1483
|
+
/** @todo Documentation incomplete. */
|
|
1536
1484
|
dateBefore: DateBeforeFunction;
|
|
1537
|
-
/**
|
|
1538
|
-
* @todo Documentation incomplete.
|
|
1539
|
-
*/
|
|
1485
|
+
/** @todo Documentation incomplete. */
|
|
1540
1486
|
dateDiff: DateDiffFunction;
|
|
1541
|
-
/**
|
|
1542
|
-
* @todo Documentation incomplete.
|
|
1543
|
-
*/
|
|
1487
|
+
/** @todo Documentation incomplete. */
|
|
1544
1488
|
dateEquals: DateEqualsFunction;
|
|
1545
|
-
/**
|
|
1546
|
-
* @todo Documentation incomplete.
|
|
1547
|
-
*/
|
|
1489
|
+
/** @todo Documentation incomplete. */
|
|
1548
1490
|
dateModify: DateModifyFunction;
|
|
1549
|
-
/**
|
|
1550
|
-
* @todo Documentation incomplete.
|
|
1551
|
-
*/
|
|
1491
|
+
/** @todo Documentation incomplete. */
|
|
1552
1492
|
dateNotEquals: DateNotEqualsFunction;
|
|
1553
|
-
/**
|
|
1554
|
-
* @todo Documentation incomplete.
|
|
1555
|
-
*/
|
|
1493
|
+
/** @todo Documentation incomplete. */
|
|
1556
1494
|
dateOnOrAfter: DateOnOrAfterFunction;
|
|
1557
|
-
/**
|
|
1558
|
-
* @todo Documentation incomplete.
|
|
1559
|
-
*/
|
|
1495
|
+
/** @todo Documentation incomplete. */
|
|
1560
1496
|
dateOnOrBefore: DateOnOrBeforeFunction;
|
|
1561
|
-
/**
|
|
1562
|
-
* @todo Documentation incomplete.
|
|
1563
|
-
*/
|
|
1497
|
+
/** @todo Documentation incomplete. */
|
|
1564
1498
|
day: DayFunction;
|
|
1565
|
-
/**
|
|
1566
|
-
* @todo Documentation incomplete.
|
|
1567
|
-
*/
|
|
1499
|
+
/** @todo Documentation incomplete. */
|
|
1568
1500
|
empty: EmptyFunction;
|
|
1569
|
-
/**
|
|
1570
|
-
* @todo Documentation incomplete.
|
|
1571
|
-
*/
|
|
1501
|
+
/** @todo Documentation incomplete. */
|
|
1572
1502
|
flat: FlatFunction;
|
|
1573
|
-
/**
|
|
1574
|
-
* @todo Documentation incomplete.
|
|
1575
|
-
*/
|
|
1503
|
+
/** @todo Documentation incomplete. */
|
|
1576
1504
|
floor: FloorFunction;
|
|
1577
|
-
/**
|
|
1578
|
-
* @todo Documentation incomplete.
|
|
1579
|
-
*/
|
|
1505
|
+
/** @todo Documentation incomplete. */
|
|
1580
1506
|
hour: HourFunction;
|
|
1581
|
-
/**
|
|
1582
|
-
* @todo Documentation incomplete.
|
|
1583
|
-
*/
|
|
1507
|
+
/** @todo Documentation incomplete. */
|
|
1584
1508
|
if: IfFunction;
|
|
1585
|
-
/**
|
|
1586
|
-
* @todo Documentation incomplete.
|
|
1587
|
-
*/
|
|
1509
|
+
/** @todo Documentation incomplete. */
|
|
1588
1510
|
index: IndexFunction;
|
|
1589
|
-
/**
|
|
1590
|
-
* @todo Documentation incomplete.
|
|
1591
|
-
*/
|
|
1511
|
+
/** @todo Documentation incomplete. */
|
|
1592
1512
|
inFolder: InFolderFunction;
|
|
1593
|
-
/**
|
|
1594
|
-
* @todo Documentation incomplete.
|
|
1595
|
-
*/
|
|
1513
|
+
/** @todo Documentation incomplete. */
|
|
1596
1514
|
join: JoinFunction;
|
|
1597
|
-
/**
|
|
1598
|
-
* @todo Documentation incomplete.
|
|
1599
|
-
*/
|
|
1515
|
+
/** @todo Documentation incomplete. */
|
|
1600
1516
|
len: LenFunction;
|
|
1601
|
-
/**
|
|
1602
|
-
* @todo Documentation incomplete.
|
|
1603
|
-
*/
|
|
1517
|
+
/** @todo Documentation incomplete. */
|
|
1604
1518
|
linksTo: LinksToFunction;
|
|
1605
|
-
/**
|
|
1606
|
-
* @todo Documentation incomplete.
|
|
1607
|
-
*/
|
|
1519
|
+
/** @todo Documentation incomplete. */
|
|
1608
1520
|
min: MinFunction;
|
|
1609
|
-
/**
|
|
1610
|
-
* @todo Documentation incomplete.
|
|
1611
|
-
*/
|
|
1521
|
+
/** @todo Documentation incomplete. */
|
|
1612
1522
|
minute: MinuteFunction;
|
|
1613
|
-
/**
|
|
1614
|
-
* @todo Documentation incomplete.
|
|
1615
|
-
*/
|
|
1523
|
+
/** @todo Documentation incomplete. */
|
|
1616
1524
|
month: MonthFunction;
|
|
1617
|
-
/**
|
|
1618
|
-
* @todo Documentation incomplete.
|
|
1619
|
-
*/
|
|
1525
|
+
/** @todo Documentation incomplete. */
|
|
1620
1526
|
not: NotFunction;
|
|
1621
|
-
/**
|
|
1622
|
-
* @todo Documentation incomplete.
|
|
1623
|
-
*/
|
|
1527
|
+
/** @todo Documentation incomplete. */
|
|
1624
1528
|
notContains: NotContainsFunction;
|
|
1625
|
-
/**
|
|
1626
|
-
* @todo Documentation incomplete.
|
|
1627
|
-
*/
|
|
1529
|
+
/** @todo Documentation incomplete. */
|
|
1628
1530
|
notEmpty: NotEmptyFunction;
|
|
1629
|
-
/**
|
|
1630
|
-
* @todo Documentation incomplete.
|
|
1631
|
-
*/
|
|
1531
|
+
/** @todo Documentation incomplete. */
|
|
1632
1532
|
now: NowFunction;
|
|
1633
|
-
/**
|
|
1634
|
-
* @todo Documentation incomplete.
|
|
1635
|
-
*/
|
|
1533
|
+
/** @todo Documentation incomplete. */
|
|
1636
1534
|
round: RoundFunction;
|
|
1637
|
-
/**
|
|
1638
|
-
* @todo Documentation incomplete.
|
|
1639
|
-
*/
|
|
1535
|
+
/** @todo Documentation incomplete. */
|
|
1640
1536
|
second: SecondFunction;
|
|
1641
|
-
/**
|
|
1642
|
-
* @todo Documentation incomplete.
|
|
1643
|
-
*/
|
|
1537
|
+
/** @todo Documentation incomplete. */
|
|
1644
1538
|
slice: SliceFunction;
|
|
1645
|
-
/**
|
|
1646
|
-
* @todo Documentation incomplete.
|
|
1647
|
-
*/
|
|
1539
|
+
/** @todo Documentation incomplete. */
|
|
1648
1540
|
taggedWith: TaggedWithFunction;
|
|
1649
|
-
/**
|
|
1650
|
-
* @todo Documentation incomplete.
|
|
1651
|
-
*/
|
|
1541
|
+
/** @todo Documentation incomplete. */
|
|
1652
1542
|
title: TitleFunction;
|
|
1653
|
-
/**
|
|
1654
|
-
* @todo Documentation incomplete.
|
|
1655
|
-
*/
|
|
1543
|
+
/** @todo Documentation incomplete. */
|
|
1656
1544
|
trim: TrimFunction;
|
|
1657
|
-
/**
|
|
1658
|
-
* @todo Documentation incomplete.
|
|
1659
|
-
*/
|
|
1545
|
+
/** @todo Documentation incomplete. */
|
|
1660
1546
|
unique: UniqueFunction;
|
|
1661
|
-
/**
|
|
1662
|
-
* @todo Documentation incomplete.
|
|
1663
|
-
*/
|
|
1547
|
+
/** @todo Documentation incomplete. */
|
|
1664
1548
|
year: YearFunction;
|
|
1665
1549
|
}
|
|
1666
1550
|
/**
|
|
@@ -1669,9 +1553,7 @@ export interface BasesFunctions {
|
|
|
1669
1553
|
* @unofficial
|
|
1670
1554
|
*/
|
|
1671
1555
|
export interface BasesHandlers extends Record<string, ViewFactory> {
|
|
1672
|
-
/**
|
|
1673
|
-
* @todo Documentation incomplete.
|
|
1674
|
-
*/
|
|
1556
|
+
/** @todo Documentation incomplete. */
|
|
1675
1557
|
table: ViewFactory<TableView>;
|
|
1676
1558
|
}
|
|
1677
1559
|
/**
|
|
@@ -5423,9 +5305,7 @@ export interface FootnotesPlugin extends InternalPlugin<FootnotesPluginInstance>
|
|
|
5423
5305
|
* @unofficial
|
|
5424
5306
|
*/
|
|
5425
5307
|
export interface FootnotesPluginInstance extends InternalPluginInstance<FootnotesPlugin> {
|
|
5426
|
-
/**
|
|
5427
|
-
* @todo Documentation incomplete.
|
|
5428
|
-
*/
|
|
5308
|
+
/** @todo Documentation incomplete. */
|
|
5429
5309
|
initLeaf(): void;
|
|
5430
5310
|
}
|
|
5431
5311
|
/**
|
|
@@ -5517,25 +5397,27 @@ export interface GraphBookmarkItem extends BookmarkItem {
|
|
|
5517
5397
|
type: "graph";
|
|
5518
5398
|
}
|
|
5519
5399
|
/**
|
|
5520
|
-
*
|
|
5400
|
+
* Color attributes.
|
|
5401
|
+
*
|
|
5521
5402
|
* @public
|
|
5522
5403
|
* @unofficial
|
|
5523
5404
|
*/
|
|
5524
5405
|
export interface GraphColorAttributes {
|
|
5525
|
-
/**
|
|
5406
|
+
/** Alpha channel. */
|
|
5526
5407
|
a: number;
|
|
5527
|
-
/**
|
|
5408
|
+
/** Color stored as an integer (`rgb = c.r << 16 | c.g << 8 | c.b` where channels are 8-bits unsigned integers). */
|
|
5528
5409
|
rgb: number;
|
|
5529
5410
|
}
|
|
5530
5411
|
/**
|
|
5531
|
-
*
|
|
5412
|
+
* Group of nodes set by the user.
|
|
5413
|
+
*
|
|
5532
5414
|
* @public
|
|
5533
5415
|
* @unofficial
|
|
5534
5416
|
*/
|
|
5535
5417
|
export interface GraphColorGroup {
|
|
5536
|
-
/**
|
|
5418
|
+
/** Color associated to the group. */
|
|
5537
5419
|
color: GraphColorAttributes;
|
|
5538
|
-
/**
|
|
5420
|
+
/** Query associated to the group. */
|
|
5539
5421
|
query: string;
|
|
5540
5422
|
}
|
|
5541
5423
|
/**
|
|
@@ -5561,16 +5443,16 @@ export interface GraphColorGroupOptionsGroup {
|
|
|
5561
5443
|
query: TextComponent;
|
|
5562
5444
|
}
|
|
5563
5445
|
/**
|
|
5564
|
-
*
|
|
5446
|
+
* Data selected to be rendered in the graph based on the current options.
|
|
5565
5447
|
*
|
|
5566
5448
|
* @public
|
|
5567
5449
|
* @unofficial
|
|
5568
5450
|
*/
|
|
5569
5451
|
export interface GraphData {
|
|
5570
|
-
/**
|
|
5571
|
-
nodes: Record<string,
|
|
5572
|
-
/**
|
|
5573
|
-
|
|
5452
|
+
/** Record of nodes selected to be rendered. Their IDs are used as keys. */
|
|
5453
|
+
nodes: Record<string, GraphNodeData>;
|
|
5454
|
+
/** Number of links. */
|
|
5455
|
+
numLinks: number;
|
|
5574
5456
|
}
|
|
5575
5457
|
/**
|
|
5576
5458
|
* @todo Documentation incomplete.
|
|
@@ -5580,7 +5462,8 @@ export interface GraphData {
|
|
|
5580
5462
|
export interface GraphDisplayOptions extends GraphOptions {
|
|
5581
5463
|
}
|
|
5582
5464
|
/**
|
|
5583
|
-
*
|
|
5465
|
+
* Engine of a graph view.
|
|
5466
|
+
*
|
|
5584
5467
|
* @public
|
|
5585
5468
|
* @unofficial
|
|
5586
5469
|
*/
|
|
@@ -5680,24 +5563,25 @@ export interface GraphForces {
|
|
|
5680
5563
|
repelStrength?: number;
|
|
5681
5564
|
}
|
|
5682
5565
|
/**
|
|
5683
|
-
*
|
|
5566
|
+
* Represents a link in a graph view.
|
|
5567
|
+
*
|
|
5684
5568
|
* @public
|
|
5685
5569
|
* @unofficial
|
|
5686
5570
|
*/
|
|
5687
5571
|
export interface GraphLink {
|
|
5688
|
-
/**
|
|
5572
|
+
/** PixiJS element for the arrow, child of `GraphRenderer.hanger`. */
|
|
5689
5573
|
arrow: Graphics | null;
|
|
5690
|
-
/**
|
|
5691
|
-
line:
|
|
5692
|
-
/**
|
|
5574
|
+
/** PixiJS element for the line. */
|
|
5575
|
+
line: Sprite | null;
|
|
5576
|
+
/** Parent of `GraphLink.line`, child of `GraphRenderer.hanger`. */
|
|
5693
5577
|
px: Container | null;
|
|
5694
5578
|
/** @todo Documentation incomplete. */
|
|
5695
5579
|
rendered: boolean;
|
|
5696
|
-
/**
|
|
5580
|
+
/** `GraphRenderer` managing this node. */
|
|
5697
5581
|
renderer: GraphRenderer;
|
|
5698
|
-
/**
|
|
5582
|
+
/** Source node of the link. */
|
|
5699
5583
|
source: GraphNode;
|
|
5700
|
-
/**
|
|
5584
|
+
/** Target node of the link. */
|
|
5701
5585
|
target: GraphNode;
|
|
5702
5586
|
/**
|
|
5703
5587
|
* Destroy the graphics and its children, and remove them from the scene.
|
|
@@ -5707,42 +5591,53 @@ export interface GraphLink {
|
|
|
5707
5591
|
* Initialize the link (line and arrow), and add them to the scene.
|
|
5708
5592
|
*/
|
|
5709
5593
|
initGraphics(): void;
|
|
5594
|
+
/**
|
|
5595
|
+
* Render the link.
|
|
5596
|
+
*/
|
|
5597
|
+
render(): void;
|
|
5710
5598
|
}
|
|
5711
5599
|
/**
|
|
5712
|
-
*
|
|
5600
|
+
* Represents a node in the graph view.
|
|
5601
|
+
*
|
|
5713
5602
|
* @public
|
|
5714
5603
|
* @unofficial
|
|
5715
5604
|
*/
|
|
5716
5605
|
export interface GraphNode {
|
|
5717
|
-
/**
|
|
5606
|
+
/** PixiJS element for the circle, child of `GraphRenderer.hanger`. */
|
|
5718
5607
|
circle: Graphics | null;
|
|
5719
|
-
/**
|
|
5608
|
+
/** Computed color for the node. */
|
|
5720
5609
|
color: GraphColorAttributes;
|
|
5721
5610
|
/** @todo Documentation incomplete. */
|
|
5722
|
-
|
|
5723
|
-
/**
|
|
5611
|
+
fadeAlpha: number;
|
|
5612
|
+
/** Indicates if the text needs to be re-rendered when the node is rendered. */
|
|
5613
|
+
fontDirty: boolean;
|
|
5614
|
+
/** Record of forward links. Keys are the id of the neighbor nodes. */
|
|
5615
|
+
forward: Record<string, GraphLink>;
|
|
5616
|
+
/** Forced x position when the node is dragged. */
|
|
5724
5617
|
fx: number | null;
|
|
5725
|
-
/**
|
|
5618
|
+
/** Forced y position when the node is dragged. */
|
|
5726
5619
|
fy: number | null;
|
|
5727
|
-
/**
|
|
5620
|
+
/** Colored circle added if the node is highlighted, child of `GraphNode.circle`. */
|
|
5728
5621
|
highlight: Graphics | null;
|
|
5729
|
-
/**
|
|
5622
|
+
/** ID of the node (path, tag, or name for non-existing files). */
|
|
5730
5623
|
id: string;
|
|
5624
|
+
/** Displacement of the text, changed when the node is hovered */
|
|
5625
|
+
moveText: number;
|
|
5731
5626
|
/** @todo Documentation incomplete. */
|
|
5732
5627
|
rendered: boolean;
|
|
5733
|
-
/**
|
|
5628
|
+
/** `GraphRenderer` managing this node */
|
|
5734
5629
|
renderer: GraphRenderer;
|
|
5735
|
-
/**
|
|
5736
|
-
reverse: Record<string,
|
|
5737
|
-
/**
|
|
5630
|
+
/** Record of backward links. Keys are the id of the neighbor nodes. */
|
|
5631
|
+
reverse: Record<string, GraphLink>;
|
|
5632
|
+
/** PixiJS element for the name, child of `GraphNode.circle`. */
|
|
5738
5633
|
text: Text$1 | null;
|
|
5739
|
-
/**
|
|
5634
|
+
/** Type of the node, can be of value `"tag"`, `"unresolved"`, `"attachment"`, or an empty string for markdown nodes. */
|
|
5740
5635
|
type: string;
|
|
5741
|
-
/**
|
|
5636
|
+
/** Weight of the node depending on the number of related nodes (forwards and backward). */
|
|
5742
5637
|
weight: number;
|
|
5743
|
-
/**
|
|
5638
|
+
/** X-axis position of the node in the graph */
|
|
5744
5639
|
x: number;
|
|
5745
|
-
/**
|
|
5640
|
+
/** Y-axis position of the node in the graph */
|
|
5746
5641
|
y: number;
|
|
5747
5642
|
/**
|
|
5748
5643
|
* Destroy the graphics and its children, and remove them from the scene.
|
|
@@ -5778,11 +5673,29 @@ export interface GraphNode {
|
|
|
5778
5673
|
* Initialize the node, text, listeners, and add them to the scene.
|
|
5779
5674
|
*/
|
|
5780
5675
|
initGraphics(): void;
|
|
5676
|
+
/**
|
|
5677
|
+
* Method called when the node (circle) is clicked, trigger the context menu if it's a right click
|
|
5678
|
+
*/
|
|
5679
|
+
onClick(e: MouseEvent): void;
|
|
5781
5680
|
/**
|
|
5782
5681
|
* Render the node.
|
|
5783
5682
|
*/
|
|
5784
5683
|
render(): void;
|
|
5785
5684
|
}
|
|
5685
|
+
/**
|
|
5686
|
+
* Node data, used before the rendering process.
|
|
5687
|
+
*
|
|
5688
|
+
* @public
|
|
5689
|
+
* @unofficial
|
|
5690
|
+
*/
|
|
5691
|
+
export interface GraphNodeData {
|
|
5692
|
+
/** Color of the node if it is part of a group */
|
|
5693
|
+
color?: GraphColorAttributes;
|
|
5694
|
+
/** Record of forward neighbor nodes. */
|
|
5695
|
+
links: Record<string, boolean>;
|
|
5696
|
+
/** Type of the node, can be of value `"tag"`, `"unresolved"`, `"attachment"`, or an empty string for markdown nodes. */
|
|
5697
|
+
type: string;
|
|
5698
|
+
}
|
|
5786
5699
|
/**
|
|
5787
5700
|
* @todo Documentation incomplete.
|
|
5788
5701
|
* @public
|
|
@@ -5889,47 +5802,47 @@ export interface GraphPluginInstanceOptions {
|
|
|
5889
5802
|
* @unofficial
|
|
5890
5803
|
*/
|
|
5891
5804
|
export interface GraphRenderer {
|
|
5892
|
-
/**
|
|
5805
|
+
/** General colors of the elements in the graph view, computed from the app CSS. */
|
|
5893
5806
|
colors: Record<GraphColor, GraphColorAttributes>;
|
|
5894
|
-
/**
|
|
5807
|
+
/** `<div>` element containing the graph, with class `.view-content`. */
|
|
5895
5808
|
containerEl: HTMLDivElement;
|
|
5896
|
-
/**
|
|
5809
|
+
/** Node currently being dragged, if any. */
|
|
5897
5810
|
dragNode: GraphNode | null;
|
|
5898
|
-
/**
|
|
5811
|
+
/** Factor for the thickness of the links. */
|
|
5899
5812
|
fLineSizeMult: number;
|
|
5900
|
-
/**
|
|
5813
|
+
/** Factor for the size of the nodes. */
|
|
5901
5814
|
fNodeSizeMult: number;
|
|
5902
|
-
/**
|
|
5815
|
+
/** Indicates if arrows should be displayed. */
|
|
5903
5816
|
fShowArrow: boolean;
|
|
5904
|
-
/**
|
|
5817
|
+
/** Text fade threshold. */
|
|
5905
5818
|
fTextShowMult: number;
|
|
5906
|
-
/**
|
|
5819
|
+
/** Main container to which nodes, links and arrows are added. */
|
|
5907
5820
|
hanger: Container;
|
|
5908
|
-
/**
|
|
5821
|
+
/** Height of the graph view, in pixel. */
|
|
5909
5822
|
height: number;
|
|
5910
5823
|
/** @todo Documentation incomplete. */
|
|
5911
5824
|
hidePowerTag: boolean;
|
|
5912
|
-
/**
|
|
5825
|
+
/** Node currently being highlighted, if any. */
|
|
5913
5826
|
highlightNode: GraphNode | null;
|
|
5914
|
-
/**
|
|
5827
|
+
/** Number of idle frames. The simulation stops running at 60. */
|
|
5915
5828
|
idleFrames: number;
|
|
5916
|
-
/**
|
|
5829
|
+
/** `<iframe>` element in which the graph is rendered. */
|
|
5917
5830
|
iframeEl: HTMLIFrameElement;
|
|
5918
|
-
/**
|
|
5831
|
+
/** `<canvas>` element bound to the event system of `GraphRenderer.px` to capture events. */
|
|
5919
5832
|
interactiveEl: HTMLCanvasElement;
|
|
5920
5833
|
/** @todo Documentation incomplete. */
|
|
5921
5834
|
keyboardActions: KeyboardActions;
|
|
5922
|
-
/**
|
|
5835
|
+
/** List of links currently rendered. */
|
|
5923
5836
|
links: GraphLink[];
|
|
5924
|
-
/**
|
|
5925
|
-
mouseX: null;
|
|
5926
|
-
/**
|
|
5927
|
-
mouseY: null;
|
|
5928
|
-
/**
|
|
5837
|
+
/** Mouse x coordinate in the graph view. */
|
|
5838
|
+
mouseX: number | null;
|
|
5839
|
+
/** Mouse y coordinate in the graph view. */
|
|
5840
|
+
mouseY: number | null;
|
|
5841
|
+
/** Record of the nodes currently rendered, with `GraphNode.id` used as key. */
|
|
5929
5842
|
nodeLookup: Record<string, GraphNode>;
|
|
5930
|
-
/**
|
|
5843
|
+
/** List of nodes currenly rendered. */
|
|
5931
5844
|
nodes: GraphNode[];
|
|
5932
|
-
/**
|
|
5845
|
+
/** Scale of the nodes based on the zoom level of the graph view. */
|
|
5933
5846
|
nodeScale: number;
|
|
5934
5847
|
/** @todo Documentation incomplete. */
|
|
5935
5848
|
panning: boolean;
|
|
@@ -5943,27 +5856,27 @@ export interface GraphRenderer {
|
|
|
5943
5856
|
panY: number;
|
|
5944
5857
|
/** @todo Documentation incomplete. */
|
|
5945
5858
|
powerTag: PowerTag;
|
|
5946
|
-
/**
|
|
5859
|
+
/** PixiJS application rendering everything. */
|
|
5947
5860
|
px: Application;
|
|
5948
|
-
/**
|
|
5861
|
+
/** Timer (request ID) associated to the requestAnimationFrame rendering the graph. */
|
|
5949
5862
|
renderTimer: null | number;
|
|
5950
|
-
/**
|
|
5863
|
+
/** Current zoom level of the graph view, interpolated between the previous one and the `targetScale`. */
|
|
5951
5864
|
scale: number;
|
|
5952
|
-
/**
|
|
5865
|
+
/** Target zoom level of the graph view. */
|
|
5953
5866
|
targetScale: number;
|
|
5954
|
-
/**
|
|
5867
|
+
/** Current alpha of the nodes names based on the graph scale. */
|
|
5955
5868
|
textAlpha: number;
|
|
5956
5869
|
/** @todo Documentation incomplete. */
|
|
5957
5870
|
viewport: Coords;
|
|
5958
|
-
/**
|
|
5871
|
+
/** Widt of the graph view, in pixel. */
|
|
5959
5872
|
width: number;
|
|
5960
|
-
/**
|
|
5873
|
+
/** Web Worker thread running the graph simulation. */
|
|
5961
5874
|
worker: Worker;
|
|
5962
5875
|
/** @todo Documentation incomplete. */
|
|
5963
5876
|
workerResults: WorkerResults;
|
|
5964
|
-
/**
|
|
5877
|
+
/** X coordinate of the zoom action. */
|
|
5965
5878
|
zoomCenterX: number;
|
|
5966
|
-
/**
|
|
5879
|
+
/** Y coordinate of the zoom action. */
|
|
5967
5880
|
zoomCenterY: number;
|
|
5968
5881
|
/**
|
|
5969
5882
|
* Specify that the renderer has changed and needs to be rendered again.
|
|
@@ -5971,15 +5884,15 @@ export interface GraphRenderer {
|
|
|
5971
5884
|
changed(): void;
|
|
5972
5885
|
/** @todo Documentation incomplete. */
|
|
5973
5886
|
destroy(): void;
|
|
5974
|
-
/**
|
|
5887
|
+
/** Destroy all the graphics of the graph. */
|
|
5975
5888
|
destroyGraphics(): void;
|
|
5976
5889
|
/** @todo Documentation incomplete. */
|
|
5977
5890
|
getBackgroundScreenshot(): HTMLCanvasElement;
|
|
5978
|
-
/**
|
|
5891
|
+
/** Returns the currently highlighted node, if any. */
|
|
5979
5892
|
getHighlightNode(): GraphNode | null;
|
|
5980
5893
|
/** @todo Documentation incomplete. */
|
|
5981
5894
|
getTransparentScreenshot(): ICanvas;
|
|
5982
|
-
/**
|
|
5895
|
+
/** Initialize all the graphics of the graph. */
|
|
5983
5896
|
initGraphics(): void;
|
|
5984
5897
|
/** @todo Documentation incomplete. */
|
|
5985
5898
|
onIframeLoad(): void;
|
|
@@ -6029,7 +5942,8 @@ export interface GraphRenderer {
|
|
|
6029
5942
|
zoomTo(scale: number, pointer: Pointer): void;
|
|
6030
5943
|
}
|
|
6031
5944
|
/**
|
|
6032
|
-
*
|
|
5945
|
+
* Obsidian view for a global graph.
|
|
5946
|
+
*
|
|
6033
5947
|
* @public
|
|
6034
5948
|
* @unofficial
|
|
6035
5949
|
*/
|
|
@@ -6106,9 +6020,7 @@ export interface HardWrapOptions {
|
|
|
6106
6020
|
* @unofficial
|
|
6107
6021
|
*/
|
|
6108
6022
|
export interface HasCompare {
|
|
6109
|
-
/**
|
|
6110
|
-
* @todo Documentation incomplete.
|
|
6111
|
-
*/
|
|
6023
|
+
/** @todo Documentation incomplete. */
|
|
6112
6024
|
compare(a: unknown, b: unknown): boolean;
|
|
6113
6025
|
}
|
|
6114
6026
|
/**
|
|
@@ -6117,9 +6029,7 @@ export interface HasCompare {
|
|
|
6117
6029
|
* @unofficial
|
|
6118
6030
|
*/
|
|
6119
6031
|
export interface HasExtract {
|
|
6120
|
-
/**
|
|
6121
|
-
* @todo Documentation incomplete.
|
|
6122
|
-
*/
|
|
6032
|
+
/** @todo Documentation incomplete. */
|
|
6123
6033
|
extract(date: Date): number;
|
|
6124
6034
|
}
|
|
6125
6035
|
/**
|
|
@@ -6128,9 +6038,7 @@ export interface HasExtract {
|
|
|
6128
6038
|
* @unofficial
|
|
6129
6039
|
*/
|
|
6130
6040
|
export interface HasGetDisplayName {
|
|
6131
|
-
/**
|
|
6132
|
-
* @todo Documentation incomplete.
|
|
6133
|
-
*/
|
|
6041
|
+
/** @todo Documentation incomplete. */
|
|
6134
6042
|
getDisplayName(type: string): string;
|
|
6135
6043
|
}
|
|
6136
6044
|
/**
|
|
@@ -6139,9 +6047,7 @@ export interface HasGetDisplayName {
|
|
|
6139
6047
|
* @unofficial
|
|
6140
6048
|
*/
|
|
6141
6049
|
export interface HasGetRHSWidgetType {
|
|
6142
|
-
/**
|
|
6143
|
-
* @todo Documentation incomplete.
|
|
6144
|
-
*/
|
|
6050
|
+
/** @todo Documentation incomplete. */
|
|
6145
6051
|
getRHSWidgetType(type: string): string;
|
|
6146
6052
|
}
|
|
6147
6053
|
/**
|
|
@@ -6956,7 +6862,8 @@ export interface LinksToFunction extends BasesFunction, HasGetDisplayName, HasGe
|
|
|
6956
6862
|
export interface LoadProgress {
|
|
6957
6863
|
}
|
|
6958
6864
|
/**
|
|
6959
|
-
*
|
|
6865
|
+
* Obsidian view for a local graph.
|
|
6866
|
+
*
|
|
6960
6867
|
* @public
|
|
6961
6868
|
* @unofficial
|
|
6962
6869
|
*/
|
|
@@ -11204,12 +11111,12 @@ export type FileExplorerViewSortOrder = "alphabetical" | "alphabeticalReverse" |
|
|
|
11204
11111
|
*/
|
|
11205
11112
|
export type FileTreeItemParent = FolderTreeItem | TreeRoot<FileTreeItem | FolderTreeItem>;
|
|
11206
11113
|
/**
|
|
11207
|
-
*
|
|
11114
|
+
* Available color types.
|
|
11208
11115
|
*
|
|
11209
11116
|
* @public
|
|
11210
11117
|
* @unofficial
|
|
11211
11118
|
*/
|
|
11212
|
-
export type GraphColor = "arrow" | "circle" | "fill" | "fillAttachment" | "fillFocused" | "fillHighlight" | "fillTag" | "fillUnresolved" | "line" | "lineHighlight";
|
|
11119
|
+
export type GraphColor = "arrow" | "circle" | "fill" | "fillAttachment" | "fillFocused" | "fillHighlight" | "fillTag" | "fillUnresolved" | "line" | "lineHighlight" | "text";
|
|
11213
11120
|
/**
|
|
11214
11121
|
* @todo Documentation incomplete.
|
|
11215
11122
|
*
|