Index: 09_appendix/action_details.html =================================================================== --- 09_appendix/action_details.html (revision 34223) +++ 09_appendix/action_details.html (revision 34224) @@ -176,6 +176,28 @@ For non-subcircuit objects: using Marks is not recommended, using Gridless is recommended. +
+
Syntax summary: | +AnyLoad([path]) + |
---|---|
Help text: | +Load "anything" from path (or offer a file selectio dialog if no path specified) + |
Registered by: | n/a + |
+Loads an anyload.lht file or any lihata document that can be handled by the anyload system (mostly settings and setting-like states, e.g. config, vendor drill map, DRC and user scripts). +
+ When called without arguments a file selection dialog is popped up for selecting the file to load. +
+ More info on this mechanism in the + + knowledge pool node of anyload. + + +
@@ -4051,6 +4073,10 @@
Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | dialogs plugin | @@ -24,6 +24,7 @@
AdjustStyle | Open the dialog box for editing the route styles. | AdjustStyle([routestyle_idx]) | lib_hid_pcbui/route_style |
align | Align objects | Align(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distalign plugin |
aligntext | Align objects | Align(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distalign plugin | +
AnyLoad | Load "anything" from path (or offer a file selectio dialog if no path specified) | AnyLoad([path]) | |
ApplyVendor | Applies the currently loaded vendor drill table to the current design. | ApplyVendor() | vendor drill mapping |
ArcNew | Create a pcb arc segment on a layer. For now data must be "pcb". Returns the idpath of the new object or 0 on error. | ArcNew([noundo,] data, layer, centx, centy, radiusx, radiusy, start_ang, delta_ang, thickness, clearance, flags) | act_draw |
asm | Interactive assembly assistant | asm() | asm plugin | @@ -113,6 +114,7 @@
DrcQueryImport | Import a rule and related definitions from a file. | DrcQueryImport([filename]) | drc_query |
DrcQueryListRules | List all drc rules implemented in drc_query | DrcQueryListRules() | drc_query |
DrcQueryRuleMod | Automated DRC rule editing (for scripting and import) | DrcQueryRuleMod(clear, source) DrcQueryRuleMod(create, rule_name) DrcQueryRuleMod(get, rule_name, field_name) DrcQueryRuleMod(set, rule_name, field_name, value) | drc_query | +
duktape | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
DumpActions | Dump all actions available. | DumpActions() | |
dumpconf | Perform various operations on the configuration tree. | dumpconf(native, [verbose], [prefix]) - dump the native (binary) config tree to stdout dumpconf(lihata, role, [prefix]) - dump in-memory lihata representation of a config tree | diag plugin |
DumpCsect | Print the cross-section of the board (layer stack) | DumpCsect() | draw_csect | @@ -170,7 +172,7 @@
GetXY | Get a coordinate. If x or y specified, the return value of the action is the x or y coordinate. | GetXY([message, [x|y]]) | |
GfxMod | Modify a gfx object: set transparent pixel on the pixmap or resize by measurement | GfxMod(transparent, [idpath, [#rrggbb]]) GfxMod(transparent, [idpath, [x, y]]) GfxMod(resize, [idpath, [pdx, pdy1, len]]) | |
GlobalPuller | Pull all traces tight. With no argument it runs on the current layer. | pcb_act_GlobalPuller([Found|Selected]) | puller plugin | -
Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) | + |
Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) grid(get) | |
GroupPropGui | Change group flags and properties | GroupPropGui(groupid) | dialogs plugin |
gui_FallbackColorPick | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | |
gui_fpmap_choose | Internal call action for a dialog to select a footprint from a map. | gui_fpmap_choose(map) | dialogs plugin | @@ -206,6 +208,7 @@
LayerObjDup | Duplicate srcobj on a layer. Srcobj is specified by an idpath. For now data must be "pcb". Returns the idpath of the new object or 0 on error. | LayerObjDup([noundo,] data, layer, srcobj) | act_draw |
LayerPropGui | Change layer flags and properties | LayerPropGui(layerid) | dialogs plugin |
LayerVisReset | Reset layer visibility to safe defaults. | LayerVisReset() | + |
LayerXform | Reset layer visibility to safe defaults. | LayerXform(layerid, toggle|set|clear, xformfield, [value]) | |
le | Loads an element (subcircuit, footprint) into the current buffer. | le [name] | shand_cmd plugin |
LibraryChanged | Tells the GUI that the libraries have changed. | LibraryChanged() | oldactions plugin |
LibraryDialog | Open the library dialog. | libraryDialog() | dialogs plugin | @@ -237,7 +240,7 @@
LoadTinycadFrom | Loads the specified tinycad .net file - the netlist must be tinycad netlist output. | LoadTinycadFrom(filename) | tinycad importer |
LoadTtf | Presents a GUI dialog for interactively loading glyphs from from a ttf file | LoadTtf() | ttf importer |
LoadTtfGlyphs | Loads glyphs from an outline ttf in the specified source range, optionally remapping them to dstchars range in the pcb-rnd font | LoadTtfGlyphs(filename, srcglyps, [dstchars], [outline|polygon], [scale], [offset]) | ttf importer | -
LoadVendorFrom | Loads the specified vendor lihata file. | LoadVendorFrom(filename) | vendor drill mapping | +
LoadVendorFrom | Loads the specified vendor lihata file. If second argument is "yes" or "pure", load in pure mode without side effects: do not reset or apply, only incrementally load. | LoadVendorFrom(filename, [yes|no]) | vendor drill mapping |
Log | Manages the central, in-memory log. | Log(clear, [fromID, [toID]) Log(export, [filename, [text|lihata]) | |
LogDialog | Open the log dialog. | LogDialog() | lib_hid_common plugin |
lua | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | @@ -289,8 +292,10 @@
pcb_atan2 | script plugin | ||
pcb_atan | script plugin | ||
pcb_cos | script plugin | +||
pcb_rand | script plugin | ||
pcb_sin | script plugin | ||
pcb_sqrt | script plugin | +||
pcb_srand | script plugin | ||
pcb_tan | script plugin | ||
perl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
perp | Draw a line perpendicular to another line | perp() | ddraft plugin | @@ -333,11 +338,12 @@
python | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
q! | Quits the application without confirming. | q! | shand_cmd plugin |
q | Quits the application after confirming. | q | shand_cmd plugin | -
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | query plugin | +
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout query(count, expr) - compile and evaluate an expression and return the number of matched objects (-1 on error) query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | query plugin |
QueryCalcNetLen | Calculates the network length by netname; returns an error message string or a positive coord with the length | QueryCalcNetLen(netname) | query plugin |
QueryCompileField | With "compile": precompiles textual field name to field ID; with "free": frees the memory allocated for a previously precompiled fieldID. | QueryCompileField(compile, fieldname) QueryCompileField(free, fieldID) | query plugin |
QueryObj | Return the value of a field of an object, addressed by the object's idpath and the field's name or precompiled ID. Returns NIL on error. | QueryObj(idpath, [.fieldname|fieldID]) | query plugin |
Quit | Quits the application after confirming. | Quit() | + |
ReadBoard | Length returns the number of groups on the current PCB. Field returns one of the fields of the group named in groupid. Layerid returns the integer layer ID (as interpreted within data) for the idxth layer of the group. | ReadBoard(width|size_x|height|size_y) | act_read |
ReadGroup | Length returns the number of groups on the current PCB. Field returns one of the fields of the group named in groupid. Layerid returns the integer layer ID (as interpreted within data) for the idxth layer of the group. | ReadGroup(length) ReadGroup(field, group, [init_invis|ltype|ltypestr|ltypehas|name|open|purpose|vis|length]) ReadGroup(layerid, group, idx) | act_read |
Redo | Redo recent "undo" operations. | redo() | |
Redraw | Redraw the entire screen | Redraw() | @@ -403,7 +409,8 @@ |
Tool | Change or use the tool mode. | Tool(Arc|Arrow|Copy|InsertPoint|Line|Lock|Move|None|PasteBuffer) Tool(Poly|Rectangle|Remove|Rotate|Text|Thermal|Via) Tool(Press|Release|Cancel|Stroke) Tool(Save|Restore) | |
ToPoly | convert a closed loop of lines and arcs into a polygon | ToPoly() ToPoly(outline) | lib_polyhelp |
trim | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin | -
Undo | Undo recent changes. | undo() undo(ClearList|FreezeSerial|UnfreezeSerial|IncSerial|GetSerial|Above) | + |
UILayer | Create or free UI layers. 'New' returns a layer ID that cna be used for addressing. | UILayer(new, name, color) UILayer(free, layer) | act_draw | +
Undo | Undo recent changes. | undo() undo(ClearList|FreezeSerial|UnfreezeSerial|FreezeAdd|UnfreezeAdd|IncSerial|GetSerial|Above) | |
UndoDialog | Open the undo dialog. | UndoDialog() | dialogs plugin |
UnloadScript | Unload a fungw script | UnloadScript(id) | script plugin |
UnloadVendor | Unloads the current vendor drill mapping table. | UnloadVendor() | vendor drill mapping |