From 9f24171a29b544b9c68f180f7b589c418b304129 Mon Sep 17 00:00:00 2001 From: denisname Date: Fri, 18 May 2018 12:38:34 +0200 Subject: [PATCH] Update Readme Remove comment about reserved properties preceeding -> preceding or -> and --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9f8b017d..22485f56 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ You must call *node*.sort before invoking a hierarchical layout if you want the # node.each(function) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/hierarchy/each.js "Source") -Invokes the specified *function* for *node* and each descendant in [breadth-first order](https://en.wikipedia.org/wiki/Breadth-first_search), such that a given *node* is only visited if all nodes of lesser depth have already been visited, as well as all preceeding nodes of the same depth. The specified function is passed the current *node*. +Invokes the specified *function* for *node* and each descendant in [breadth-first order](https://en.wikipedia.org/wiki/Breadth-first_search), such that a given *node* is only visited if all nodes of lesser depth have already been visited, as well as all preceding nodes of the same depth. The specified function is passed the current *node*. # node.eachAfter(function) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/hierarchy/eachAfter.js "Source") @@ -266,7 +266,7 @@ Constructs a new stratify operator with the default settings. # stratify(data) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/stratify.js#L20 "Source") -Generates a new hierarchy from the specified tabular *data*. Each node in the returned object has a shallow copy of the properties from the corresponding data object, excluding the following reserved properties: id, parentId, children. +Generates a new hierarchy from the specified tabular *data*. # stratify.id([id]) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/stratify.js#L64 "Source") @@ -534,7 +534,7 @@ If *size* is specified, sets this pack layout’s size to the specified two-elem # pack.padding([padding]) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/pack/index.js#L38 "Source") -If *padding* is specified, sets this pack layout’s padding accessor to the specified number or function or returns this pack layout. If *padding* is not specified, returns the current padding accessor, which defaults to the constant zero. When siblings are packed, tangent siblings will be separated by approximately the specified padding; the enclosing parent circle will also be separated from its children by approximately the specified padding. If an [explicit radius](#pack_radius) is not specified, the padding is approximate because a two-pass algorithm is needed to fit within the [layout size](#pack_size): the circles are first packed without padding; a scaling factor is computed and applied to the specified padding; and lastly the circles are re-packed with padding. +If *padding* is specified, sets this pack layout’s padding accessor to the specified number or function and returns this pack layout. If *padding* is not specified, returns the current padding accessor, which defaults to the constant zero. When siblings are packed, tangent siblings will be separated by approximately the specified padding; the enclosing parent circle will also be separated from its children by approximately the specified padding. If an [explicit radius](#pack_radius) is not specified, the padding is approximate because a two-pass algorithm is needed to fit within the [layout size](#pack_size): the circles are first packed without padding; a scaling factor is computed and applied to the specified padding; and lastly the circles are re-packed with padding. # d3.packSiblings(circles) [<>](https://github.com/d3/d3-hierarchy/blob/master/src/pack/siblings.js "Source")