chrono-phylo-tree 1.0.7 → 1.0.8
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/README.md +13 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,6 +12,10 @@ You can test and explore the functionality of the chrono-phylo-tree library by v
|
|
|
12
12
|
|
|
13
13
|
### Updates
|
|
14
14
|
|
|
15
|
+
**1.0.8**
|
|
16
|
+
|
|
17
|
+
- Species class' step functions can include or not species whose `display` is `false`.
|
|
18
|
+
|
|
15
19
|
**1.0.7**
|
|
16
20
|
|
|
17
21
|
- The default duration of the ancestors and descendants are the duration of the species
|
|
@@ -272,31 +276,37 @@ Returns an array of all descendants of the species, sorted by appearance time.
|
|
|
272
276
|
#### stepsChain
|
|
273
277
|
|
|
274
278
|
```typescript
|
|
275
|
-
stepsChain(desc: Species): Species[]
|
|
279
|
+
stepsChain(desc: Species, includeNotDisplay = false): Species[]
|
|
276
280
|
```
|
|
277
281
|
|
|
278
282
|
Returns an array of `Species` objects representing the chain of species from the current species (`this`) to the specified descendant (`desc`). The chain includes all intermediate species in the lineage. If the specified descendant is not a descendant of the current species, the method returns an empty array.
|
|
279
283
|
|
|
280
284
|
- **desc**: The descendant species to which the chain is traced.
|
|
281
285
|
|
|
286
|
+
- **includeNotDisplay**: If `true`, include the species whose `display` is `false`.
|
|
287
|
+
|
|
282
288
|
#### stepsUntil
|
|
283
289
|
|
|
284
290
|
```typescript
|
|
285
|
-
stepsUntil(desc: Species): number
|
|
291
|
+
stepsUntil(desc: Species, includeNotDisplay = false): number
|
|
286
292
|
```
|
|
287
293
|
|
|
288
294
|
Returns the number of steps (generations) from the current species (`this`) to the specified descendant (`desc`). If the specified descendant is not a descendant of the current species, the method returns `undefined`.
|
|
289
295
|
|
|
290
296
|
- **desc**: The descendant species to which the number of steps is calculated.
|
|
291
297
|
|
|
298
|
+
- **includeNotDisplay**: If `true`, include the species whose `display` is `false`.
|
|
299
|
+
|
|
292
300
|
#### stepsUntilLastDescendant
|
|
293
301
|
|
|
294
302
|
```typescript
|
|
295
|
-
stepsUntilLastDescendant(): number
|
|
303
|
+
stepsUntilLastDescendant(includeNotDisplay = false): number
|
|
296
304
|
```
|
|
297
305
|
|
|
298
306
|
Returns the maximum number of steps (generations) from the current species (`this`) to its most distant descendant. If the current species has no descendants, the method returns `0`.
|
|
299
307
|
|
|
308
|
+
- **includeNotDisplay**: If `true`, include the species whose `display` is `false`.
|
|
309
|
+
|
|
300
310
|
#### toJSON
|
|
301
311
|
|
|
302
312
|
```typescript
|