aboutsummaryrefslogtreecommitdiff
path: root/src/fields/Doc.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/fields/Doc.ts')
-rw-r--r--src/fields/Doc.ts16
1 files changed, 13 insertions, 3 deletions
diff --git a/src/fields/Doc.ts b/src/fields/Doc.ts
index 31043f5be..c36bfb04b 100644
--- a/src/fields/Doc.ts
+++ b/src/fields/Doc.ts
@@ -428,6 +428,11 @@ export namespace Doc {
index = allowProtos && index !== -1 ? index : list.reduce((p, v, i) => (v instanceof Doc && Doc.AreProtosEqual(v, toFind)) ? i : p, -1);
return index; // list.findIndex(doc => doc === toFind || Doc.AreProtosEqual(doc, toFind));
}
+
+ /**
+ * Removes doc from the list of Docs at listDoc[fieldKey]
+ * @returns true if successful, false otherwise.
+ */
export function RemoveDocFromList(listDoc: Doc, fieldKey: string | undefined, doc: Doc) {
const key = fieldKey ? fieldKey : Doc.LayoutFieldKey(listDoc);
if (listDoc[key] === undefined) {
@@ -443,6 +448,11 @@ export namespace Doc {
}
return false;
}
+
+ /**
+ * Adds doc to the list of Docs stored at listDoc[fieldKey].
+ * @returns true if successful, false otherwise.
+ */
export function AddDocToList(listDoc: Doc, fieldKey: string | undefined, doc: Doc, relativeTo?: Doc, before?: boolean, first?: boolean, allowDuplicates?: boolean, reversed?: boolean) {
const key = fieldKey ? fieldKey : Doc.LayoutFieldKey(listDoc);
if (listDoc[key] === undefined) {
@@ -476,9 +486,9 @@ export namespace Doc {
return false;
}
- //
- // Computes the bounds of the contents of a set of documents.
- //
+ /**
+ * Computes the bounds of the contents of a set of documents.
+ */
export function ComputeContentBounds(docList: Doc[]) {
const bounds = docList.reduce((bounds, doc) => {
const [sptX, sptY] = [NumCast(doc.x), NumCast(doc.y)];