Draft AnnotationStyleEditor: Difference between revisions

From FreeCAD Documentation
(Added 'In progress')
No edit summary
Line 8: Line 8:
|[[Draft_Move|Move]]
|[[Draft_Move|Move]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft Label.svg
|IconL=Draft_Label.svg
|IconR=Draft_Move.svg
|IconR=Draft_Move.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg
Line 16: Line 16:
{{GuiCommand
{{GuiCommand
|Name=Draft AnnotationStyleEditor
|Name=Draft AnnotationStyleEditor
|MenuLocation=Annotation → Annotation styles
|MenuLocation=Annotation → Annotation styles...
|Workbenches=[[Draft Module|Draft]]
|Workbenches=[[Draft Module|Draft]]
|SeeAlso=[[Draft_Text|Draft Text]], [[Draft_Label|Draft Label]], [[Draft_Dimension|Draft Dimension]]
|Shortcut=-
|SeeAlso=[[Draft_Text|Draft Text]], [[Draft_Dimension|Draft Dimension]], [[Draft_Label|Draft Label]]
|Version=0.19
|Version=0.19
}}
}}
Line 26: Line 25:


<!--T:3-->
<!--T:3-->
The {{Button|[[Image:Draft_AnnotationStyleEditor.svg|16px]] [[Draft_AnnotationStyleEditor|Annotation style editor]]}} tool allows you to define styles that affect the visual properties of annotation-like objects, like those create by {{Button|[[File:Draft_Text.svg|16px]] [[Draft_Text|Text]]}}, {{Button|[[File:Draft_Dimension.svg|16px]] [[Draft_Dimension|Dimension]]}}, and {{Button|[[File:Draft_Label.svg|16px]] [[Draft Label|Label]]}}.
The [[Image:Draft_AnnotationStyleEditor.svg|24px]] [[Draft_AnnotationStyleEditor|Draft_AnnotationStyleEditor]] command allows you to define styles that affect the visual properties of annotation-like objects, such as those create by the [[Draft_Text|Draft Text]], [[Draft_Dimension|Draft Dimension]], and [[Draft_Label|Draft Label]] commands.


</translate>
<!--T:4-->
[[File:Draft_AnnotationStyleEditor_example.png|400px]]
[[File:Draft_AnnotationStyleEditor_example.png|400px]]
<translate>
<!--T:4-->
{{Caption|Style editor to configure the annotations.}}
{{Caption|Style editor to configure the annotations.}}


Line 35: Line 36:


<!--T:6-->
<!--T:6-->
# There are several ways to invoke the command:
# Press {{Button|[[Image:Draft_AnnotationStyleEditor.svg|16px]] [[Draft_AnnotationStyleEditor|Draft Annotation style editor]]}} button.
#* Press the {{Button|[[Image:Draft_AnnotationStyleEditor.svg|16px]] [[Draft_AnnotationStyleEditor|Draft AnnotationStyleEditor]]}} button.
# Open the combobox, and then choose {{Button|Add new...}} to define a new style, or select one of the existing styles.
#* Select the {{MenuCommand|Annotation → [[Image:Draft_AnnotationStyleEditor.svg|16px]] Annotation styles...}} option from the menu.
# Adjust the properties of the style, and then press {{Button|OK}} when satisfied.
# The {{MenuCommand|Annotation Styles Editor}} dialog box opens.

# Select a style from the {{MenuCommand|Style name}} dropdown list, or choose {{Value|Add new...}} to define a new style.
<!--T:7-->
# Optionally adjust the properties of the style.
Use the {{Button|[[File:Accessories-text-editor.svg|16px]] Rename}} or {{Button|[[File:Edit_Cancel.svg|16px]] Delete}} to rename or delete the active style.
# Optionally press the {{Button|[[File:Accessories-text-editor.svg|16px]] Rename}} button to rename the style.
# Optionally press the {{Button|[[File:Edit_Cancel.svg|16px]] Delete}} button to delete the style.
# Optionally press the {{Button|[[File:Std_Import.svg|16px]]}} button to import all styles from a {{FileName|.json}} file. This will overwrite existing styles with the same name.
# Optionally press the {{Button|[[File:Std_Export.svg|16px]]}} button to export all styles to a {{FileName|.json}} file.
# Press the {{Button|OK}} button to close the dialog box and finish the command.


== Scripting == <!--T:8-->
== Scripting == <!--T:8-->
Line 134: Line 140:
|[[Draft_Move|Move]]
|[[Draft_Move|Move]]
|[[Draft_Module|Draft]]
|[[Draft_Module|Draft]]
|IconL=Draft Label.svg
|IconL=Draft_Label.svg
|IconR=Draft_Move.svg
|IconR=Draft_Move.svg
|IconC=Workbench_Draft.svg
|IconC=Workbench_Draft.svg

Revision as of 21:30, 17 March 2021

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Draft AnnotationStyleEditor

Menu location
Annotation → Annotation styles...
Workbenches
Draft
Default shortcut
None
Introduced in version
0.19
See also
Draft Text, Draft Label, Draft Dimension

Description

The Draft_AnnotationStyleEditor command allows you to define styles that affect the visual properties of annotation-like objects, such as those create by the Draft Text, Draft Dimension, and Draft Label commands.

File:Draft AnnotationStyleEditor example.png

Style editor to configure the annotations.

Usage

  1. There are several ways to invoke the command:
  2. The Annotation Styles Editor dialog box opens.
  3. Select a style from the Style name dropdown list, or choose Add new... to define a new style.
  4. Optionally adjust the properties of the style.
  5. Optionally press the Rename button to rename the style.
  6. Optionally press the Delete button to delete the style.
  7. Optionally press the button to import all styles from a .json file. This will overwrite existing styles with the same name.
  8. Optionally press the button to export all styles to a .json file.
  9. Press the OK button to close the dialog box and finish the command.

Scripting

The annotation styles are saved as serialized dictionaries in the Meta attribute of the document. This attribute is inspected by the annotation style editor when it is opened.

>>> print(App.ActiveDocument.Meta["Draft_Style_Lane 1:100"])
{"FontName": "DejaVu Sans", "FontSize": "8.0000 ", "LineSpacing": "1 cm", "ScaleMultiplier": 1.0, "ShowUnit": false, "UnitOverride": "", "Decimals": 2, "ShowLines": true, "LineWidth": 2, "LineColor": 1095216660480, "ArrowType": 0, "ArrowSize": "5.0000 ", "DimensionOvershoot": "1.0000 ", "ExtensionLines": "5.0000 ", "ExtensionOvershoot": "1.0000 "}

Each style that appears in the editor is internally saved with the style name prefixed by Draft_Style_; this will prevent name clashes with other keys that may be saved in Meta, which can hold arbitrary information.

You may define any new style by adding the necessary information to a key that starts with Draft_Style_. The corresponding value of this key must be a dictionary serialized using json.

import json

meta = App.ActiveDocument.Meta
props = {"LineWidth": 6, "ArrowSize": "7"}
meta["Draft_Style_Thick_lines"] = json.dumps(props)
App.ActiveDocument.Meta = meta

The values not entered will be filled automatically when this style is selected in the style editor.

In a similar way, any serialized dictionary can be unpacked for edition.

meta = App.ActiveDocument.Meta
new_dict = json.loads(meta["Draft_Style_Thick_lines"])

Because the graphical interface widgets check the units of the input values, many of these values must be saved as strings, rather than floating point numbers.

Strings:

props = {
  "FontName": "DejaVu Sans",
  "FontSize": "12.0000 ",
  "LineSpacing": "1 cm",
  "UnitOverride": "m",
  "ArrowSize": "5.0000 ",
  "DimensionOvershoot": "1.0000 ",
  "ExtensionLines": "5.0000 ",
  "ExtensionOvershoot": "1.0000 "
}

Numbers:

props = {
  "ScaleMultiplier": 1.0,
  "Decimals": 2,
  "LineWidth": 1,
  "LineColor": 1095216660480,
  "ArrowType": 0
}

The line color corresponds to the 32-bit integer, from which the individual RGBA values can be extracted.

Boolean:

props = {
  "ShowUnit": False,
  "ShowLines": True
}