Std New: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Docnav |Std File New aspect |Std File New table |Std File Menu |IconL=Std_File_New_aspect.svg |IconR=Std_File_New_table.svg |IconC=Labrps.svg }} {{GuiCommand |Name=Std New |MenuLocation=File → New → New Project |Phenomena=All |Shortcut={{KEY|Ctrl}}+{{KEY|N}} |Version=0.001 |SeeAlso=Std File New aspect, Std File New table }} ==Description== The '''Std F...") |
No edit summary |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Docnav | {{Docnav | ||
| | | | ||
|[[ | |[[Std_New_Table|Std New table]] | ||
|[[Std_File_Menu|Std File Menu]] | |[[Std_File_Menu|Std File Menu]] | ||
|IconL= | |IconL= | ||
|IconR= | |IconR=Std_New_Table.svg | ||
|IconC=Labrps.svg | |IconC=Labrps.svg | ||
}} | }} | ||
Line 10: | Line 10: | ||
{{GuiCommand | {{GuiCommand | ||
|Name=Std New | |Name=Std New | ||
|MenuLocation=File → New | |MenuLocation=File → New | ||
|Phenomena=All | |Phenomena=All | ||
|Shortcut={{KEY|Ctrl}}+{{KEY|N}} | |Shortcut={{KEY|Ctrl}}+{{KEY|N}} | ||
|Version=0. | |Version=0.1 | ||
|SeeAlso=[[ | |SeeAlso=[[Std_New_Table|Std New table]] | ||
}} | }} | ||
==Description== | ==Description== | ||
The '''Std | The '''Std New''' command creates a new empty document and makes it the active document. | ||
==Usage== | ==Usage== | ||
There are several ways to invoke the command: | There are several ways to invoke the command: | ||
#* Press the | #* Press the {{Button|[[Image:Std_New.svg|16px]] [[Std_New|New]]}} button. | ||
#* Select the {{MenuCommand|File → [[Image: | #* Select the {{MenuCommand|File → [[Image:Std_New.svg|16px]] New}} option from the menu. | ||
#* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}. | #* Use the keyboard shortcut: {{KEY|Ctrl}}+{{KEY|N}}. | ||
== | ==Preferences== | ||
See also: [[Preferences_Editor|Preferences Editor]]. | |||
The | * By default LabRPS start without a new document. Check the {{MenuCommand|Edit → Preferences... → General → Document → Create new document at start up}} option to change this behavior. | ||
* Some document properties: author name, company name and license information, can be preset: {{MenuCommand|Edit → Preferences... → General → Document → Authoring and License}}. | |||
==Properties== | |||
See also: [[Property_editor|Property editor]]. | |||
Most properties can also be changed in the dialog box of the [[Std_ProjectInfo|Std ProjectInfo]] command. | |||
===Data=== | |||
{{TitleProperty|Base}} | |||
* {{PropertyData|Comment|String}}: Any comment that may apply. | |||
* {{PropertyData|Company|String}}: Company name. | |||
* {{PropertyData|Created By|String}}: Author name. | |||
* {{PropertyData|Creation Date|String}}: Automatic date stamp (read-only). | |||
* {{PropertyData|File Name|String}}: The full path of the file. Blank if the document has not been saved (read-only). | |||
* {{PropertyData|Id|String}}: Not implemented yet. | |||
* {{PropertyData|Label|String}}: The name that will appear in the [[Tree_view|Tree view]]. Replaced by the name of the document after reopening. | |||
* {{PropertyData|Last Modified By|String}}: Author name. | |||
* {{PropertyData|Last Modified Date|String}}: Automatic date stamp (read-only). | |||
* {{PropertyData|License|String}}: License type. | |||
* {{PropertyData|License URL|String}}: License URL. | |||
* {{PropertyData|Material|Map|Hidden}}: Map with material properties. | |||
* {{PropertyData|Meta|Map|Hidden}}: Map with additional meta information. | |||
* {{PropertyData|Show Hidden|Bool}}: If true, items that have been hidden in the [[Tree_view|Tree view]] will be displayed anyway. Hiding items in the tree can be useful when working on larger models. | |||
* {{PropertyData|Tip|Link}}: Not implemented yet. | |||
* {{PropertyData|Tip Name|String}}: Not implemented yet. | |||
* {{PropertyData|Transient Dir|String}}: The transient directory used for recovery data (read-only). | |||
* {{PropertyData|Uid|UUID|Hidden}}: UUID of the document (read-only). | |||
==Scripting== | |||
See also: [https://labrps.github.io/SourceDoc/ Autogenerated API documentation] and [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]]. | |||
To create a new document use the {{incode|newDocument([name], [hidden<nowiki>=</nowiki>False])}} method of the LabRPS application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If {{incode|hidden<nowiki>=</nowiki>True}} is used, the new document won't be displayed in the GUI and no tab will appear for it. | |||
{{Code|code= | |||
import LabRPS | |||
from pathlib import Path | |||
# The folder and filename we will use: | |||
fld = 'D:/testfiles/' | |||
fnm = fld + 'test.RPSStd' | |||
# Make sure fld exists: | |||
Path(fld).mkdir(parents=True, exist_ok=True) | |||
doc = LabRPS.newDocument() | |||
doc.saveAs(fnm) | |||
LabRPS.closeDocument(doc.Name) | |||
doc = LabRPS.open(fnm) | |||
doc.save() | |||
LabRPS.closeDocument(doc.Name) | |||
}} | |||
{{Docnav | {{Docnav | ||
| | | | ||
|[[ | |[[Std_New_Table|Std New table]] | ||
|[[Std_File_Menu|Std File Menu]] | |[[Std_File_Menu|Std File Menu]] | ||
|IconL= | |IconL= | ||
|IconR= | |IconR=Std_New_Table.svg | ||
|IconC=Labrps.svg | |IconC=Labrps.svg | ||
}} | }} | ||
{{ | {{Std_Base_navi}} | ||
{{Userdocnavi}} | {{Userdocnavi}} | ||
Latest revision as of 03:30, 26 October 2024
Std New |
Menu location |
---|
File → New |
Phenomena |
All |
Default shortcut |
Ctrl+N |
Introduced in version |
0.1 |
See also |
Std New table |
Description
The Std New command creates a new empty document and makes it the active document.
Usage
There are several ways to invoke the command:
- Press the New button.
- Select the File → New option from the menu.
- Use the keyboard shortcut: Ctrl+N.
Preferences
See also: Preferences Editor.
- By default LabRPS start without a new document. Check the Edit → Preferences... → General → Document → Create new document at start up option to change this behavior.
- Some document properties: author name, company name and license information, can be preset: Edit → Preferences... → General → Document → Authoring and License.
Properties
See also: Property editor.
Most properties can also be changed in the dialog box of the Std ProjectInfo command.
Data
Base
- DataComment (
String
): Any comment that may apply. - DataCompany (
String
): Company name. - DataCreated By (
String
): Author name. - DataCreation Date (
String
): Automatic date stamp (read-only). - DataFile Name (
String
): The full path of the file. Blank if the document has not been saved (read-only). - DataId (
String
): Not implemented yet. - DataLabel (
String
): The name that will appear in the Tree view. Replaced by the name of the document after reopening. - DataLast Modified By (
String
): Author name. - DataLast Modified Date (
String
): Automatic date stamp (read-only). - DataLicense (
String
): License type. - DataLicense URL (
String
): License URL. - Data (Hidden)Material (
Map
): Map with material properties. - Data (Hidden)Meta (
Map
): Map with additional meta information. - DataShow Hidden (
Bool
): If true, items that have been hidden in the Tree view will be displayed anyway. Hiding items in the tree can be useful when working on larger models. - DataTip (
Link
): Not implemented yet. - DataTip Name (
String
): Not implemented yet. - DataTransient Dir (
String
): The transient directory used for recovery data (read-only). - Data (Hidden)Uid (
UUID
): UUID of the document (read-only).
Scripting
See also: Autogenerated API documentation and LabRPS Scripting Basics.
To create a new document use the newDocument([name], [hidden=False])
method of the LabRPS application. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled". If hidden=True
is used, the new document won't be displayed in the GUI and no tab will appear for it.
import LabRPS from pathlib import Path # The folder and filename we will use: fld = 'D:/testfiles/' fnm = fld + 'test.RPSStd' # Make sure fld exists: Path(fld).mkdir(parents=True, exist_ok=True) doc = LabRPS.newDocument() doc.saveAs(fnm) LabRPS.closeDocument(doc.Name) doc = LabRPS.open(fnm) doc.save() LabRPS.closeDocument(doc.Name)
Std Base
- File: New document, New Table, New Matrix, New Graph, New 2D Plot, New 3D Plot, Open..., Open Recent, Close, Close All, Save, Save As..., Save a Copy..., Save All, Revert, Import..., Export..., Merge project..., Document information..., Print..., Print preview..., Export PDF...Exit
- Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Select All, Delete, Preferences...
- View: Fullscreen, Workbench, Sync view, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection back, Selection forward, Status bar
- Tools: Edit parameters..., Export dependency graph..., Project utility..., Alphaplot, Line, Scatter, Scatter, Scatter With X Err, Scatter With Y Err, Scatter With XY Err, Line + Symbol, Special Line + Symbol, Vertical Drop Lines, Spline, Vertical Steps, Horizontal Steps, Vertical Bars, Vertical Stacked Bars, Vertical Grouped Bars ,Horizontal Bars, Horizontal Stacked Bars, Horizontal Grouped Bars, Area, Channel Fil, Pie, Half Pie, Vectors XYXY, Vectors XYAM, Statistical Graph, Box Plot, Histogram, Stacked Histogram, 3D Plot, Bar, Scatter, Layout Grids, Vertical 2 Layouts, Horizontal 2 Layouts, 4(2x2) Layouts, 3D Wire Frame, 3D Surface, 3D Wire Frame Surface, Bar, Scatter, Contour + Color Fill, Countour Lines, Gray Scale Map, 3D Wire Frame Polar, 3D Surface Polar, 3D Wire Frame Surface Polar, 3D Scatter Polar, Polar spectrogram, Graph, Add/Remove Plot xy/xy..., Add Function..., Add Error Bars..., Add/Remove Other Plots..., Add/Remove Plot y..., Add/Remove Vector Plot..., Add Axis..., Add Left Axis, Add Bottom Axis, Add Right Axis, Add Top Axis, Legend Reorder, Add Text, Add Time Stamp, Add Image, Draw Line, Draw Arrow, Draw Ellipse, Add Nested Layout, Add Layout, Add Up, Add Down, Add Left, Add Right, Remove Layout, Swap Layouts..., Graph Tolls, Disable Tools, Data Rearder, Screen Reader, Select Data Range, Move Data Points, Remove Bad Data Points..., Drag Range, Zoom Range, Rescale To Show All, Table, Set Column(s) As, X, Y, Z, X Error, Y Error, None, Fill Selection With, Row Numbers, , Random Values, Custom Random, Show Comments, Show Controls, Formula Edit Mode, Edit Column Description, Change Type & Format, Clear Table, Sort Table, Assign Formula, Recalculate, Add Column, Go To Cell, Export ASCII..., Convert To Matrix, Matrix, Hide Controls, Set Coordinates, Set Display Format, Assign Formula, Recalculate, Clear Matrix, Transpose, Mirror Horizontally, Mirror Vertically, Import Image, Go To Cell, Invert, Determinant, Convert To Table, Add text document, Group, Units Calculator,Customize..., RPS Features..., Addon manager
- Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint
- Help: Help, LabRPS Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, LabRPS Forum, LabRPS FAQ, Report a bug, About LabRPS, What's This
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, AppImage
- Basics: About LabRPS, Interface, RPS Objects, Object name, Preferences, Workbenches, Document structure, Properties, Help LabRPS, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, WindLab, SeismicLab, SeaLab, UserLab, Spreadsheet, Plot, Web
- Hubs: User hub, Power users hub, Developer hub