18 changed files with 357 additions and 8 deletions
@ -0,0 +1,34 @@ |
|||||||
|
fill_color |
||||||
|
default: ``'#0000'`` (fully transparent) |
||||||
|
|
||||||
|
the color or gradient to fill with. See :doc:`/colors`. |
||||||
|
|
||||||
|
|
||||||
|
stroke_color |
||||||
|
default: ``:black`` |
||||||
|
|
||||||
|
the color with which to stroke the outside of the rectangle. See :docs:`/colors`. |
||||||
|
|
||||||
|
|
||||||
|
stroke_width |
||||||
|
default: ``2`` |
||||||
|
|
||||||
|
the width of the outside stroke. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
stroke_strategy |
||||||
|
default: ``:fill_first`` |
||||||
|
|
||||||
|
Specify whether the stroke is done before (thinner) or after (thicker) filling the shape. |
||||||
|
|
||||||
|
Must be either ``:fill_first`` or ``:stroke_first`` (or their string equivalents). |
||||||
|
|
||||||
|
dash |
||||||
|
default: ``''`` (no dash pattern set) |
||||||
|
|
||||||
|
Define a dash pattern for the stroke. This is a special string with space-separated numbers that define the pattern of on-and-off alternating strokes, measured in pixels or units. For example, ``'0.02in 0.02in'`` will be an equal on-and-off dash pattern. Supports :doc:`/units`. |
||||||
|
|
||||||
|
cap |
||||||
|
default: ``:butt`` |
||||||
|
|
||||||
|
Define how the end of the stroke is drawn. Options are ``:square``, ``:butt``, and ``:round`` (or string equivalents of those). |
||||||
@ -0,0 +1 @@ |
|||||||
|
All of these options support arrays and singleton expansion (except for **range**). See :doc:`/arrays` for deeper explanation. |
||||||
@ -0,0 +1,4 @@ |
|||||||
|
layout |
||||||
|
default: ``nil`` |
||||||
|
|
||||||
|
entry in the layout to use as defaults for this command. See :doc:`/layouts`. |
||||||
@ -0,0 +1,4 @@ |
|||||||
|
range |
||||||
|
default: ``:all`` |
||||||
|
|
||||||
|
the range of cards over which this will be rendered. See :ref:`using_ranges` |
||||||
@ -0,0 +1,10 @@ |
|||||||
|
width |
||||||
|
default: ``:deck`` (the width of the deck) |
||||||
|
|
||||||
|
the width of the box. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
height |
||||||
|
default: ``:deck`` (the height of the deck) |
||||||
|
|
||||||
|
the height of the box. Supports :doc:`/units`. |
||||||
@ -0,0 +1,10 @@ |
|||||||
|
x |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate to place, relative to the upper-left corner of the card and moving right as it increases. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
y |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the y-coordinate to place, relative to the upper-left corner of the card and moving downward as it increases. Supports :doc:`/units`. |
||||||
@ -1,2 +1,22 @@ |
|||||||
circle |
circle |
||||||
------ |
------ |
||||||
|
|
||||||
|
Draw a circle centered at the given coordinates |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
|
||||||
|
radius |
||||||
|
default: ``100`` |
||||||
|
|
||||||
|
radius of the circle. Supports :doc:`/units`. |
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,63 @@ |
|||||||
curve |
curve |
||||||
----- |
----- |
||||||
|
|
||||||
|
Draw a bezier curve using the given coordinates, from x1,y1 to x2,y2. The curvature is set by the control points cx1,cy2 and cx2,cy2. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
x1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate of the first endpoint. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
y1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the y-coordinate of the first endpoint. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
x2 |
||||||
|
default: ``5`` |
||||||
|
|
||||||
|
the x-coordinate of the second endpoint. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
y2 |
||||||
|
default: ``5`` |
||||||
|
|
||||||
|
the y-coordinate of the second endpoint. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
cx1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate of the first control point. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
cy1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the y-coordinate of the first control point. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
cx2 |
||||||
|
default: ``5`` |
||||||
|
|
||||||
|
the x-coordinate of the second control point. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
cy2 |
||||||
|
default: ``5`` |
||||||
|
|
||||||
|
the y-coordinate of the second control point. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,17 @@ |
|||||||
ellipse |
ellipse |
||||||
------- |
------- |
||||||
|
|
||||||
|
Draw an ellipse at the given coordinates. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
.. include:: /args/wh.rst |
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,31 @@ |
|||||||
grid |
grid |
||||||
---- |
---- |
||||||
|
|
||||||
|
Draw an unlimited square grid of lines on the deck, starting with x,y and extending off the end of the deck. |
||||||
|
|
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
|
||||||
|
|
||||||
|
width |
||||||
|
default: ``:deck`` (the width of the deck) |
||||||
|
|
||||||
|
the spacing between vertical gridlines. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
height |
||||||
|
default: ``:deck`` (the height of the deck) |
||||||
|
|
||||||
|
the spacing between horizontal gridlines. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,52 @@ |
|||||||
line |
line |
||||||
---- |
---- |
||||||
|
|
||||||
|
Draw a line from x1,y1 to x2,y2. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
x1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
y1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the y-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
x2 |
||||||
|
default: ``50`` |
||||||
|
|
||||||
|
the x-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
y2 |
||||||
|
default: ``50`` |
||||||
|
|
||||||
|
the y-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
x3 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
y3 |
||||||
|
default: ``50`` |
||||||
|
|
||||||
|
the y-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,28 @@ |
|||||||
polygon |
star |
||||||
------- |
---- |
||||||
|
|
||||||
|
Draw an n-sided regular polygon, centered at x,y. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
|
||||||
|
radius |
||||||
|
default: 0 |
||||||
|
|
||||||
|
the distance from the center of the star to the inner circle of its points. Supports :doc:`/units`. |
||||||
|
|
||||||
|
angle |
||||||
|
default: 0 |
||||||
|
|
||||||
|
the angle at which to rotate the star |
||||||
|
|
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,18 @@ |
|||||||
rect |
rect |
||||||
---- |
---- |
||||||
|
|
||||||
|
Draw a rounded rectangle |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
.. include:: /args/wh.rst |
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,35 @@ |
|||||||
star |
star |
||||||
---- |
---- |
||||||
|
|
||||||
|
Draw an n-pointed star, centered at x,y. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
.. include:: /args/xy.rst |
||||||
|
|
||||||
|
inner_radius |
||||||
|
default: 0 |
||||||
|
|
||||||
|
the distance from the center of the star to the inner circle of its points. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
outer_radius |
||||||
|
default: 0 |
||||||
|
|
||||||
|
the distance from the center of the star to the outer circle of its points. Supports :doc:`/units`. |
||||||
|
|
||||||
|
|
||||||
|
angle |
||||||
|
default: 0 |
||||||
|
|
||||||
|
the angle at which to rotate the star |
||||||
|
|
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
@ -1,2 +1,38 @@ |
|||||||
triangle |
triangle |
||||||
-------- |
-------- |
||||||
|
|
||||||
|
Draw a triangle at the given coordinates. |
||||||
|
|
||||||
|
Options |
||||||
|
^^^^^^^ |
||||||
|
.. include:: /args/expansion.rst |
||||||
|
|
||||||
|
x1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the x-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
y1 |
||||||
|
default: ``0`` |
||||||
|
|
||||||
|
the y-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
x2 |
||||||
|
default: ``50`` |
||||||
|
|
||||||
|
the x-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
|
||||||
|
y2 |
||||||
|
default: ``50`` |
||||||
|
|
||||||
|
the y-coordinate to place. Supports :doc:`/units/` |
||||||
|
|
||||||
|
.. include:: /args/draw.rst |
||||||
|
.. include:: /args/range.rst |
||||||
|
.. include:: /args/layout.rst |
||||||
|
|
||||||
|
Examples |
||||||
|
^^^^^^^^ |
||||||
|
|||||||
Loading…
Reference in new issue