Skip to content

Commit 1e66163

Browse files
committed
Updating docs
1 parent 47c572c commit 1e66163

File tree

11 files changed

+91
-21
lines changed

11 files changed

+91
-21
lines changed

.bin/api/data.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16011,7 +16011,7 @@
1601116011
"title": "method",
1601216012
"description": null,
1601316013
"lineNumber": 6,
16014-
"name": "group"
16014+
"name": "ungroup"
1601516015
},
1601616016
{
1601716017
"title": "param",
@@ -16205,7 +16205,7 @@
1620516205
"throws": [],
1620616206
"todos": [],
1620716207
"kind": "function",
16208-
"name": "group",
16208+
"name": "ungroup",
1620916209
"memberof": "pub",
1621016210
"scope": "static",
1621116211
"members": {
@@ -16217,12 +16217,12 @@
1621716217
},
1621816218
"path": [
1621916219
{
16220-
"name": "group",
16220+
"name": "ungroup",
1622116221
"kind": "function",
1622216222
"scope": "static"
1622316223
}
1622416224
],
16225-
"namespace": ".group"
16225+
"namespace": ".ungroup"
1622616226
},
1622716227
{
1622816228
"description": {

_data/categories.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1671,7 +1671,7 @@
16711671
"codetitle": "b.group(pItems, [name])"
16721672
},
16731673
{
1674-
"name": "group",
1674+
"name": "ungroup",
16751675
"description": "Ungroups an existing group. Returns an array of the items that were within the group before\n b.ungroup() was called.",
16761676
"returns": {
16771677
"name": null,
@@ -1702,7 +1702,7 @@
17021702
],
17031703
"examples": [],
17041704
"todo": null,
1705-
"codetitle": "b.group(group)"
1705+
"codetitle": "b.ungroup(group)"
17061706
},
17071707
{
17081708
"name": "labels",

_data/cats-and-subcats.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@
672672
"codetitle": "b.group(pItems, [name])"
673673
},
674674
{
675-
"name": "group",
675+
"name": "ungroup",
676676
"description": "Ungroups an existing group. Returns an array of the items that were within the group before\n b.ungroup() was called.",
677677
"returns": {
678678
"name": null,
@@ -703,7 +703,7 @@
703703
],
704704
"examples": [],
705705
"todo": null,
706-
"codetitle": "b.group(group)"
706+
"codetitle": "b.ungroup(group)"
707707
},
708708
{
709709
"name": "guideX",

document/BACK.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: entry
3+
title: BACK
4+
codetitle: b.BACK
5+
description: 'Used with b.arrange() to send a page item to the back or to send it behind a given reference object.'
6+
category: Document
7+
subcategory: Page
8+
returns: null
9+
parameters: []
10+
kind: property
11+
todo: null
12+
examples: []
13+
14+
---

document/BACKWARD.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: entry
3+
title: BACKWARD
4+
codetitle: b.BACKWARD
5+
description: 'Used with b.arrange() to send a page item one level backward in its layer.'
6+
category: Document
7+
subcategory: Page
8+
returns: null
9+
parameters: []
10+
kind: property
11+
todo: null
12+
examples: []
13+
14+
---

document/FORWARD.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: entry
3+
title: FORWARD
4+
codetitle: b.FORWARD
5+
description: 'Used with b.arrange() to bring a page item one level forward in its layer.'
6+
category: Document
7+
subcategory: Page
8+
returns: null
9+
parameters: []
10+
kind: property
11+
todo: null
12+
examples: []
13+
14+
---

document/FRONT.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: entry
3+
title: FRONT
4+
codetitle: b.FRONT
5+
description: 'Used with b.arrange() to bring a page item to the front or to bring it in front of a given reference object.'
6+
category: Document
7+
subcategory: Page
8+
returns: null
9+
parameters: []
10+
kind: property
11+
todo: null
12+
examples: []
13+
14+
---

document/Group.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
---
22
layout: entry
33
title: group
4-
codetitle: b.group(group)
5-
description: "Ungroups an existing group. Returns an array of the items that were within the group before\n b.ungroup() was called."
4+
codetitle: 'b.group(pItems, [name])'
5+
description: "Returns the Group instance and sets it if argument Group is given.\n Groups items to a new group. Returns the resulting group instance. If a string is given as the only\n argument, the group by the given name will be returned."
66
category: Document
77
subcategory: null
88
returns:
99
name: null
10-
description: 'An array of the ungrouped page items.'
11-
type: [Array]
10+
description: 'The group instance.'
11+
type: [Group]
1212
parameters:
13-
- {name: group, description: 'The group instance or name of the group to ungroup.', optional: false, type: [Group, String]}
14-
kind: function
15-
todo: null
16-
examples: []
17-
18-
---
19-
ype: [Array]}
13+
- {name: pItems, description: 'An array of page items (must contain at least two items) or name of group instance.', optional: false, type: [Array]}
2014
- {name: name, description: 'The name of the group, only when creating a group from page items.', optional: true, type: [String]}
2115
kind: function
2216
todo: null

document/arrange.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: entry
3+
title: arrange
4+
codetitle: 'b.arrange(pItemOrLayer, positionOrDirection, [reference])'
5+
description: 'Arranges a page item or a layer before or behind other page items or layers. If using the constants '
6+
category: Document
7+
subcategory: Page
8+
returns:
9+
name: null
10+
description: 'The newly arranged page item or layer.'
11+
type: [PageItem, Layer]
12+
parameters:
13+
- {name: pItemOrLayer, description: 'The page item or layer to be moved to a new position.', optional: false, type: [PageItem, Layer]}
14+
- {name: positionOrDirection, description: 'The position or direction to move the page item or layer. Can be <code>b.FRONT</code>, <code>b.BACK</code>, <code>b.FORWARD</code> or <code>b.BACKWARD</code>.', optional: false, type: [String]}
15+
- {name: reference, description: 'A reference object to move the page item or layer behind or in front of.', optional: true, type: [null]}
16+
kind: function
17+
todo: null
18+
examples: []
19+
20+
---

document/ellipseMode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: entry
33
title: ellipseMode
44
codetitle: b.ellipseMode(mode)
5-
description: "The origin of new ellipses is modified by the ellipseMode() function.\nThe default configuration is ellipseMode(CENTER), which specifies the\nlocation of the ellipse as the center of the shape. The RADIUS mode is\nthe same, but the width and height parameters to ellipse() specify the\nradius of the ellipse, rather than the diameter. The CORNER mode draws\nthe shape from the upper-left corner of its bounding box. The CORNERS\nmode uses the four parameters to ellipse() to set two opposing corners\nof the ellipse's bounding box. The parameter must be written in \"ALL CAPS\"."
5+
description: "The origin of new ellipses is modified by the b.ellipseMode() function.\nThe default configuration is b.ellipseMode(b.CENTER), which specifies the\nlocation of the ellipse as the center of the shape. The b.RADIUS mode is\nthe same, but the "
66
category: Document
77
subcategory: Attributes
88
returns: null

0 commit comments

Comments
 (0)