@rtemis/draw 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -30,9 +30,11 @@ const option = builders.a3(a3Document, config)
30
30
 
31
31
  `appearance` holds what every chart type shares and the config does not: the light or dark theme, the font family, the title inset, the legend gap, and animation. Every member of `config` and `appearance` is optional.
32
32
 
33
+ `a3SurfaceHints(document, config, appearance)` returns the height that keeps the layout's row spacing, the plot body height, and the glyph sizes, for a renderer that sizes its surface before drawing.
34
+
33
35
  ## In rtemis.draw
34
36
 
35
- rtemis.draw ships the builders as one script, `r/inst/htmlwidgets/lib/draw/rtemis-draw-builders.js`, which defines the global `RtemisDraw` in a browser and is a CommonJS module in Node.js. From the repository root:
37
+ rtemis.draw ships the builders as one script, `r/inst/htmlwidgets/lib/draw/rtemis-draw-builders.js`, which defines the global `RtemisDraw` in a browser and is a CommonJS module in Node.js. The `rtemis-draw` widget declares it as a dependency and builds the option of a `BuildRequest` with it; `save_drawing()` builds the same request in Node.js. From the repository root:
36
38
 
37
39
  ```sh
38
40
  just ts-test # type check, Biome, Vitest
@@ -4,7 +4,7 @@ import type { A3EChartsOption, A3PtmPlacement } from "./types.ts";
4
4
  * An instance of the `chart/a3/v1` schema, written by rtemis.draw's `A3Config`
5
5
  * class. Every member is optional; an absent member takes the default below.
6
6
  * `annotation_gap` and `position_label_gap` are members the R class gains
7
- * with this package (spec: draw/shared-builders#a3-option-inventory).
7
+ * with this package (spec: draw/shared-builders#config-contract).
8
8
  */
9
9
  export interface A3ChartConfig {
10
10
  readonly type?: "a3";
@@ -54,7 +54,7 @@ export declare const A3_CHART_CONFIG_MEMBERS: readonly ["type", "n_per_row", "po
54
54
  /**
55
55
  * Appearance shared by every chart type, and the light or dark theme. The
56
56
  * defaults equal rtemislive's A3 defaults until the appearance contract is
57
- * reconciled across chart types (spec: draw/shared-builders#inputs-that-are-not-the-chart-config).
57
+ * reconciled across chart types (spec: draw/shared-builders/notes#inputs-that-are-not-the-chart-config).
58
58
  */
59
59
  export interface A3Appearance {
60
60
  /** Select the dark theme. Default `false`. */
@@ -73,4 +73,25 @@ export interface A3Appearance {
73
73
  * `chart/a3/v1` config.
74
74
  */
75
75
  export declare function buildA3Option(document: A3Data, config?: A3ChartConfig, appearance?: A3Appearance): A3EChartsOption;
76
+ /** The sizes a renderer needs to fit an A3 option to its surface. */
77
+ export interface A3SurfaceHints {
78
+ /** Chart height in pixels that keeps the row spacing of the layout. */
79
+ readonly height: number;
80
+ /** Height in pixels of the plot body, from the first row to the last. */
81
+ readonly bodyHeight: number;
82
+ /** Residue marker size in pixels. */
83
+ readonly markerSize: number;
84
+ /** Residue label font size in pixels. */
85
+ readonly fontSize: number;
86
+ /** Gap between residues. */
87
+ readonly residueSpacing: number;
88
+ /** Gap in pixels between the plot and the legend rail. */
89
+ readonly legendGap: number;
90
+ }
91
+ /**
92
+ * The height and glyph sizes of an A3 diagram, for a renderer that sizes its
93
+ * surface before drawing (rtemislive's chart container, rtemis.draw's widget
94
+ * and SVG export).
95
+ */
96
+ export declare function a3SurfaceHints(document: A3Data, config?: A3ChartConfig, appearance?: A3Appearance): A3SurfaceHints;
76
97
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/charts/a3/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EAGf,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,oCAAoC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,iFAAiF;IACjF,QAAQ,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IACxC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,yCAAyC;IACzC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,iDAAiD;IACjD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gDAAgD;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,kDAAkD;IAClD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,4DAA4D;IAC5D,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,2DAA2D;IAC3D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,8EAA8E;IAC9E,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,mBAAmB;IACnB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,4EAA4E;AAC5E,eAAO,MAAM,uBAAuB,wVAsBkB,CAAC;AAOvD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,aAAkB,EAC1B,UAAU,GAAE,YAAiB,GAC5B,eAAe,CAuCjB"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/charts/a3/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAIzC,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EAGf,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,oCAAoC;IACpC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,iFAAiF;IACjF,QAAQ,CAAC,aAAa,CAAC,EAAE,cAAc,CAAC;IACxC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,yCAAyC;IACzC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,iDAAiD;IACjD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,gDAAgD;IAChD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,6EAA6E;IAC7E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,kDAAkD;IAClD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,2DAA2D;IAC3D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,8DAA8D;IAC9D,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,2DAA2D;IAC3D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,4DAA4D;IAC5D,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,2DAA2D;IAC3D,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,8EAA8E;IAC9E,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,mBAAmB;IACnB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,4EAA4E;AAC5E,eAAO,MAAM,uBAAuB,wVAsBkB,CAAC;AAOvD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,aAAkB,EAC1B,UAAU,GAAE,YAAiB,GAC5B,eAAe,CAGjB;AAED,qEAAqE;AACrE,MAAM,WAAW,cAAc;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,yEAAyE;IACzE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,4BAA4B;IAC5B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,aAAkB,EAC1B,UAAU,GAAE,YAAiB,GAC5B,cAAc,CAYhB"}
@@ -1,4 +1,5 @@
1
1
  import { createA3EChartsOption } from "./echarts.js";
2
+ import { createA3LayoutModel, resolveA3VisualizationHeight } from "./layout.js";
2
3
  import { DARK_A3_VISUALIZATION_THEME } from "./palette.js";
3
4
  /** Every member of {@link A3ChartConfig}, checked against `chart/a3/v1`. */
4
5
  export const A3_CHART_CONFIG_MEMBERS = Object.freeze([
@@ -31,6 +32,28 @@ void _everyMember;
31
32
  * `chart/a3/v1` config.
32
33
  */
33
34
  export function buildA3Option(document, config = {}, appearance = {}) {
35
+ const option = createA3EChartsOption(document, visualizationOptions(config, appearance));
36
+ return config.zoom === false ? option : Object.freeze({ ...option, dataZoom: A3_ZOOM });
37
+ }
38
+ /**
39
+ * The height and glyph sizes of an A3 diagram, for a renderer that sizes its
40
+ * surface before drawing (rtemislive's chart container, rtemis.draw's widget
41
+ * and SVG export).
42
+ */
43
+ export function a3SurfaceHints(document, config = {}, appearance = {}) {
44
+ const options = visualizationOptions(config, appearance);
45
+ const model = createA3LayoutModel(document, options);
46
+ const markerSize = options.markerSize ?? 28;
47
+ return Object.freeze({
48
+ height: resolveA3VisualizationHeight(document, options),
49
+ bodyHeight: markerSize * (2 * (model.bounds.maxY - model.bounds.minY) + 1),
50
+ markerSize,
51
+ fontSize: options.fontSize ?? 18,
52
+ residueSpacing: options.residueSpacing ?? 0.3,
53
+ legendGap: options.legendGap ?? 90,
54
+ });
55
+ }
56
+ function visualizationOptions(config, appearance) {
34
57
  const dark = appearance.dark ?? false;
35
58
  const base = dark ? DARK_A3_VISUALIZATION_THEME : {};
36
59
  const theme = {
@@ -47,7 +70,7 @@ export function buildA3Option(document, config = {}, appearance = {}) {
47
70
  ...colorOverride("variantColor", config.variant_color),
48
71
  ...colorOverride("diseaseVariantColor", config.disease_variant_color),
49
72
  };
50
- const options = {
73
+ return {
51
74
  nPerRow: config.n_per_row ?? 21,
52
75
  residueSpacing: config.residue_spacing ?? 0.3,
53
76
  showMarkers: config.show_markers ?? true,
@@ -67,8 +90,6 @@ export function buildA3Option(document, config = {}, appearance = {}) {
67
90
  ...(config.title ? { title: config.title } : {}),
68
91
  ...(appearance.titleTop === undefined ? {} : { titleTop: appearance.titleTop }),
69
92
  };
70
- const option = createA3EChartsOption(document, options);
71
- return config.zoom === false ? option : Object.freeze({ ...option, dataZoom: A3_ZOOM });
72
93
  }
73
94
  // Shift+wheel zooms the sequence axis and drag pans it, so the plain wheel
74
95
  // scrolls the host page (spec: draw/zoom-controls#design).
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/charts/a3/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AA0D3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,MAAM;IACN,WAAW;IACX,gBAAgB;IAChB,eAAe;IACf,MAAM;IACN,iBAAiB;IACjB,aAAa;IACb,WAAW;IACX,YAAY;IACZ,cAAc;IACd,aAAa;IACb,gBAAgB;IAChB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,iBAAiB;IACjB,eAAe;IACf,uBAAuB;IACvB,OAAO;CAC4C,CAAC,CAAC;AAIvD,MAAM,YAAY,GAA+C,IAAI,CAAC;AACtE,KAAK,YAAY,CAAC;AAoBlB;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAgB,EAChB,SAAwB,EAAE,EAC1B,aAA2B,EAAE;IAE7B,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,KAAK,CAAC;IACtC,MAAM,IAAI,GAAkC,IAAI,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,KAAK,GAAkC;QAC3C,GAAG,IAAI;QACP,GAAG,CAAC,UAAU,CAAC,UAAU;YACvB,CAAC,CAAC;gBACE,oBAAoB,EAAE,UAAU,CAAC,UAAU;gBAC3C,gBAAgB,EAAE,UAAU,CAAC,UAAU;aACxC;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,cAAc,CAAC;QAC7D,GAAG,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;QAClD,GAAG,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,eAAe,CAAC;QAC9D,GAAG,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;QACtD,GAAG,aAAa,CAAC,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,CAAC;KACtE,CAAC;IACF,MAAM,OAAO,GAA2B;QACtC,OAAO,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;QAC/B,cAAc,EAAE,MAAM,CAAC,eAAe,IAAI,GAAG;QAC7C,WAAW,EAAE,MAAM,CAAC,YAAY,IAAI,IAAI;QACxC,UAAU,EAAE,MAAM,CAAC,WAAW,IAAI,IAAI;QACtC,aAAa,EAAE,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc;QAC/E,UAAU,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE;QACpC,QAAQ,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;QAChC,SAAS,EAAE,MAAM,CAAC,UAAU,IAAI,CAAC;QACjC,aAAa,EAAE,MAAM,CAAC,cAAc,IAAI,EAAE;QAC1C,gBAAgB,EAAE,MAAM,CAAC,kBAAkB,IAAI,EAAE;QACjD,WAAW,EAAE,MAAM,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,aAAa,EAAE,MAAM,CAAC,cAAc,IAAI,GAAG;QAC3C,YAAY,EAAE,MAAM,CAAC,aAAa,IAAI,QAAQ;QAC9C,SAAS,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE;QACrC,eAAe,EAAE,UAAU,CAAC,SAAS,IAAI,IAAI;QAC7C,KAAK;QACL,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;KAChF,CAAC;IACF,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxD,OAAO,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,2EAA2E;AAC3E,2DAA2D;AAC3D,MAAM,OAAO,GAAuC,MAAM,CAAC,MAAM,CAAC;IAChE;QACE,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,OAAO;QACzB,eAAe,EAAE,IAAI;QACrB,gBAAgB,EAAE,IAAI;QACtB,uBAAuB,EAAE,KAAK;KAC/B;IACD;QACE,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,KAAK;QACvB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;KACvB;CACF,CAAC,CAAC;AAEH,SAAS,aAAa,CACpB,GAA+B,EAC/B,KAAgC;IAEhC,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvC,CAAC"}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/charts/a3/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AA0D3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,CAAC;IACnD,MAAM;IACN,WAAW;IACX,gBAAgB;IAChB,eAAe;IACf,MAAM;IACN,iBAAiB;IACjB,aAAa;IACb,WAAW;IACX,YAAY;IACZ,cAAc;IACd,aAAa;IACb,gBAAgB;IAChB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,iBAAiB;IACjB,eAAe;IACf,uBAAuB;IACvB,OAAO;CAC4C,CAAC,CAAC;AAIvD,MAAM,YAAY,GAA+C,IAAI,CAAC;AACtE,KAAK,YAAY,CAAC;AAoBlB;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,QAAgB,EAChB,SAAwB,EAAE,EAC1B,aAA2B,EAAE;IAE7B,MAAM,MAAM,GAAG,qBAAqB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IACzF,OAAO,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC1F,CAAC;AAkBD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,QAAgB,EAChB,SAAwB,EAAE,EAC1B,aAA2B,EAAE;IAE7B,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC;QACvD,UAAU,EAAE,UAAU,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1E,UAAU;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;QAChC,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,GAAG;QAC7C,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,EAAE;KACnC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAqB,EACrB,UAAwB;IAExB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,KAAK,CAAC;IACtC,MAAM,IAAI,GAAkC,IAAI,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,KAAK,GAAkC;QAC3C,GAAG,IAAI;QACP,GAAG,CAAC,UAAU,CAAC,UAAU;YACvB,CAAC,CAAC;gBACE,oBAAoB,EAAE,UAAU,CAAC,UAAU;gBAC3C,gBAAgB,EAAE,UAAU,CAAC,UAAU;aACxC;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,cAAc,CAAC;QAC7D,GAAG,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC;QAClD,GAAG,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,eAAe,CAAC;QAC9D,GAAG,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;QACtD,GAAG,aAAa,CAAC,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,CAAC;KACtE,CAAC;IACF,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;QAC/B,cAAc,EAAE,MAAM,CAAC,eAAe,IAAI,GAAG;QAC7C,WAAW,EAAE,MAAM,CAAC,YAAY,IAAI,IAAI;QACxC,UAAU,EAAE,MAAM,CAAC,WAAW,IAAI,IAAI;QACtC,aAAa,EAAE,MAAM,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc;QAC/E,UAAU,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE;QACpC,QAAQ,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;QAChC,SAAS,EAAE,MAAM,CAAC,UAAU,IAAI,CAAC;QACjC,aAAa,EAAE,MAAM,CAAC,cAAc,IAAI,EAAE;QAC1C,gBAAgB,EAAE,MAAM,CAAC,kBAAkB,IAAI,EAAE;QACjD,WAAW,EAAE,MAAM,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,aAAa,EAAE,MAAM,CAAC,cAAc,IAAI,GAAG;QAC3C,YAAY,EAAE,MAAM,CAAC,aAAa,IAAI,QAAQ;QAC9C,SAAS,EAAE,UAAU,CAAC,SAAS,IAAI,EAAE;QACrC,eAAe,EAAE,UAAU,CAAC,SAAS,IAAI,IAAI;QAC7C,KAAK;QACL,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,UAAU,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;KAChF,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,2DAA2D;AAC3D,MAAM,OAAO,GAAuC,MAAM,CAAC,MAAM,CAAC;IAChE;QACE,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,OAAO;QACzB,eAAe,EAAE,IAAI;QACrB,gBAAgB,EAAE,IAAI;QACtB,uBAAuB,EAAE,KAAK;KAC/B;IACD;QACE,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,CAAC;QACb,gBAAgB,EAAE,KAAK;QACvB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;KACvB;CACF,CAAC,CAAC;AAEH,SAAS,aAAa,CACpB,GAA+B,EAC/B,KAAgC;IAEhC,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvC,CAAC"}
@@ -1,4 +1,4 @@
1
- export type { A3Appearance, A3ChartConfig } from "./config.ts";
2
- export { buildA3Option } from "./config.ts";
1
+ export type { A3Appearance, A3ChartConfig, A3SurfaceHints } from "./config.ts";
2
+ export { A3_CHART_CONFIG_MEMBERS, a3SurfaceHints, buildA3Option } from "./config.ts";
3
3
  export type { A3EChartsOption, A3PtmPlacement } from "./types.ts";
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/charts/a3/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/charts/a3/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACrF,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
@@ -1,2 +1,2 @@
1
- export { buildA3Option } from "./config.js";
1
+ export { A3_CHART_CONFIG_MEMBERS, a3SurfaceHints, buildA3Option } from "./config.js";
2
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/charts/a3/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/charts/a3/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC"}
package/dist/index.d.ts CHANGED
@@ -3,13 +3,13 @@
3
3
  * takes a chart's data and its `chart/<type>/v1` config and returns the
4
4
  * ECharts option.
5
5
  *
6
- * spec: draw/shared-builders#design
6
+ * spec: draw/shared-builders#package
7
7
  *
8
8
  * @module
9
9
  */
10
10
  import { buildA3Option } from "./charts/a3/index.ts";
11
- export type { A3Appearance, A3ChartConfig, A3EChartsOption, A3PtmPlacement, } from "./charts/a3/index.ts";
12
- export { buildA3Option } from "./charts/a3/index.ts";
11
+ export type { A3Appearance, A3ChartConfig, A3EChartsOption, A3PtmPlacement, A3SurfaceHints, } from "./charts/a3/index.ts";
12
+ export { A3_CHART_CONFIG_MEMBERS, a3SurfaceHints, buildA3Option } from "./charts/a3/index.ts";
13
13
  /** The builder of each chart type, by `chart/<type>/v1` type name. */
14
14
  export declare const builders: Readonly<{
15
15
  a3: typeof buildA3Option;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,YAAY,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EACf,cAAc,GACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,sEAAsE;AACtE,eAAO,MAAM,QAAQ;;EAEnB,CAAC;AAEH,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,QAAQ,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,YAAY,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EACf,cAAc,EACd,cAAc,GACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE9F,sEAAsE;AACtE,eAAO,MAAM,QAAQ;;EAEnB,CAAC;AAEH,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,QAAQ,CAAC"}
package/dist/index.js CHANGED
@@ -3,12 +3,12 @@
3
3
  * takes a chart's data and its `chart/<type>/v1` config and returns the
4
4
  * ECharts option.
5
5
  *
6
- * spec: draw/shared-builders#design
6
+ * spec: draw/shared-builders#package
7
7
  *
8
8
  * @module
9
9
  */
10
10
  import { buildA3Option } from "./charts/a3/index.js";
11
- export { buildA3Option } from "./charts/a3/index.js";
11
+ export { A3_CHART_CONFIG_MEMBERS, a3SurfaceHints, buildA3Option } from "./charts/a3/index.js";
12
12
  /** The builder of each chart type, by `chart/<type>/v1` type name. */
13
13
  export const builders = Object.freeze({
14
14
  a3: buildA3Option,
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAQrD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,sEAAsE;AACtE,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,aAAa;CAClB,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AASrD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE9F,sEAAsE;AACtE,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,aAAa;CAClB,CAAC,CAAC"}
@@ -21,6 +21,8 @@ var RtemisDraw = (() => {
21
21
  // src/index.ts
22
22
  var index_exports = {};
23
23
  __export(index_exports, {
24
+ A3_CHART_CONFIG_MEMBERS: () => A3_CHART_CONFIG_MEMBERS,
25
+ a3SurfaceHints: () => a3SurfaceHints,
24
26
  buildA3Option: () => buildA3Option,
25
27
  builders: () => builders
26
28
  });
@@ -52,9 +54,11 @@ var RtemisDraw = (() => {
52
54
  X: "(Any)",
53
55
  "*": "Termination codon"
54
56
  });
57
+ var DEFAULT_MARKER_SIZE = 28;
55
58
  var DEFAULT_FONT_SIZE = 18;
56
59
  var DEFAULT_MARGIN_TOP = 24;
57
60
  var DEFAULT_MARGIN_TOP_WITH_TITLE = 64;
61
+ var DEFAULT_MARGIN_BOTTOM = 24;
58
62
  var DEFAULT_TITLE_TOP = 32;
59
63
  var DEFAULT_TITLE_BOTTOM_GAP = 14;
60
64
  var DEFAULT_N_PER_ROW = 21;
@@ -81,6 +85,10 @@ var RtemisDraw = (() => {
81
85
  bounds: computeBounds(residues)
82
86
  });
83
87
  }
88
+ function resolveA3VisualizationHeight(input, options = {}) {
89
+ const model = createA3LayoutModel(input, options);
90
+ return resolveA3VisualizationHeightFromModel(model, options);
91
+ }
84
92
  function resolveA3TitleTop(options = {}) {
85
93
  return options.titleTop ?? DEFAULT_TITLE_TOP;
86
94
  }
@@ -141,6 +149,17 @@ var RtemisDraw = (() => {
141
149
  }
142
150
  return 1 + (x - 1) * residueSpacing;
143
151
  }
152
+ function resolveA3VisualizationHeightFromModel(model, options = {}) {
153
+ if (options.height !== void 0) {
154
+ return options.height;
155
+ }
156
+ const markerSize = options.markerSize ?? DEFAULT_MARKER_SIZE;
157
+ const topMargin = resolveA3TitleMarginTop(options);
158
+ const bottomMargin = DEFAULT_MARGIN_BOTTOM;
159
+ const verticalSpan = model.bounds.maxY - model.bounds.minY;
160
+ const bodyHeight = markerSize * (2 * verticalSpan + 1);
161
+ return Math.ceil(topMargin + bottomMargin + bodyHeight);
162
+ }
144
163
  function computeBounds(residues) {
145
164
  const xs = residues.map((residue) => residue.x);
146
165
  const ys = residues.map((residue) => residue.y);
@@ -838,6 +857,23 @@ var RtemisDraw = (() => {
838
857
  "title"
839
858
  ]);
840
859
  function buildA3Option(document, config = {}, appearance = {}) {
860
+ const option = createA3EChartsOption(document, visualizationOptions(config, appearance));
861
+ return config.zoom === false ? option : Object.freeze({ ...option, dataZoom: A3_ZOOM });
862
+ }
863
+ function a3SurfaceHints(document, config = {}, appearance = {}) {
864
+ const options = visualizationOptions(config, appearance);
865
+ const model = createA3LayoutModel(document, options);
866
+ const markerSize = options.markerSize ?? 28;
867
+ return Object.freeze({
868
+ height: resolveA3VisualizationHeight(document, options),
869
+ bodyHeight: markerSize * (2 * (model.bounds.maxY - model.bounds.minY) + 1),
870
+ markerSize,
871
+ fontSize: options.fontSize ?? 18,
872
+ residueSpacing: options.residueSpacing ?? 0.3,
873
+ legendGap: options.legendGap ?? 90
874
+ });
875
+ }
876
+ function visualizationOptions(config, appearance) {
841
877
  const dark = appearance.dark ?? false;
842
878
  const base = dark ? DARK_A3_VISUALIZATION_THEME : {};
843
879
  const theme = {
@@ -852,7 +888,7 @@ var RtemisDraw = (() => {
852
888
  ...colorOverride("variantColor", config.variant_color),
853
889
  ...colorOverride("diseaseVariantColor", config.disease_variant_color)
854
890
  };
855
- const options = {
891
+ return {
856
892
  nPerRow: config.n_per_row ?? 21,
857
893
  residueSpacing: config.residue_spacing ?? 0.3,
858
894
  showMarkers: config.show_markers ?? true,
@@ -872,8 +908,6 @@ var RtemisDraw = (() => {
872
908
  ...config.title ? { title: config.title } : {},
873
909
  ...appearance.titleTop === void 0 ? {} : { titleTop: appearance.titleTop }
874
910
  };
875
- const option = createA3EChartsOption(document, options);
876
- return config.zoom === false ? option : Object.freeze({ ...option, dataZoom: A3_ZOOM });
877
911
  }
878
912
  var A3_ZOOM = Object.freeze([
879
913
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rtemis/draw",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "ECharts option builders shared by rtemis.draw and rtemislive",
5
5
  "homepage": "https://rtemis.org",
6
6
  "keywords": ["rtemis", "echarts", "visualization"],