Skip to content

Latest commit

 

History

History
127 lines (89 loc) · 4.41 KB

Draft_AnnotationStyleEditor.md

File metadata and controls

127 lines (89 loc) · 4.41 KB
Raw
GuiCommand
Name MenuLocation Workbenches SeeAlso Version
Draft AnnotationStyleEditor
Annotation , Annotation styles...
Draft_Workbench
Draft_Text, Draft_Label, Draft_Dimension
0.19

Draft AnnotationStyleEditor

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.


The Annotation Styles Editor dialog box

Usage

  1. There are several ways to invoke the command:
    • Press the Annotation styles... button.
    • Select the Annotation → Annotation styles... option from the menu.
  2. The Annotation Styles Editor dialog box opens.
  3. Select a style from the Style name dropdown list, or choose {{Value|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

See also: Autogenerated API documentation and FreeCAD Scripting Basics.

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_Text red"])
{"ArrowSize": 2.0, "ArrowType": 0, "Decimals": 2, "DimOvershoot": 4.0, "ExtLines": 0.0, "ExtOvershoot": 4.0, "FontName": "DejaVu Sans", "FontSize": 10.0, "LineColor": 255, "LineSpacing": 1.0, "LineWidth": 2, "ScaleMultiplier": 1.0, "ShowLine": true, "ShowUnit": false, "TextColor": 4278190335, "TextSpacing": 3.0, "UnitOverride": ""}

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 = {"ArrowSize": 7.0, "LineWidth": 6}
meta["Draft_Style_Thick_lines"] = json.dumps(props)
App.ActiveDocument.Meta = meta

The properties not entered will be filled automatically when this style is selected in the style editor and the OK button is pressed.

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

import json

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

The properties must have the following types:

Strings:

props = {
    "FontName": "DejaVu Sans",
    "UnitOverride": ""
}

Floats (must be supplied with a decimal point):

props = {
    "ArrowSize": 2.0,
    "DimOvershoot": 4.0,
    "ExtLines": 0.0,
    "ExtOvershoot": 4.0
    "FontSize": 10.0,
    "LineSpacing": 1.0,
    "ScaleMultiplier": 1.0,
    "TextSpacing": 3.0
}

Integers:

props = {
    "ArrowType": 0,
    "Decimals": 2,
    "LineColor": 255,
    "LineWidth": 2,
    "TextColor": 4278190335
}

The {{Incode|TextColor}} and {{Incode|LineColor}} correspond to a 32-bit integer, from which the individual RGBA values can be extracted. The {{Incode|ArrowType}} is an enumerator.

Booleans:

props = {
    "ShowLine": true
    "ShowUnit": false,
}

⏵ documentation index > Draft > Draft AnnotationStyleEditor