vpype
1.9.0
Installation
Fundamentals
Cookbook
Plug-ins
Contributing
CLI reference
API reference
Change log
Licenses
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
layout command line option
text command line option
--amplitude
squiggles command line option
--area
random command line option
--attr
read command line option
--center
write command line option
--classic
show command line option
--clockwise
pagerotate command line option
--closed
filter command line option
--color-mode
write command line option
--colorful
show command line option
--config
vpype command line option
--count
multipass command line option
random command line option
--device
write command line option
--display-landscape
read command line option
--display-size
read command line option
--fit-dimensions
scaleto command line option
--fit-to-margins
layout command line option
--font
text command line option
--format
write command line option
--global
propclear command line option
propdel command line option
propget command line option
proplist command line option
propset command line option
--hide-legend
show command line option
--history
vpype command line option
--include
vpype command line option
--justify
text command line option
--keep
ldelete command line option
--landscape
layout command line option
pagesize command line option
write command line option
--layer
arc command line option
circle command line option
color 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
name command line option
penwidth command line option
propclear command line option
propdel command line option
propget command line option
proplist command line option
propset 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
write command line option
--max-length
filter command line option
--min-length
filter command line option
--no-crop
read command line option
--no-fail
read command line option
--no-flip
linemerge command line option
linesort command line option
--no-prop
lcopy command line option
lmove command line option
lswap command line option
--not-closed
filter command line option
--offset
frame command line option
grid command line option
--origin
rotate command line option
scale command line option
scaleto command line option
skew command line option
--outline
show command line option
--page-size
write command line option
--parallel
read command line option
--passes
linesort command line option
--pen-up
write command line option
--period
squiggles command line option
--position
text command line option
--prob
lcopy command line option
ldelete command line option
lmove command line option
lswap command line option
--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
rect command line option
--restore-attribs
write command line option
--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
text command line option
--tolerance
filter command line option
linemerge command line option
linesimplify command line option
reloop command line option
--two-opt
linesort command line option
--type
propset command line option
--unit
show command line option
--valign
layout command line option
--velocity
write command line option
--verbose
vpype command line option
--version
vpype command line option
--wrap
text command line option
-a
random command line option
read 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
-cw
pagerotate 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
propclear command line option
propdel command line option
propget command line option
proplist command line option
propset command line option
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
-k
ldelete command line option
-l
arc command line option
circle command line option
color 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
name command line option
pagesize command line option
penwidth command line option
propclear command line option
propdel command line option
propget command line option
proplist command line option
propset 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
lcopy command line option
lmove command line option
lswap 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
lswap 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
write 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
propset 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
_
_abc_impl (_DeferredEvaluator attribute)
_DeferredEvaluator (class in vpype_cli)
_find_nearest_in_index() (LineIndex method)
_find_nearest_within_in_index() (LineIndex method)
_get_projection() (Engine method)
_make_index() (LineIndex method)
_MetadataMixin (class in vpype)
_rebuild() (Engine method)
_reindex() (LineIndex method)
_update() (Engine method)
_update_layer_menu() (QtViewer method)
A
add() (Document method)
add_side_widget() (QtViewer method)
add_to_sources() (Document method)
aka_names (PaperConfig attribute)
ALL (LayerType attribute)
alpha (Color attribute)
ANGLE
rotate command line option
ANGLES
skew command line option
AngleType (class in vpype_cli)
append() (LineCollection method)
arc command line option
--layer
--quantization
-l
-q
RH
RW
START
STOP
X
Y
arc() (in module vpype)
as_floats() (Color method)
as_hex() (Color method)
as_mls() (LineCollection method)
as_vector() (in module vpype)
B
block_processor() (in module vpype_cli)
blue (Color attribute)
bounds() (Document method)
(LineCollection method)
C
circle command line option
--layer
--quantization
-l
-q
R
X
Y
circle() (in module vpype)
clear_layer_metadata() (Document method)
clear_metadata() (_MetadataMixin method)
clone() (Document method)
(LineCollection method)
COLOR
color command line option
Color (class in vpype)
color command line option
--layer
-l
COLOR
CONF
pens command line option
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
-l
HEIGHT
WIDTH
X
Y
crop() (Document method)
(in module vpype)
(LineCollection method)
crop_half_plane() (in module vpype)
current() (State method)
current_layer_id (State 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)
(State attribute)
DrawChildren (RenderFlag attribute)
DrawWindowBackground (RenderFlag attribute)
E
ellipse command line option
--layer
--quantization
-l
-q
H
W
X
Y
ellipse() (in module vpype)
empty_copy() (Document method)
Engine (class in vpype_viewer)
eval command line option
EXPR
evaluate() (_DeferredEvaluator method)
execute() (in module vpype_cli)
execute_processors() (in module vpype_cli)
exists() (Document method)
EXPR
eval command line option
expression_variables() (State method)
extend() (Document method)
(LineCollection method)
extend_page_size() (Document method)
F
FILE
read command line option
script command line option
FILES
forfile command line option
FileType (class in vpype_cli)
filter command line option
--closed
--layer
--max-length
--min-length
--not-closed
--tolerance
-c
-l
-m
-M
-o
-t
filter() (LineCollection method)
final_pu_params (PaperConfig attribute)
find_nearest() (LineIndex method)
find_nearest_within() (LineIndex method)
FIRST
lswap command line option
fit_page_size_to_content() (Document method)
fit_to_viewport() (Engine method)
forfile command line option
FILES
frame command line option
--layer
--offset
-l
-o
free_id() (Document method)
from_config() (PaperConfig class method)
(PlotterConfig class method)
G
generator() (in module vpype_cli)
get_command_config() (ConfigManager method)
get_current() (State class method)
get_plotter_config() (ConfigManager method)
get_plotter_list() (ConfigManager method)
global_processor() (in module vpype_cli)
green (Color attribute)
grid command line option
--offset
-o
NX
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)
IntegerType (class in vpype_cli)
interpolate() (in module vpype)
is_closed() (in module vpype)
is_empty() (Document method)
(LineCollection method)
L
layer_processor() (in module vpype_cli)
layer_visible() (Engine method)
LAYERS
ldelete command line option
lreverse command line option
layers (Document attribute)
layers_from_ids() (Document method)
LayerType (class in vpype_cli)
layout command line option
--align
--fit-to-margins
--landscape
--valign
-h
-l
-m
-v
SIZE
lcopy command line option
--no-prop
--prob
-m
-p
DEST
SOURCES
ldelete command line option
--keep
--prob
-k
-p
LAYERS
length() (Document method)
(LineCollection method)
LengthType (class in vpype_cli)
line command line option
--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
--no-flip
--tolerance
-f
-l
-t
lines (LineCollection attribute)
linesimplify command line option
--layer
--tolerance
-l
-t
linesort command line option
--layer
--no-flip
--passes
--two-opt
-f
-l
-p
-t
lmove command line option
--no-prop
--prob
-m
-p
DEST
SOURCES
load_config_file() (ConfigManager method)
lreverse command line option
LAYERS
lswap command line option
--no-prop
--prob
-m
-p
FIRST
SECOND
M
MARGIN_X
trim command line option
MARGIN_Y
trim command line option
merge() (LineCollection method)
metadata (_MetadataMixin attribute)
METRIC (UnitType attribute)
module
vpype
vpype_cli
vpype_viewer
multipass command line option
--count
--layer
-l
-n
multiple_to_layer_ids() (in module vpype_cli)
N
N
repeat command line option
NAME
name command line option
name (AngleType attribute)
(FileType attribute)
(IntegerType attribute)
(LayerType attribute)
(LengthType attribute)
(PageSizeType attribute)
(PaintDeviceMetric attribute)
(PaperConfig attribute)
(PathType attribute)
(PlotterConfig attribute)
(RenderFlag attribute)
(TextType attribute)
name command line option
--layer
-l
NAME
NEW (LayerType attribute)
NONE (ViewMode attribute)
NX
grid 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)
pagerotate command line option
--clockwise
-cw
pagesize command line option
--landscape
-l
SIZE
PageSizeType (class in vpype_cli)
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_cli)
PathType (class in vpype_cli)
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)
pens command line option
CONF
penwidth command line option
--layer
-l
WIDTH
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)
preprocess_argument() (State method)
preprocess_arguments() (State method)
PREVIEW (ViewMode attribute)
PROP
propdel command line option
propget command line option
propset command line option
propclear command line option
--global
--layer
-g
-l
propdel command line option
--global
--layer
-g
-l
PROP
property() (_MetadataMixin method)
property_exists() (_MetadataMixin method)
propget command line option
--global
--layer
-g
-l
PROP
proplist command line option
--global
--layer
-g
-l
propset command line option
--global
--layer
--type
-g
-l
-t
PROP
VALUE
Q
QtViewer (class in vpype_viewer)
R
R
circle command line option
random command line option
--area
--count
--layer
-a
-l
-n
read command line option
--attr
--display-landscape
--display-size
--layer
--no-crop
--no-fail
--parallel
--quantization
--simplify
--single-layer
-a
-c
-dl
-ds
-l
-m
-p
-q
-s
FILE
read_multilayer_svg() (in module vpype)
read_svg() (in module vpype)
read_svg_by_attributes() (in module vpype)
rect command line option
--layer
--quantization
--radii
-l
-q
-r
HEIGHT
WIDTH
X
Y
rect() (in module vpype)
red (Color attribute)
reloop command line option
--layer
--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
N
replace() (Document method)
resize() (Engine method)
reverse command line option
--layer
-l
reverse() (LineCollection method)
RH
arc command line option
rotate command line option
--layer
--origin
-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
--origin
-l
-o
SCALE
scale() (Document method)
(LineCollection method)
scale_spec (Engine attribute)
scaleto command line option
--fit-dimensions
--layer
--origin
-f
-l
-o
DIM
script command line option
--layer
-l
FILE
SECOND
lswap command line option
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_property() (_MetadataMixin 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
-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_cli)
SIZE
layout command line option
pagesize command line option
skew command line option
--layer
--origin
-l
-o
ANGLES
skew() (LineCollection method)
snap command line option
--layer
-l
PITCH
SOURCES
lcopy command line option
lmove command line option
sources (Document attribute)
splitall command line option
--layer
-l
squiggles command line option
--amplitude
--layer
--period
--quantization
-a
-l
-p
-q
squiggles() (in module vpype)
START
arc command line option
State (class in vpype_cli)
staticMetaObject (QtViewer attribute)
STOP
arc command line option
STRING
text command line option
substitute() (State method)
swap_content() (Document method)
T
target_layer_id (State attribute)
temp_document() (State method)
text command line option
--align
--font
--justify
--layer
--position
--size
--wrap
-a
-f
-j
-l
-p
-s
-w
STRING
text_block() (in module vpype)
text_line() (in module vpype)
TextType (class in vpype_cli)
toggle_layer_visibility() (Engine method)
translate command line option
--layer
-l
OFFSET
translate() (Document method)
(LineCollection method)
trim command line option
--layer
-l
MARGIN_X
MARGIN_Y
U
union() (in module vpype)
unit_type (Engine attribute)
UnitType (class in vpype_viewer)
V
VALUE
propset command line option
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
--history
--include
--seed
--verbose
--version
-c
-H
-I
-s
-v
vpype_cli
module
vpype_viewer
module
W
W
ellipse command line option
WIDTH
crop command line option
penwidth command line option
rect command line option
width (Engine attribute)
width() (LineCollection method)
write command line option
--absolute
--center
--color-mode
--device
--format
--landscape
--layer-label
--page-size
--pen-up
--quiet
--restore-attribs
--velocity
-a
-c
-d
-f
-l
-ll
-m
-p
-pu
-q
-r
-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)