Display & Report Methods#
Drawing Tools provides @plot_data_view and @markdown_view methods across
multiple classes for visualizing and reporting enrichment results. This page lists
all available methods and shows interactive examples for each FeaturedSheet view.
All @plot_data_view Methods#
The following table lists every @plot_data_view in the package:
Class |
Method |
Selector |
Description |
|---|---|---|---|
|
|
|
Base 2D rendering of all sheets |
|
|
|
All sheets with view index labels |
|
|
|
All sheets with grid reference overlay (zones, cells, labels) |
|
|
|
All sheets with parsed view title overlays |
|
|
|
All sheets with balloon overlays (groups + labels) |
|
|
|
All sheets with flag symbols highlighted |
|
|
|
All sheets with detected set regions overlaid |
|
|
|
All sheets with detected tables rendered in full (per-cell colors) |
|
|
|
All sheets with colored dimension labels |
|
|
|
All sheets with geometrical tolerance overlays (green outlines) |
|
|
|
All sheets with roughness overlays (blue outlines) |
|
|
|
All sheets with section line indicator overlays |
|
|
|
All sheets with auxiliary view indicator overlays |
|
|
|
All sheets with aircraft reference line overlays (axis and value per dash-dot line) |
|
|
|
All sheets with aircraft orientation indicator overlays (arrow, caption per language, view frame) |
|
|
|
All sheets with title + section lines + auxiliary view indicators combined |
|
|
|
Base 2D rendering of one sheet |
|
|
|
View index labels on each view |
|
|
|
Grid reference overlay (zones, cells, labels) |
|
|
|
Parsed view title overlays |
|
|
|
Balloon overlays (groups + labels) with legend |
|
|
|
Flag symbols (multiplicators, FM) highlighted |
|
|
|
Detected set regions with colored rectangles |
|
|
|
Detected tables rendered in full (per-cell colors, colored frame + label), title block tagged |
|
|
|
Colored dimension labels |
|
|
|
Geometrical tolerance overlays (green outlines) |
|
|
|
Roughness overlays (blue outlines) |
|
|
|
Detected section line indicator overlays |
|
|
|
Auxiliary view indicator overlays on all views |
|
|
|
Aircraft reference line overlays on all views |
|
|
|
Aircraft orientation indicator overlays on all views, each containing view outlined |
|
|
|
Title + section lines + auxiliary view indicators combined |
|
|
|
Base 2D rendering of one view |
|
|
|
Parsed title overlay on one view |
|
|
|
Colored dimension labels on one view |
|
|
|
Geometrical tolerance overlays on one view (green outlines) |
|
|
|
Roughness overlays on one view (blue outlines) |
|
|
|
Detected section line indicator overlays on one view |
|
|
|
Auxiliary view indicator overlays on one view |
|
|
|
Aircraft reference line overlays on one view |
|
|
|
Aircraft orientation indicator overlays on one view |
|
|
|
Title + section lines + auxiliary view indicators on one view |
|
|
|
Source entity with title overlay labels |
FeaturedDrawing methods return MultiplePlots (one plot per sheet).
FeaturedSheet and FeaturedView methods return PrimitiveGroup.
All @markdown_view Methods#
The following markdown views generate text reports for the Dessia platform:
Class |
Method |
Selector |
Description |
|---|---|---|---|
|
|
|
Drawing-level markdown report |
|
|
|
Sheet-level markdown report |
|
|
|
View-level report (detected type, dimensions, tolerances, notes) |
|
|
|
Title parsing report (type, scale, identifiers, names by language) |
FeaturedSheet Examples#
from pathlib import Path
from dessia_drawing.core import Drawing
from drawing_tools.config.default_language_configs import DEFAULT_FRENCH_CONFIG, DEFAULT_ENGLISH_CONFIG
from drawing_tools.featured_drawing import FeaturedDrawing
_DATA_DIR = Path("data/json")
drawing = Drawing.from_json(str(_DATA_DIR / "2902060102_--A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json"))
featured_drawing = FeaturedDrawing(drawing, language_configs=[DEFAULT_FRENCH_CONFIG, DEFAULT_ENGLISH_CONFIG])
featured_sheet = featured_drawing.sheets[1]
2D View#
The base sheet rendering without any overlay.
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.plot_data_view().plot()
View Indexes#
Each view is enclosed in a colored rectangle with its sheet and view index
(e.g., S1 V2) displayed above. The background view gets an outline-only
rectangle (no fill) to avoid obscuring the sheet content.
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.plot_data_view_indexes().plot()
Grid Reference#
Overlays the detected ISO 5457 grid reference on the sheet: colored border zones (left=blue, right=green, top=yellow, bottom=purple), red dashed cell boundaries, and centered cell labels (e.g. “A1”, “F4”). Falls back to base content when no grid reference is detected.
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.plot_data_grid_reference().plot()
Every color is customizable and individual cells can be tinted to point them out:
collect_grid_reference_overlay_primitives() (the method behind the view) accepts
cell_color— the cell boundaries and labels (default red),zone_colors— the four border zones, a{"left"/"right"/"top"/"bottom": color}mapping merged onto the default palette (zones omitted keep their default color),highlighted_cells— a{cell name: fill color}mapping (case-insensitive) that tints specific cells.
Below, the cells are drawn in blue, the four border zones are recolored, and cell B3
is highlighted in orange.
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
import plot_data as pld
sheet = featured_sheet.sheet
primitives = sheet.plot_data_primitives()
primitives += sheet.collect_grid_reference_overlay_primitives(
cell_color="rgb(30, 80, 200)",
zone_colors={
"left": "rgb(0, 150, 136)",
"right": "rgb(103, 58, 183)",
"top": "rgb(233, 30, 99)",
"bottom": "rgb(121, 85, 72)",
},
highlighted_cells={"B3": "rgb(230, 120, 0)"},
)
pld.PrimitiveGroup(primitives=primitives).plot()
Title View#
Each view’s detected title is highlighted with a bounding rectangle and all parsed
attributes grouped by language (type, name, scale, repetition with / separators
across languages, then identifiers per language, and additional text lines).
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.plot_data_title_view().plot()
Source: condor_BEAM_ASSY_FALSE.json, Sheet 4
featured_sheet.plot_data_title_view().plot()
Balloons#
Balloons are color-coded by group status: blue = parent, green = child, orange = isolated. Labels below a balloon appear only when it has special attributes:
Mult N— multiplicator (e.g.,Mult 3), detected from nearby flag symbols (see Balloon Flags below)FM— for-info flag (Pour Memoire / For Memory), detected from nearby PM/FM symbols (see Balloon Flags below)Rep N— view repetition (e.g.,Rep 2), inherited from the view’s title (see ViewTitle Guide)
featured_sheet.plot_data_balloons().plot()
Source: grouped_balloons_1.json, Sheet 1
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
Balloon Flags#
This view highlights the flag symbols themselves (multiplicator and for-info flag
entities) rather than the balloons. Multiplicator symbols (e.g., X2, X3) are
shown in blue, and PM/FM symbols in green. This is complementary to the
Balloons view above, which shows the flags as labels on the balloons.
featured_sheet.plot_data_balloon_flags().plot()
Source: grouped_balloons_1.json, Sheet 1
Sets#
Detected sheet sets (sub-regions) are highlighted with colored rectangles and labels. Each set gets a distinct color.
Source: sheet_with_sets_1.json, Sheet 0
featured_sheet.plot_data_sets().plot()
Tables#
Detected tables are highlighted with colored rectangles. The title block is tagged
in magenta with [Title Block].
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.plot_data_tables().plot()
Dimensions#
Dimension annotations are highlighted with red outline rectangles. These are the linear, angular, radius, and diameter dimensions on the drawing.
featured_sheet.plot_data_dimensions().plot()
Source: RP6541D072_GICLEUR A00.json, Sheet 0 (64 dimensions)
Source: 2902060202_–A_DEF01_LH SUPPORT ACCUMULATOR.json, Sheet 1 (16 dimensions)
Tolerances#
Geometrical tolerances (GD&T) are highlighted with green outline rectangles. These are feature control frames specifying form, orientation, or position constraints (e.g., position, flatness, perpendicularity).
featured_sheet.plot_data_geometrical_tolerances().plot()
Source: RP6541D072_GICLEUR A00.json, Sheet 0 (18 tolerances)
Source: 2902060202_LH SUPPORT ACCUMULATOR.json, Sheet 1 (5 tolerances)
Roughness#
Surface roughness annotations are highlighted with blue outline rectangles. These specify surface finish requirements (e.g., Ra 1.6, Rz 3.2).
featured_sheet.plot_data_roughness().plot()
Source: RP6541D072_GICLEUR A00.json, Sheet 0 (11 roughness)
Section Lines#
Detected section line indicators are highlighted with colored bounding rectangles and labels showing identifier, cross-reference, detection source, and arrow direction. Each indicator gets a distinct color from a rotating palette.
For details about section line indicators, see Section Line Indicators.
Source: condor_BEAM_ASSY.json, Sheet 3
featured_sheet.plot_data_section_lines().plot()
Bonding Symbols#
Detected electrical bonding symbols (bonding table rule, METALLISATION / ELEC. BONDING) are highlighted with one palette color per symbol. Each one carries a caption — also its hover tooltip — stating its bonding TYPE and its leaders (its own arrows, or the balloon group it borrows them from), and its own leader arrows are redrawn in the symbol’s color.
For details about bonding symbols, see Electrical Bonding Symbols.
Regime 1 — the symbol carries its own leader arrows, redrawn in its color; the
caption reads Owns 2 leaders.
Source: condor_TEMP_332P641283_–A_DRW01_FORMATION_LIGHT_ASSY.json, Sheet 1 (6 symbols)
featured_sheet.plot_data_bonding_symbols().plot()
Regime 2 — the symbol is stacked against a balloon group and borrows its leader.
It has no arrow of its own, so the caption states the group it is grouped with and the
master balloon that carries the leader (Owns 0 leaders / Grouped with 4
balloons / Master balloon 114 has 1 leader).
Source: condor_BEAM_ASSY.json, Sheet 2 (3 symbols)
The same regime with a symbol stacked against a single, isolated balloon carrying two leaders — the master balloon is then the touched balloon itself.
Source: condor_BEAM_ASSY_FALSE.json, Sheet 4 (2 symbols)
Aircraft Reference Lines#
Detected aircraft reference lines — the dash-dot lines of the aircraft coordinate grid, each claimed by a label naming an axis and a value — are boxed with their label in one palette color per line, the caption stating the axis, the value and the orientation of the line on the sheet. The color is carried from one view to the next, so two lines of the same sheet never share one merely because they sit in different views.
For details about reference lines, see Aircraft Reference Lines.
Source: condor_TEMP_332P641283_–A_DRW01_FORMATION_LIGHT_ASSY.json, Sheet 3 (6 reference lines)
featured_sheet.plot_data_aircraft_reference_lines().plot()
Aircraft Orientation Indicators#
Detected aircraft orientation indicators — the arrow drawn with a bilingual caption
naming an aircraft direction, AVANT APPAREIL / FRONT AIRCRAFT — get one palette
color per indicator: the arrow strokes redrawn, a caption stating what each language
says, and the containing view outlined in the same color. At sheet scale the view
frames are what shows, at a glance, which views carry an indicator and which do not.
For details about orientation indicators, see Aircraft Orientation Indicators.
Source: condor_TEMP_332P641283_–A_DRW01_FORMATION_LIGHT_ASSY.json, Sheet 1 (4 indicators)
featured_sheet.plot_data_aircraft_orientation().plot()
Auxiliary View Indicators#
Auxiliary view indicators are TypeNote annotations with letter F and a nearby
FillArrow, matching the identifier pattern
(e.g., "F3", "F1 2/3") that are not part of any view title or section line
indicator. They represent view cross-references pointing to where auxiliary or section
views are defined.
For details about auxiliary view indicators, see Auxiliary View Indicators.
Source: condor_BEAM_ASSY.json, Sheet 1
featured_sheet.plot_data_auxiliary_view_indicators().plot()
All Identifiers#
The plot_data_all_identifiers method combines overlays from all three identifier
sources: view titles, section line indicators, and auxiliary view indicators.
Source: condor_BEAM_ASSY.json, Sheet 1
featured_sheet.plot_data_all_identifiers().plot()
Report#
The @markdown_view report generates a markdown summary table of the sheet,
listing each view with its name, scale, angle, geometry count, and annotation count.
Source: 2902060102_–A_DEF01_LH SUPPORT ACCUMULATOR ASSEMBLY.json, Sheet 1
featured_sheet.report()
# Sheet: Calque.2
**Number of views:** 7
| # | Name | Scale | Angle | View Types | Geometries | Annotations |
|---|------|-------|-------|------------|------------|-------------|
| 0 | Main View | 1.0 | 0.0 | NoTypeView | 0 | 0 |
| 1 | Background View | 1.0 | 0.0 | NoTypeView | 107 | 74 |
| 2 | VUE DE FACE | 1.0 | 0.0 | NoTypeView | 321 | 4 |
| 3 | COUPE A2-A2 | 1.0 | 0.0 | NoTypeView | 97 | 2 |
| 4 | COUPE B2-B2 | 2.0 | 0.0 | NoTypeView | 98 | 4 |
| 5 | VUE ISOMETRIQUE | 1.0 | 0.0 | NoTypeView | 252 | 3 |
| 6 | COUPE C2-C2 REDRESSEE | 3.0 | 1.21 | NoTypeView | 148 | 6 |