vpype
1.8.0
Installation
Fundamentals
Cookbook
Plug-ins
Contributing
CLI reference
API reference
Change log
License
vpype
»
Index
Edit on GitHub
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
Symbols
--absolute
write command line option
--align <align>
layout command line option
text command line option
--amplitude <amplitude>
squiggles command line option
--area <area>
random command line option
--center
write command line option
--classic
show command line option
--closed
filter command line option
--color-mode <color_mode>
write command line option
--colorful
show command line option
--config <config>
vpype command line option
--count <count>
multipass command line option
--count <n>
random command line option
--device <device>
write command line option
--display-landscape
read command line option
--display-size <display_size>
read command line option
--fit-dimensions
scaleto command line option
--fit-to-margins <margin>
layout command line option
--font <font>
text command line option
--format <file_format>
write command line option
--hide-legend
show command line option
--history
vpype command line option
--include <include>
vpype command line option
--justify
text command line option
--landscape
layout command line option
pagesize command line option
write command line option
--layer <layer>
arc command line option
circle command line option
crop command line option
ellipse command line option
filter command line option
frame command line option
line command line option
linemerge command line option
linesimplify command line option
linesort command line option
multipass command line option
random command line option
read command line option
rect command line option
reloop command line option
reverse command line option
rotate command line option
scale command line option
scaleto command line option
script command line option
skew command line option
snap command line option
splitall command line option
squiggles command line option
text command line option
translate command line option
trim command line option
--layer-label <layer_label>
write command line option
--max-length <max_length>
filter command line option
--min-length <min_length>
filter command line option
--no-crop
read command line option
--no-flip
linemerge command line option
linesort command line option
--not-closed
filter command line option
--offset <offset>
frame command line option
grid command line option
--origin <origin_coords>
rotate command line option
scale command line option
scaleto command line option
skew command line option
--outline
show command line option
--page-size <page_size>
write command line option
--parallel
read command line option
--passes <passes>
linesort command line option
--pen-up
write command line option
--period <period>
squiggles command line option
--position <position>
text command line option
--prob <prob>
lcopy command line option
ldelete command line option
lmove command line option
--quantization <quantization>
arc command line option
circle command line option
ellipse command line option
read command line option
rect command line option
squiggles command line option
--quiet
write command line option
--radii <radii>
rect command line option
--seed <seed>
vpype command line option
--show-axes
show command line option
--show-grid
show command line option
--show-pen-up
show command line option
--show-points
show command line option
--simplify
read command line option
--single-layer
read command line option
--size <size>
text command line option
--tolerance <tolerance>
filter command line option
linemerge command line option
linesimplify command line option
reloop command line option
--two-opt
linesort command line option
--unit <unit>
show command line option
--valign <valign>
layout command line option
--velocity <velocity>
write command line option
--verbose
vpype command line option
--version
vpype command line option
--wrap <wrap>
text command line option
-a
random command line option
show command line option
squiggles command line option
text command line option
write command line option
-c
filter command line option
read command line option
show command line option
vpype command line option
write command line option
-d
show command line option
write command line option
-dl
read command line option
-ds
read command line option
-f
linemerge command line option
linesort command line option
scaleto command line option
text command line option
write command line option
-g
show command line option
-H
vpype command line option
-h
layout command line option
show command line option
-I
vpype command line option
-j
text command line option
-l
arc command line option
circle command line option
crop command line option
ellipse command line option
filter command line option
frame command line option
layout command line option
line command line option
linemerge command line option
linesimplify command line option
linesort command line option
multipass command line option
pagesize command line option
random command line option
read command line option
rect command line option
reloop command line option
reverse command line option
rotate command line option
scale command line option
scaleto command line option
script command line option
skew command line option
snap command line option
splitall command line option
squiggles command line option
text command line option
translate command line option
trim command line option
write command line option
-ll
write command line option
-M
filter command line option
-m
filter command line option
layout command line option
read command line option
write command line option
-n
multipass command line option
random command line option
-o
filter command line option
frame command line option
grid command line option
rotate command line option
scale command line option
scaleto command line option
show command line option
skew command line option
-p
lcopy command line option
ldelete command line option
linesort command line option
lmove command line option
read command line option
show command line option
squiggles command line option
text command line option
write command line option
-pu
write command line option
-q
arc command line option
circle command line option
ellipse command line option
read command line option
rect command line option
squiggles command line option
write command line option
-r
rect command line option
-s
read command line option
text command line option
vpype command line option
-t
filter command line option
linemerge command line option
linesimplify command line option
linesort command line option
reloop command line option
-u
show command line option
-v
layout command line option
vpype command line option
-vs
write command line option
-w
text command line option
_
__add__() (PaintDeviceMetric method)
__and__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__annotations__ (PaperConfig attribute)
(PlotterConfig attribute)
(VpypeState attribute)
__attrs_attrs__ (PaperConfig attribute)
(PlotterConfig attribute)
__bool__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__delattr__() (PaperConfig method)
(PlotterConfig method)
__eq__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__ge__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__getitem__() (Document method)
(LineCollection method)
(LineIndex method)
__gt__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__hash__ (RenderFlags attribute)
__hash__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
__index__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__init__() (ConfigManager method)
(Document method)
(Engine method)
(ImageRenderer method)
(LayerType method)
(LineCollection method)
(LineIndex method)
(PaperConfig method)
(PlotterConfig method)
(QtViewer method)
(VpypeState method)
__int__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__invert__() (RenderFlag method)
(RenderFlags method)
__iter__() (LineCollection method)
__le__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__len__() (LineCollection method)
(LineIndex method)
__lt__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__mul__() (PaintDeviceMetric method)
__ne__() (PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
(RenderFlags method)
__new__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__or__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__pos__() (PaintDeviceMetric method)
__radd__() (PaintDeviceMetric method)
__rand__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__reduce__() (PaintDeviceMetric method)
(RenderFlag method)
__repr__() (LineCollection method)
(PaintDeviceMetric method)
(PaperConfig method)
(PlotterConfig method)
(RenderFlag method)
__rmul__() (PaintDeviceMetric method)
__ror__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__rsub__() (PaintDeviceMetric method)
__rxor__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
__setattr__() (PaperConfig method)
(PlotterConfig method)
__setitem__() (Document method)
__str__() (PaintDeviceMetric method)
(RenderFlag method)
__sub__() (PaintDeviceMetric method)
__xor__() (PaintDeviceMetric method)
(RenderFlag method)
(RenderFlags method)
_find_nearest_in_index() (LineIndex method)
_find_nearest_within_in_index() (LineIndex method)
_get_projection() (Engine method)
_get_version() (in module vpype)
_make_index() (LineIndex method)
_rebuild() (Engine method)
_reindex() (LineIndex method)
_update() (Engine method)
_update_layer_menu() (QtViewer method)
A
add() (Document method)
add_side_widget() (QtViewer method)
aka_names (PaperConfig attribute)
ALL (LayerType attribute)
ANGLE
rotate command line option
ANGLES
skew command line option
AngleType (class in vpype)
append() (LineCollection method)
arc command line option
--layer <layer>
--quantization <quantization>
-l
-q
RH
RW
START
STOP
X
Y
arc() (in module vpype)
as_mls() (LineCollection method)
as_vector() (in module vpype)
B
block_processor() (in module vpype)
bounds() (Document method)
(LineCollection method)
C
circle command line option
--layer <layer>
--quantization <quantization>
-l
-q
R
X
Y
circle() (in module vpype)
config (ConfigManager attribute)
ConfigManager (class in vpype)
convert_angle() (in module vpype)
convert_length() (in module vpype)
convert_page_size() (in module vpype)
count() (Document method)
crop command line option
--layer <layer>
-l
HEIGHT
WIDTH
X
Y
crop() (Document method)
(in module vpype)
(LineCollection method)
crop_half_plane() (in module vpype)
current() (VpypeState method)
current_state (VpypeState attribute)
D
debug (Engine attribute)
DEST
lcopy command line option
lmove command line option
DIM
scaleto command line option
Document (class in vpype)
document (Engine attribute)
DrawChildren (RenderFlag attribute)
DrawWindowBackground (RenderFlag attribute)
E
ellipse command line option
--layer <layer>
--quantization <quantization>
-l
-q
H
W
X
Y
ellipse() (in module vpype)
empty_copy() (Document method)
Engine (class in vpype_viewer)
execute() (in module vpype_cli)
exists() (Document method)
extend() (Document method)
(LineCollection method)
extend_page_size() (Document method)
F
FILE
read command line option
script command line option
filter command line option
--closed
--layer <layer>
--max-length <max_length>
--min-length <min_length>
--not-closed
--tolerance <tolerance>
-c
-l
-m
-M
-o
-t
filter() (LineCollection method)
final_pu_params (PaperConfig attribute)
find_nearest() (LineIndex method)
find_nearest_within() (LineIndex method)
fit_page_size_to_content() (Document method)
fit_to_viewport() (Engine method)
frame command line option
--layer <layer>
--offset <offset>
-l
-o
free_id() (Document method)
from_config() (PaperConfig class method)
(PlotterConfig class method)
G
generator() (in module vpype)
get_command_config() (ConfigManager method)
get_current() (VpypeState class method)
get_plotter_config() (ConfigManager method)
get_plotter_list() (ConfigManager method)
global_processor() (in module vpype)
grid command line option
--offset <offset>
-o
NUMBER
H
H
ellipse command line option
HEIGHT
crop command line option
rect command line option
height (Engine attribute)
height() (LineCollection method)
I
ids() (Document method)
IgnoreMask (RenderFlag attribute)
ImageRenderer (class in vpype_viewer)
IMPERIAL (UnitType attribute)
info (PaperConfig attribute)
(PlotterConfig attribute)
interpolate() (in module vpype)
is_closed() (in module vpype)
is_empty() (Document method)
(LineCollection method)
L
layer_processor() (in module vpype)
layer_visible() (Engine method)
LAYERS
ldelete command line option
layers (Document attribute)
layers_from_ids() (Document method)
LayerType (class in vpype)
layout command line option
--align <align>
--fit-to-margins <margin>
--landscape
--valign <valign>
-h
-l
-m
-v
SIZE
lcopy command line option
--prob <prob>
-p
DEST
SOURCES
ldelete command line option
--prob <prob>
-p
LAYERS
length() (Document method)
(LineCollection method)
LengthType (class in vpype)
line command line option
--layer <layer>
-l
X0
X1
Y0
Y1
line() (in module vpype)
line_length() (in module vpype)
LineCollection (class in vpype)
LineIndex (class in vpype)
linemerge command line option
--layer <layer>
--no-flip
--tolerance <tolerance>
-f
-l
-t
lines (LineCollection attribute)
linesimplify command line option
--layer <layer>
--tolerance <tolerance>
-l
-t
linesort command line option
--layer <layer>
--no-flip
--passes <passes>
--two-opt
-f
-l
-p
-t
lmove command line option
--prob <prob>
-p
DEST
SOURCES
load_config_file() (ConfigManager method)
M
MARGIN_X
trim command line option
MARGIN_Y
trim command line option
merge() (LineCollection method)
METRIC (UnitType attribute)
module
vpype
vpype_cli
vpype_viewer
multipass command line option
--count <count>
--layer <layer>
-l
-n
multiple_to_layer_ids() (in module vpype)
N
name (AngleType attribute)
(LayerType attribute)
(LengthType attribute)
(PageSizeType attribute)
(PaintDeviceMetric attribute)
(PaperConfig attribute)
(PlotterConfig attribute)
(RenderFlag attribute)
NEW (LayerType attribute)
NONE (ViewMode attribute)
NUMBER
grid command line option
repeat command line option
O
OFFSET
translate command line option
origin (Engine attribute)
origin_location (PaperConfig attribute)
origin_location_reference (PaperConfig attribute)
OUTLINE (ViewMode attribute)
OUTLINE_COLORFUL (ViewMode attribute)
OUTPUT
write command line option
P
page_size (Document attribute)
pagesize command line option
--landscape
-l
SIZE
PageSizeType (class in vpype)
PaintDeviceMetric (class in vpype_viewer.QtViewer)
pan() (Engine method)
paper_config() (PlotterConfig method)
paper_config_from_size() (PlotterConfig method)
paper_configs (PlotterConfig attribute)
paper_orientation (PaperConfig attribute)
paper_size (PaperConfig attribute)
PaperConfig (class in vpype)
pass_state() (in module vpype)
PdmDepth (PaintDeviceMetric attribute)
PdmDevicePixelRatio (PaintDeviceMetric attribute)
PdmDevicePixelRatioScaled (PaintDeviceMetric attribute)
PdmDpiX (PaintDeviceMetric attribute)
PdmDpiY (PaintDeviceMetric attribute)
PdmHeight (PaintDeviceMetric attribute)
PdmHeightMM (PaintDeviceMetric attribute)
PdmNumColors (PaintDeviceMetric attribute)
PdmPhysicalDpiX (PaintDeviceMetric attribute)
PdmPhysicalDpiY (PaintDeviceMetric attribute)
PdmWidth (PaintDeviceMetric attribute)
PdmWidthMM (PaintDeviceMetric attribute)
pen_count (PlotterConfig attribute)
pen_opacity (Engine attribute)
pen_up_length() (Document method)
(LineCollection method)
pen_up_trajectories() (LineCollection method)
pen_width (Engine attribute)
PITCH
snap command line option
pixel_factor (Engine attribute)
PIXELS (UnitType attribute)
plotter_unit_length (PlotterConfig attribute)
PlotterConfig (class in vpype)
pop() (Document method)
(LineIndex method)
pop_front() (LineIndex method)
post_init() (Engine method)
PREVIEW (ViewMode attribute)
Q
QtViewer (class in vpype_viewer)
R
R
circle command line option
random command line option
--area <area>
--count <n>
--layer <layer>
-a
-l
-n
read command line option
--display-landscape
--display-size <display_size>
--layer <layer>
--no-crop
--parallel
--quantization <quantization>
--simplify
--single-layer
-c
-dl
-ds
-l
-m
-p
-q
-s
FILE
read_multilayer_svg() (in module vpype)
read_svg() (in module vpype)
rect command line option
--layer <layer>
--quantization <quantization>
--radii <radii>
-l
-q
-r
HEIGHT
WIDTH
X
Y
rect() (in module vpype)
reloop command line option
--layer <layer>
--tolerance <tolerance>
-l
-t
reloop() (in module vpype)
(LineCollection method)
render() (Engine method)
(ImageRenderer method)
render_image() (in module vpype_viewer)
RenderFlag (class in vpype_viewer.QtViewer)
RenderFlags (class in vpype_viewer.QtViewer)
repeat command line option
NUMBER
resize() (Engine method)
reverse command line option
--layer <layer>
-l
reverse() (LineCollection method)
RH
arc command line option
rotate command line option
--layer <layer>
--origin <origin_coords>
-l
-o
ANGLE
rotate() (Document method)
(LineCollection method)
rotate_180 (PaperConfig attribute)
RW
arc command line option
S
SCALE
scale command line option
scale (Engine attribute)
scale command line option
--layer <layer>
--origin <origin_coords>
-l
-o
SCALE
scale() (Document method)
(LineCollection method)
scale_spec (Engine attribute)
scaleto command line option
--fit-dimensions
--layer <layer>
--origin <origin_coords>
-f
-l
-o
DIM
script command line option
--layer <layer>
-l
FILE
segment_count() (Document method)
(LineCollection method)
set_debug() (QtViewer method)
set_document() (QtViewer method)
set_mouse_coords() (QtViewer method)
set_pen_opacity() (QtViewer method)
set_pen_width_mm() (QtViewer method)
set_ps (PaperConfig attribute)
set_show_pen_up() (QtViewer method)
set_show_points() (QtViewer method)
set_show_rulers() (QtViewer method)
set_unit_type() (QtViewer method)
set_view_mode() (QtViewer method)
show command line option
--classic
--colorful
--hide-legend
--outline
--show-axes
--show-grid
--show-pen-up
--show-points
--unit <unit>
-a
-c
-d
-g
-h
-o
-p
-u
show() (in module vpype_viewer)
show_pen_up (Engine attribute)
show_points (Engine attribute)
show_rulers (Engine attribute)
single_to_layer_id() (in module vpype)
SIZE
layout command line option
pagesize command line option
skew command line option
--layer <layer>
--origin <origin_coords>
-l
-o
ANGLES
skew() (LineCollection method)
snap command line option
--layer <layer>
-l
PITCH
SOURCES
lcopy command line option
lmove command line option
splitall command line option
--layer <layer>
-l
squiggles command line option
--amplitude <amplitude>
--layer <layer>
--period <period>
--quantization <quantization>
-a
-l
-p
-q
squiggles() (in module vpype)
START
arc command line option
staticMetaObject (QtViewer attribute)
STOP
arc command line option
STRING
text command line option
T
text command line option
--align <align>
--font <font>
--justify
--layer <layer>
--position <position>
--size <size>
--wrap <wrap>
-a
-f
-j
-l
-p
-s
-w
STRING
text_block() (in module vpype)
text_line() (in module vpype)
toggle_layer_visibility() (Engine method)
translate command line option
--layer <layer>
-l
OFFSET
translate() (Document method)
(LineCollection method)
trim command line option
--layer <layer>
-l
MARGIN_X
MARGIN_Y
U
union() (in module vpype)
unit_type (Engine attribute)
UnitType (class in vpype_viewer)
V
values (PaintDeviceMetric attribute)
(RenderFlag attribute)
view_mode (Engine attribute)
ViewMode (class in vpype_viewer)
viewport_to_model() (Engine method)
vpype
module
vpype command line option
--config <config>
--history
--include <include>
--seed <seed>
--verbose
--version
-c
-H
-I
-s
-v
vpype_cli
module
vpype_viewer
module
VpypeState (class in vpype)
W
W
ellipse command line option
WIDTH
crop command line option
rect command line option
width (Engine attribute)
width() (LineCollection method)
write command line option
--absolute
--center
--color-mode <color_mode>
--device <device>
--format <file_format>
--landscape
--layer-label <layer_label>
--page-size <page_size>
--pen-up
--quiet
--velocity <velocity>
-a
-c
-d
-f
-l
-ll
-m
-p
-pu
-q
-vs
OUTPUT
write_hpgl() (in module vpype)
write_svg() (in module vpype)
X
X
arc command line option
circle command line option
crop command line option
ellipse command line option
rect command line option
X0
line command line option
X1
line command line option
x_range (PaperConfig attribute)
Y
Y
arc command line option
circle command line option
crop command line option
ellipse command line option
rect command line option
Y0
line command line option
Y1
line command line option
y_axis_up (PaperConfig attribute)
y_range (PaperConfig attribute)
Z
zoom() (Engine method)
Read the Docs
v: 1.8.0
Versions
latest
stable
1.8.0
1.7.0
1.6.0
1.5.1
1.5.0
1.4.0
1.3.0
1.2.1
1.2.0
1.1.0
1.0.0
Downloads
On Read the Docs
Project Home
Builds