Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,15 @@ const eBox = footage('eBox.jsx').sourceData;
const myBox = eBox.createBox({
size: [800, 200],
position: [960, 540],
rounding: [12, 12, 12, 12],
anchor: 'center',
});

// Scale the box in from the left
myBox.setScale([scaleIn, 100], 'topLeft');
myBox.setScale([scaleIn, 100], 'centerLeft');

// Scale the box off from the right
myBox.setScale([scaleOut, 100], 'bottomRight');
myBox.setScale([scaleOut, 100], 'centerRight');

// Return the box path
myBox.getPath();
Expand Down Expand Up @@ -107,12 +108,15 @@ myBox.getPath();
- Required: `true`
- **`anchor`:** The anchor point that will be at the given `position`
- Type: `string`
- Options: `topLeft, topRight, bottomLeft, bottomRight, center`
- Options: `topLeft, topCenter, topRight, bottomLeft, bottomCenter, bottomRight, centerLeft, center, centerRight`
- Required: `true`
- **`isClosed`:** Whether the path is closed
- Type: `boolean`
- Required: `false`
- Default: `true`
- **`rounding`:** Radius for each corner
- Type: `array`
- Required : `false`
</details>
<br>

Expand All @@ -135,7 +139,7 @@ myBox.getPath();
- Required: `true`
- **`anchor`:** The anchor point that will be at the given `position`
- Type: `string`
- Options: `topLeft, topRight, bottomLeft, bottomRight, center`
- Options: `topLeft, topCenter, topRight, bottomLeft, bottomCenter, bottomRight, centerLeft, center, centerRight`
- Required: `true`
</details>
<br>
Expand Down
Loading