|
1418 | 1418 | },
|
1419 | 1419 | {
|
1420 | 1420 | "name": "pageCount",
|
1421 |
| - "description": "The number of all pages in the current document.", |
| 1421 | + "description": "Returns the number of all pages in the current document. If a number is given as an argument,\nit will set the document's page count to the given number by either adding pages or removing\npages until the number is reached. If pages are added, the master page of the document's last\npage will be applied to the new pages.", |
1422 | 1422 | "returns": {
|
1423 | 1423 | "name": null,
|
1424 | 1424 | "description": "The amount of pages.",
|
|
1428 | 1428 | },
|
1429 | 1429 | "category": "Document",
|
1430 | 1430 | "subcategory": "Page",
|
1431 |
| - "parameters": [], |
| 1431 | + "parameters": [ |
| 1432 | + { |
| 1433 | + "name": "pageCount", |
| 1434 | + "description": "New page count of the document (integer between 1 and 9999).", |
| 1435 | + "optional": true, |
| 1436 | + "type": [ |
| 1437 | + "Number" |
| 1438 | + ] |
| 1439 | + } |
| 1440 | + ], |
1432 | 1441 | "kind": "function",
|
1433 | 1442 | "tags": [],
|
1434 | 1443 | "examples": [],
|
1435 | 1444 | "todo": null,
|
1436 |
| - "codetitle": "b.pageCount()" |
| 1445 | + "codetitle": "b.pageCount([pageCount])" |
1437 | 1446 | },
|
1438 | 1447 | {
|
1439 | 1448 | "name": "storyCount",
|
|
1523 | 1532 | "codetitle": "b.layer([layer])"
|
1524 | 1533 | },
|
1525 | 1534 | {
|
1526 |
| - "name": "Group", |
1527 |
| - "description": "Returns the Group instance and sets it if argument Group is given.", |
| 1535 | + "name": "group", |
| 1536 | + "description": "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.", |
1528 | 1537 | "returns": {
|
1529 | 1538 | "name": null,
|
1530 |
| - "description": "The current Group instance.", |
| 1539 | + "description": "The group instance.", |
1531 | 1540 | "type": [
|
1532 | 1541 | "Group"
|
1533 | 1542 | ]
|
|
1536 | 1545 | "subcategory": null,
|
1537 | 1546 | "parameters": [
|
1538 | 1547 | {
|
1539 |
| - "name": "pItem", |
1540 |
| - "description": "The PageItems array (must be at least 2) or name of Group name instance.", |
1541 |
| - "optional": true, |
| 1548 | + "name": "pItems", |
| 1549 | + "description": "An array of page items (must contain at least two items) or name of group instance.", |
| 1550 | + "optional": false, |
1542 | 1551 | "type": [
|
1543 | 1552 | "Array"
|
1544 | 1553 | ]
|
1545 | 1554 | },
|
1546 | 1555 | {
|
1547 | 1556 | "name": "name",
|
1548 |
| - "description": "The name of the Group, only when creating a Group from Page Item(s).", |
1549 |
| - "optional": false, |
| 1557 | + "description": "The name of the group, only when creating a group from page items.", |
| 1558 | + "optional": true, |
1550 | 1559 | "type": [
|
1551 | 1560 | "String"
|
1552 | 1561 | ]
|
|
1561 | 1570 | ],
|
1562 | 1571 | "examples": [],
|
1563 | 1572 | "todo": null,
|
1564 |
| - "codetitle": "b.Group([pItem], name)" |
| 1573 | + "codetitle": "b.group(pItems, [name])" |
1565 | 1574 | },
|
1566 | 1575 | {
|
1567 |
| - "name": "Group", |
1568 |
| - "description": "Returns an array of the items that were within the Group before b.ungroup() was called", |
| 1576 | + "name": "group", |
| 1577 | + "description": "Ungroups an existing group. Returns an array of the items that were within the group before\n b.ungroup() was called.", |
1569 | 1578 | "returns": {
|
1570 | 1579 | "name": null,
|
1571 |
| - "description": "The Page Item(s) that were grouped.", |
| 1580 | + "description": "An array of the ungrouped page items.", |
1572 | 1581 | "type": [
|
1573 |
| - "Group" |
| 1582 | + "Array" |
1574 | 1583 | ]
|
1575 | 1584 | },
|
1576 | 1585 | "category": "Document",
|
1577 | 1586 | "subcategory": null,
|
1578 | 1587 | "parameters": [
|
1579 | 1588 | {
|
1580 |
| - "name": "pItem", |
1581 |
| - "description": "The Group or name of Group name instance.", |
1582 |
| - "optional": true, |
1583 |
| - "type": [ |
1584 |
| - null |
1585 |
| - ] |
1586 |
| - }, |
1587 |
| - { |
1588 |
| - "name": "name", |
1589 |
| - "description": "The name of the Group, only when creating a Group from Page Item(s).", |
| 1589 | + "name": "group", |
| 1590 | + "description": "The group instance or name of the group to ungroup.", |
1590 | 1591 | "optional": false,
|
1591 | 1592 | "type": [
|
| 1593 | + "Group", |
1592 | 1594 | "String"
|
1593 | 1595 | ]
|
1594 | 1596 | }
|
|
1602 | 1604 | ],
|
1603 | 1605 | "examples": [],
|
1604 | 1606 | "todo": null,
|
1605 |
| - "codetitle": "b.Group([pItem], name)" |
| 1607 | + "codetitle": "b.group(group)" |
1606 | 1608 | },
|
1607 | 1609 | {
|
1608 | 1610 | "name": "labels",
|
|
2207 | 2209 | },
|
2208 | 2210 | {
|
2209 | 2211 | "name": "rect",
|
2210 |
| - "description": "Draws a rectangle on the page.", |
| 2212 | + "description": "Draws a rectangle on the page.\nBy default, the first two parameters set the location of the upper-left corner, the third sets the width, and the fourth sets the height. The way these parameters are interpreted, however, may be changed with the b.rectMode() function.\nThe fifth, sixth, seventh and eighth parameters, if specified, determine corner radius for the top-right, top-left, lower-right and lower-left corners, respectively. If only a fifth parameter is provided, all corners will be set to this radius.", |
2211 | 2213 | "returns": {
|
2212 | 2214 | "name": null,
|
2213 | 2215 | "description": "The rectangle that was created.",
|
|
2249 | 2251 | "type": [
|
2250 | 2252 | "Number"
|
2251 | 2253 | ]
|
| 2254 | + }, |
| 2255 | + { |
| 2256 | + "name": "tl", |
| 2257 | + "description": "Radius of top left corner or radius of all 4 corners (optional).", |
| 2258 | + "optional": true, |
| 2259 | + "type": [ |
| 2260 | + "Number" |
| 2261 | + ] |
| 2262 | + }, |
| 2263 | + { |
| 2264 | + "name": "tr", |
| 2265 | + "description": "Radius of top right corner (optional).", |
| 2266 | + "optional": true, |
| 2267 | + "type": [ |
| 2268 | + "Number" |
| 2269 | + ] |
| 2270 | + }, |
| 2271 | + { |
| 2272 | + "name": "br", |
| 2273 | + "description": "Radius of bottom right corner (optional).", |
| 2274 | + "optional": true, |
| 2275 | + "type": [ |
| 2276 | + "Number" |
| 2277 | + ] |
| 2278 | + }, |
| 2279 | + { |
| 2280 | + "name": "bl", |
| 2281 | + "description": "Radius of bottom left corner (optional).", |
| 2282 | + "optional": true, |
| 2283 | + "type": [ |
| 2284 | + "Number" |
| 2285 | + ] |
2252 | 2286 | }
|
2253 | 2287 | ],
|
2254 | 2288 | "kind": "function",
|
2255 | 2289 | "tags": [],
|
2256 | 2290 | "examples": [],
|
2257 | 2291 | "todo": null,
|
2258 |
| - "codetitle": "b.rect(x, y, w, h)" |
| 2292 | + "codetitle": "b.rect(x, y, w, h, [tl], [tr], [br], [bl])" |
2259 | 2293 | },
|
2260 | 2294 | {
|
2261 | 2295 | "name": "rectMode",
|
|
8043 | 8077 | "todo": null,
|
8044 | 8078 | "codetitle": "b.isNumber(num)"
|
8045 | 8079 | },
|
| 8080 | + { |
| 8081 | + "name": "isInteger", |
| 8082 | + "description": "Checks whether a var is an integer, returns true if this is the case.", |
| 8083 | + "returns": { |
| 8084 | + "name": null, |
| 8085 | + "description": "Returns true if the given argument is an integer.", |
| 8086 | + "type": [ |
| 8087 | + "Boolean" |
| 8088 | + ] |
| 8089 | + }, |
| 8090 | + "category": "Data", |
| 8091 | + "subcategory": "Type-Check", |
| 8092 | + "parameters": [ |
| 8093 | + { |
| 8094 | + "name": "num", |
| 8095 | + "description": "The number to check.", |
| 8096 | + "optional": false, |
| 8097 | + "type": [ |
| 8098 | + "Object", |
| 8099 | + "String", |
| 8100 | + "Number", |
| 8101 | + "Boolean" |
| 8102 | + ] |
| 8103 | + } |
| 8104 | + ], |
| 8105 | + "kind": "function", |
| 8106 | + "tags": [], |
| 8107 | + "examples": [], |
| 8108 | + "todo": null, |
| 8109 | + "codetitle": "b.isInteger(num)" |
| 8110 | + }, |
8046 | 8111 | {
|
8047 | 8112 | "name": "isString",
|
8048 | 8113 | "description": "Checks whether a var is a string, returns true if this is the case",
|
|
0 commit comments