@czi-sds/mcp 0.20.1 → 0.21.0
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/data/component-docs/Autocomplete.md +2 -14
- package/data/component-docs/Chip.md +160 -0
- package/data/component-docs/NavigationFooter.md +13 -13
- package/data/component-docs/NavigationHeader.md +26 -26
- package/data/component-docs/PreComposedTable.md +9 -27
- package/data/component-docs/ProteinStructureViewer.md +771 -37
- package/data/component-docs/Table.md +9 -31
- package/data/component-docs/Tabs.md +1 -6
- package/data/component-docs/Tag.md +357 -200
- package/data/component-docs/index.json +5 -5
- package/data/component-list.json +1 -0
- package/data/component-props/Button.json +6 -6
- package/data/component-props/Chip.json +30 -0
- package/data/component-props/Dropdown.json +6 -6
- package/data/component-props/InputSlider.json +5 -5
- package/data/component-props/LoadingIndicator.json +6 -6
- package/data/component-props/Menu.json +74 -0
- package/data/component-props/NavigationFooter.json +2 -2
- package/data/component-props/NavigationHeader.json +2 -2
- package/data/component-props/Notification.json +5 -5
- package/data/component-props/PreComposedTable.json +9 -9
- package/data/component-props/ProteinStructureViewer.json +74 -98
- package/data/component-props/Tag.json +41 -20
- package/data/component-props/TagFilter.json +0 -2
- package/data/component-props/TagLegacy.json +40 -0
- package/data/component-props/Tooltip.json +5 -5
- package/data/component-props/TooltipTable.json +5 -5
- package/package.json +2 -2
- package/data/component-docs/TagFilter.md +0 -131
|
@@ -54,6 +54,11 @@
|
|
|
54
54
|
"package": "@czi-sds/components",
|
|
55
55
|
"source": "packages/components/src/core/CellHeader/__storybook__/docs/content.html"
|
|
56
56
|
},
|
|
57
|
+
"Chip": {
|
|
58
|
+
"file": "Chip.md",
|
|
59
|
+
"package": "@czi-sds/components",
|
|
60
|
+
"source": "packages/components/src/core/Chip/__storybook__/docs/content.html"
|
|
61
|
+
},
|
|
57
62
|
"ComplexFilter": {
|
|
58
63
|
"file": "ComplexFilter.md",
|
|
59
64
|
"package": "@czi-sds/components",
|
|
@@ -244,11 +249,6 @@
|
|
|
244
249
|
"package": "@czi-sds/components",
|
|
245
250
|
"source": "packages/components/src/core/Tag/__storybook__/docs/content.html"
|
|
246
251
|
},
|
|
247
|
-
"TagFilter": {
|
|
248
|
-
"file": "TagFilter.md",
|
|
249
|
-
"package": "@czi-sds/components",
|
|
250
|
-
"source": "packages/components/src/core/TagFilter/__storybook__/docs/content.html"
|
|
251
|
-
},
|
|
252
252
|
"Tooltip": {
|
|
253
253
|
"file": "Tooltip.md",
|
|
254
254
|
"package": "@czi-sds/components",
|
package/data/component-list.json
CHANGED
|
@@ -18,6 +18,12 @@
|
|
|
18
18
|
"isRequired": false,
|
|
19
19
|
"type": "ReactNode"
|
|
20
20
|
},
|
|
21
|
+
"disabled": {
|
|
22
|
+
"defaultValue": false,
|
|
23
|
+
"description": "If `true`, the component is disabled.",
|
|
24
|
+
"isRequired": false,
|
|
25
|
+
"type": "boolean"
|
|
26
|
+
},
|
|
21
27
|
"endIcon": {
|
|
22
28
|
"description": "Element placed after the children.",
|
|
23
29
|
"isRequired": false,
|
|
@@ -51,12 +57,6 @@
|
|
|
51
57
|
"isRequired": false,
|
|
52
58
|
"type": "ReactNode"
|
|
53
59
|
},
|
|
54
|
-
"disabled": {
|
|
55
|
-
"defaultValue": false,
|
|
56
|
-
"description": "If `true`, the component is disabled.",
|
|
57
|
-
"isRequired": false,
|
|
58
|
-
"type": "boolean"
|
|
59
|
-
},
|
|
60
60
|
"href": {
|
|
61
61
|
"description": "The URL to link to when the button is clicked.\nIf defined, an `a` element will be used as the root node.",
|
|
62
62
|
"isRequired": false,
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Chip": {
|
|
3
|
+
"props": {
|
|
4
|
+
"label": {
|
|
5
|
+
"defaultValue": "- (required)",
|
|
6
|
+
"description": "The filter's text. Cut off with an ellipsis when there is not room for it.",
|
|
7
|
+
"isRequired": true,
|
|
8
|
+
"type": "string"
|
|
9
|
+
},
|
|
10
|
+
"sdsStyle": {
|
|
11
|
+
"defaultValue": "solid",
|
|
12
|
+
"description": "`solid` fills the chip with the accent color. `outline` tints it and\ndraws the label, the X and a 1px border in the accent color.",
|
|
13
|
+
"isRequired": false,
|
|
14
|
+
"type": "\"outline\" | \"solid\""
|
|
15
|
+
},
|
|
16
|
+
"onDelete": {
|
|
17
|
+
"defaultValue": "- (required)",
|
|
18
|
+
"description": "Runs when the chip is clicked or activated with Enter or Space, and when\nBackspace or Delete is pressed on it. Drop the filter from your state\nhere; the component does not remove itself.",
|
|
19
|
+
"isRequired": true,
|
|
20
|
+
"type": "(event: any) => void"
|
|
21
|
+
},
|
|
22
|
+
"aria-label": {
|
|
23
|
+
"defaultValue": "Remove {label}",
|
|
24
|
+
"description": "The chip's accessible name, \"Remove\" followed by the label unless set.\nOverride it to word the removal differently.",
|
|
25
|
+
"isRequired": false,
|
|
26
|
+
"type": "string"
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -41,6 +41,12 @@
|
|
|
41
41
|
"isRequired": false,
|
|
42
42
|
"type": "boolean"
|
|
43
43
|
},
|
|
44
|
+
"isTriggerChangeOnOptionClick": {
|
|
45
|
+
"defaultValue": false,
|
|
46
|
+
"description": "When set to true, changes in Dropdown selections are applied in real-time to the react state.",
|
|
47
|
+
"isRequired": false,
|
|
48
|
+
"type": "boolean"
|
|
49
|
+
},
|
|
44
50
|
"label": {
|
|
45
51
|
"description": "The label of the Dropdown.",
|
|
46
52
|
"isRequired": true,
|
|
@@ -78,12 +84,6 @@
|
|
|
78
84
|
"isRequired": false,
|
|
79
85
|
"type": "string"
|
|
80
86
|
},
|
|
81
|
-
"isTriggerChangeOnOptionClick": {
|
|
82
|
-
"defaultValue": false,
|
|
83
|
-
"description": "When set to true, changes in Dropdown selections are applied in real-time to the react state.",
|
|
84
|
-
"isRequired": false,
|
|
85
|
-
"type": "boolean"
|
|
86
|
-
},
|
|
87
87
|
"value": {
|
|
88
88
|
"description": "The value of the autocomplete.\n\nThe value must have reference equality with the option in order to be selected.\nYou can customize the equality behavior with the `isOptionEqualToValue` prop.",
|
|
89
89
|
"isRequired": false,
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"InputSlider": {
|
|
3
3
|
"props": {
|
|
4
|
+
"defaultValue": {
|
|
5
|
+
"description": "The default value. Use when the component is not controlled.",
|
|
6
|
+
"isRequired": false,
|
|
7
|
+
"type": "number | number[]"
|
|
8
|
+
},
|
|
4
9
|
"disabled": {
|
|
5
10
|
"defaultValue": false,
|
|
6
11
|
"description": "If `true`, the component is disabled.",
|
|
@@ -37,11 +42,6 @@
|
|
|
37
42
|
"isRequired": false,
|
|
38
43
|
"type": "\"off\" | \"on\" | \"auto\""
|
|
39
44
|
},
|
|
40
|
-
"defaultValue": {
|
|
41
|
-
"description": "The default value. Use when the component is not controlled.",
|
|
42
|
-
"isRequired": false,
|
|
43
|
-
"type": "number | number[]"
|
|
44
|
-
},
|
|
45
45
|
"value": {
|
|
46
46
|
"description": "The value of the slider.\nFor ranged sliders, provide an array with two values.",
|
|
47
47
|
"isRequired": false,
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"LoadingIndicator": {
|
|
3
3
|
"props": {
|
|
4
|
-
"sdsStyle": {
|
|
5
|
-
"defaultValue": "- (required)",
|
|
6
|
-
"description": "Chooses between the two variants above. It has no default: leaving it out is a type error, and an indicator built without it renders unstyled.",
|
|
7
|
-
"isRequired": true,
|
|
8
|
-
"type": "\"minimal\" | \"tag\""
|
|
9
|
-
},
|
|
10
4
|
"aria-label": {
|
|
11
5
|
"defaultValue": "undefined",
|
|
12
6
|
"description": "Replaces what a screen reader announces for the status region, for example \"Loading cell types\". The visible text still reads \"Loading\". Without it, assistive technology announces the visible word.",
|
|
13
7
|
"isRequired": false,
|
|
14
8
|
"type": "string"
|
|
9
|
+
},
|
|
10
|
+
"sdsStyle": {
|
|
11
|
+
"defaultValue": "- (required)",
|
|
12
|
+
"description": "Chooses between the two variants above. It has no default: leaving it out is a type error, and an indicator built without it renders unstyled.",
|
|
13
|
+
"isRequired": true,
|
|
14
|
+
"type": "\"minimal\" | \"tag\""
|
|
15
15
|
}
|
|
16
16
|
}
|
|
17
17
|
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
{
|
|
2
|
+
"Menu": {
|
|
3
|
+
"props": {
|
|
4
|
+
"anchorOrigin": {
|
|
5
|
+
"defaultValue": "{\nvertical: top,\nhorizontal: left,\n}",
|
|
6
|
+
"description": "This is the point on the anchor where the popover's\n`anchorEl` will attach to. This is not used when the\nanchorReference is 'anchorPosition'.\n\nOptions:\nvertical: [top, center, bottom];\nhorizontal: [left, center, right].",
|
|
7
|
+
"isRequired": false,
|
|
8
|
+
"type": "PopoverOrigin"
|
|
9
|
+
},
|
|
10
|
+
"transformOrigin": {
|
|
11
|
+
"defaultValue": "{\nvertical: top,\nhorizontal: left,\n}",
|
|
12
|
+
"description": "This is the point on the popover which\nwill attach to the anchor's origin.\n\nOptions:\nvertical: [top, center, bottom, x(px)];\nhorizontal: [left, center, right, x(px)].",
|
|
13
|
+
"isRequired": false,
|
|
14
|
+
"type": "PopoverOrigin"
|
|
15
|
+
},
|
|
16
|
+
"open": {
|
|
17
|
+
"description": "If `true`, the component is shown.",
|
|
18
|
+
"isRequired": true,
|
|
19
|
+
"type": "boolean"
|
|
20
|
+
},
|
|
21
|
+
"anchorEl": {
|
|
22
|
+
"description": "An HTML element, or a function that returns one.\nIt's used to set the position of the menu.",
|
|
23
|
+
"isRequired": false,
|
|
24
|
+
"type": "Element | PopoverVirtualElement | () => Element | PopoverVirtualElement | null | null"
|
|
25
|
+
},
|
|
26
|
+
"children": {
|
|
27
|
+
"description": "Menu contents, normally `MenuItem`s.",
|
|
28
|
+
"isRequired": false,
|
|
29
|
+
"type": "ReactNode"
|
|
30
|
+
},
|
|
31
|
+
"onClose": {
|
|
32
|
+
"description": "Callback fired when the component requests to be closed.\n@param event The event source of the callback.\n@param reason Can be: `\"escapeKeyDown\"`, `\"backdropClick\"`, `\"tabKeyDown\"`.",
|
|
33
|
+
"isRequired": false,
|
|
34
|
+
"type": "(event: {}, reason: \"backdropClick\" | \"escapeKeyDown\") => void"
|
|
35
|
+
},
|
|
36
|
+
"variant": {
|
|
37
|
+
"defaultValue": "selectedMenu",
|
|
38
|
+
"description": "The variant to use. Use `menu` to prevent selected items from impacting the initial focus.",
|
|
39
|
+
"isRequired": false,
|
|
40
|
+
"type": "\"menu\" | \"selectedMenu\""
|
|
41
|
+
},
|
|
42
|
+
"autoFocus": {
|
|
43
|
+
"defaultValue": true,
|
|
44
|
+
"description": "If `true` (Default) will focus the `[role=\"menu\"]` if no focusable child is found. Disabled\nchildren are not focusable. If you set this prop to `false` focus will be placed\non the parent modal container. This has severe accessibility implications\nand should only be considered if you manage focus otherwise.",
|
|
45
|
+
"isRequired": false,
|
|
46
|
+
"type": "boolean"
|
|
47
|
+
},
|
|
48
|
+
"slotProps": {
|
|
49
|
+
"defaultValue": {},
|
|
50
|
+
"description": "The props used for each slot inside.",
|
|
51
|
+
"isRequired": false,
|
|
52
|
+
"type": "{ root?: SlotProps<ElementType<ModalProps, keyof IntrinsicElements>, MenuRootSlotPropsOverrides, MenuOwnerState> | undefined; paper?: SlotProps<...> | undefined; list?: SlotProps<...> | undefined; transition?: SlotComponentProps<...> | undefined; backdrop?: SlotProps<...> | undefined; }"
|
|
53
|
+
},
|
|
54
|
+
"keepMounted": {
|
|
55
|
+
"defaultValue": false,
|
|
56
|
+
"description": "Always keep the children in the DOM.\nThis prop can be useful in SEO situation or\nwhen you want to maximize the responsiveness of the Modal.",
|
|
57
|
+
"isRequired": false,
|
|
58
|
+
"type": "boolean"
|
|
59
|
+
},
|
|
60
|
+
"disablePortal": {
|
|
61
|
+
"defaultValue": false,
|
|
62
|
+
"description": "The `children` will be under the DOM hierarchy of the parent component.",
|
|
63
|
+
"isRequired": false,
|
|
64
|
+
"type": "boolean"
|
|
65
|
+
},
|
|
66
|
+
"transitionDuration": {
|
|
67
|
+
"defaultValue": "auto",
|
|
68
|
+
"description": "The length of the transition in `ms`, or 'auto'",
|
|
69
|
+
"isRequired": false,
|
|
70
|
+
"type": "number | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined; } | \"auto\""
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
"type": "string"
|
|
39
39
|
},
|
|
40
40
|
"tagColor": {
|
|
41
|
-
"description": "The Tag
|
|
41
|
+
"description": "The intent of the small, solid Tag beside the title. A tuple sets the label, background, and icon colors by hand.",
|
|
42
42
|
"isRequired": false,
|
|
43
|
-
"type": "\"info\" | \"negative\" | \"notice\" | \"positive\" | \"
|
|
43
|
+
"type": "\"info\" | \"accent\" | \"negative\" | \"notice\" | \"positive\" | \"beta\" | \"neutral\" | [string, string] | [string, string, string]"
|
|
44
44
|
},
|
|
45
45
|
"title": {
|
|
46
46
|
"description": "The main title displayed in the footer.",
|
|
@@ -91,9 +91,9 @@
|
|
|
91
91
|
},
|
|
92
92
|
"tagColor": {
|
|
93
93
|
"defaultValue": "neutral",
|
|
94
|
-
"description": "The
|
|
94
|
+
"description": "The intent of the small, solid Tag beside the title, or custom colors as [label, background] or [label, background, icon].",
|
|
95
95
|
"isRequired": false,
|
|
96
|
-
"type": "\"info\" | \"negative\" | \"notice\" | \"positive\" | \"
|
|
96
|
+
"type": "\"info\" | \"accent\" | \"negative\" | \"notice\" | \"positive\" | \"beta\" | \"neutral\" | [string, string] | [string, string, string]"
|
|
97
97
|
},
|
|
98
98
|
"title": {
|
|
99
99
|
"description": "The main title displayed in the header.",
|
|
@@ -17,6 +17,11 @@
|
|
|
17
17
|
"isRequired": false,
|
|
18
18
|
"type": "\"left\" | \"right\""
|
|
19
19
|
},
|
|
20
|
+
"buttonText": {
|
|
21
|
+
"description": "The label of the action button shown beneath the content. It only renders alongside buttonOnClick.",
|
|
22
|
+
"isRequired": false,
|
|
23
|
+
"type": "string"
|
|
24
|
+
},
|
|
20
25
|
"icon": {
|
|
21
26
|
"description": "Override the icon displayed before the children.\nUnless provided, the icon is mapped to the value of the `severity` prop.\nSet to `false` to remove the `icon`.",
|
|
22
27
|
"isRequired": false,
|
|
@@ -52,11 +57,6 @@
|
|
|
52
57
|
"description": "Hides the Notification when set to true. Changing it back to false brings the Notification back, which is how a dismissed Notification is restored.",
|
|
53
58
|
"isRequired": false,
|
|
54
59
|
"type": "boolean"
|
|
55
|
-
},
|
|
56
|
-
"buttonText": {
|
|
57
|
-
"description": "The label of the action button shown beneath the content. It only renders alongside buttonOnClick.",
|
|
58
|
-
"isRequired": false,
|
|
59
|
-
"type": "string"
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
62
|
}
|
|
@@ -12,6 +12,11 @@
|
|
|
12
12
|
"isRequired": false,
|
|
13
13
|
"type": "ColumnDef<TData>[]"
|
|
14
14
|
},
|
|
15
|
+
"data": {
|
|
16
|
+
"description": "Array of data objects to display in the table rows",
|
|
17
|
+
"isRequired": false,
|
|
18
|
+
"type": "TData[]"
|
|
19
|
+
},
|
|
15
20
|
"enableColumnFiltering": {
|
|
16
21
|
"defaultValue": false,
|
|
17
22
|
"description": "Adds a filter row under the header. Each column gets a search input unless its meta supplies a filterComponent",
|
|
@@ -74,10 +79,11 @@
|
|
|
74
79
|
"isRequired": false,
|
|
75
80
|
"type": "Partial<TableRowProps>"
|
|
76
81
|
},
|
|
77
|
-
"
|
|
78
|
-
"
|
|
82
|
+
"tableWidth": {
|
|
83
|
+
"defaultValue": "100%",
|
|
84
|
+
"description": "Sets the width of the table container",
|
|
79
85
|
"isRequired": false,
|
|
80
|
-
"type": "
|
|
86
|
+
"type": "string"
|
|
81
87
|
},
|
|
82
88
|
"className": {
|
|
83
89
|
"description": "CSS class name to apply to the table container",
|
|
@@ -89,12 +95,6 @@
|
|
|
89
95
|
"isRequired": false,
|
|
90
96
|
"type": "React.CSSProperties"
|
|
91
97
|
},
|
|
92
|
-
"tableWidth": {
|
|
93
|
-
"defaultValue": "100%",
|
|
94
|
-
"description": "Sets the width of the table container",
|
|
95
|
-
"isRequired": false,
|
|
96
|
-
"type": "string"
|
|
97
|
-
},
|
|
98
98
|
"pinning": {
|
|
99
99
|
"description": "Sticks the column to that edge while the table scrolls sideways, with a gradient at the edge once there is something hidden behind it",
|
|
100
100
|
"isRequired": false,
|
|
@@ -1,16 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"ProteinStructureViewer": {
|
|
3
3
|
"props": {
|
|
4
|
+
"structure": {
|
|
5
|
+
"defaultValue": "- (required)",
|
|
6
|
+
"description": "Structure to render, as raw PDB or mmCIF (PDBx) text.",
|
|
7
|
+
"isRequired": true,
|
|
8
|
+
"type": "string"
|
|
9
|
+
},
|
|
4
10
|
"backgroundColor": {
|
|
5
11
|
"description": "Canvas background, as `#RRGGBB`. Defaults to the SDS theme's base\nbackground, so the canvas follows the surrounding page in both modes.",
|
|
6
12
|
"isRequired": false,
|
|
7
13
|
"type": "string"
|
|
8
14
|
},
|
|
9
15
|
"chainColors": {
|
|
10
|
-
"description": "Color per chain, by `chainId`, as `#RRGGBB`. Chains left out fall back to\nthe viewer's palette. Only visible while chain coloring is what is on\nscreen,
|
|
16
|
+
"description": "Color per chain, by `chainId`, as `#RRGGBB`. Chains left out fall back to\nthe viewer's palette. Only visible while chain coloring is what is on\nscreen: when `colorBy` says so, or, left undefined, when neither `plddt`\nnor `residueOverlay` is set.",
|
|
11
17
|
"isRequired": false,
|
|
12
18
|
"type": "Record<string, string>"
|
|
13
19
|
},
|
|
20
|
+
"plddt": {
|
|
21
|
+
"description": "Per-residue pLDDT confidence on a 0-1 scale, ordered by residue. When\nsupplied the structure is colored by pLDDT unless `residueOverlay` takes\nover. A `null` entry, and every residue past the end, reads as unscored\nand is painted neutral rather than at the bottom of the scale.",
|
|
22
|
+
"isRequired": false,
|
|
23
|
+
"type": "(number | null)[] | null"
|
|
24
|
+
},
|
|
25
|
+
"residueOverlay": {
|
|
26
|
+
"description": "Per-residue values that override pLDDT coloring while set.",
|
|
27
|
+
"isRequired": false,
|
|
28
|
+
"type": "ResidueValueOverlay | null"
|
|
29
|
+
},
|
|
14
30
|
"hiddenChains": {
|
|
15
31
|
"description": "Chains hidden from the 3D view, by `chainId`. Leave undefined to let the\nviewer own visibility itself, which is what the chain legend's toggles\ndrive; passing it takes that over, and the toggles then only report.",
|
|
16
32
|
"isRequired": false,
|
|
@@ -26,6 +42,43 @@
|
|
|
26
42
|
"isRequired": false,
|
|
27
43
|
"type": "Partial<PluginUISpec>"
|
|
28
44
|
},
|
|
45
|
+
"sceneMode": {
|
|
46
|
+
"defaultValue": "managed",
|
|
47
|
+
"description": "Who draws the structure.\n\n`\"managed\"` draws each chain as a cartoon and its ligands as\nball-and-stick, colors them from `plddt`, `residueOverlay` and\n`chainColors`, hides the chains `hiddenChains` names, and frames the camera\non each structure it loads.\n\n`\"external\"` parses the structure and stops there: nothing is drawn,\ncolored, hidden or framed, and a consumer draws its own scene on the\nstructure `onReady` hands it. The sequence panel, selection, hover, legend\nand camera controls work as before; the legend describes the props rather\nthan what the consumer drew, and its chain toggles report through\n`onChainVisibilityChange` without hiding anything. Mol* frames the camera\non the first representation drawn into the empty scene.\n\nRead once, when the plugin is created.",
|
|
48
|
+
"isRequired": false,
|
|
49
|
+
"type": "\"managed\" | \"external\""
|
|
50
|
+
},
|
|
51
|
+
"colorBy": {
|
|
52
|
+
"description": "What paints the structure. Left undefined it follows what is supplied: a\n`residueOverlay` when there is one, then `plddt`, then the chain colors.\nNaming one makes it paint whatever else is set, which is how a toggle\nbetween confidence and chain coloring keeps both props in place. A theme\nwith nothing to paint with leaves every residue neutral.",
|
|
53
|
+
"isRequired": false,
|
|
54
|
+
"type": "\"overlay\" | \"plddt\" | \"chain\""
|
|
55
|
+
},
|
|
56
|
+
"highlights": {
|
|
57
|
+
"description": "Residues picked out in colors of their own, by the address the file gives\nthem. They paint over whatever colors the rest - chain, pLDDT or overlay -\nand are drawn in ball-and-stick over the cartoon; on a surface, the\nsurface itself carries them. Separate from `selection`: highlighting a\nresidue neither selects it nor moves the camera.",
|
|
58
|
+
"isRequired": false,
|
|
59
|
+
"type": "ResidueHighlight[]"
|
|
60
|
+
},
|
|
61
|
+
"initialCamera": {
|
|
62
|
+
"description": "Where the camera starts on each structure loaded, in place of fitting it\nto the structure. Applied once per load; moving the camera afterwards is\nthe user's.",
|
|
63
|
+
"isRequired": false,
|
|
64
|
+
"type": "CameraState | null"
|
|
65
|
+
},
|
|
66
|
+
"orientation": {
|
|
67
|
+
"description": "Turns the camera to look at the highlighted residues from one side or\nanother. Applied when a structure is loaded, unless `initialCamera` is\nset, and whenever it changes - not when the highlights do.",
|
|
68
|
+
"isRequired": false,
|
|
69
|
+
"type": "\"overview\" | \"facing\" | \"opposite\" | \"side\""
|
|
70
|
+
},
|
|
71
|
+
"projection": {
|
|
72
|
+
"description": "The camera's projection. Left undefined, Mol*'s own default stands.",
|
|
73
|
+
"isRequired": false,
|
|
74
|
+
"type": "\"perspective\" | \"orthographic\""
|
|
75
|
+
},
|
|
76
|
+
"representation": {
|
|
77
|
+
"defaultValue": "cartoon",
|
|
78
|
+
"description": "How the polymer is drawn. Ligands stay ball-and-stick either way.\nSwitching leaves the camera where it is.",
|
|
79
|
+
"isRequired": false,
|
|
80
|
+
"type": "\"cartoon\" | \"surface\""
|
|
81
|
+
},
|
|
29
82
|
"disableChainHighlightOnHover": {
|
|
30
83
|
"defaultValue": false,
|
|
31
84
|
"description": "Stop other chains from dimming in the 3D view while a chain's name is\npointed at, in the legend or above its grid in the sequence panel.\n\nThe dim is on by default, since on a complex it is how a reader finds out\nwhich chain is which. Turn it off where the movement is more distracting\nthan the answer is useful - a grid of viewers a pointer crosses on its way\nsomewhere else, or a page driving its own highlighting through `selection`.",
|
|
@@ -55,6 +108,11 @@
|
|
|
55
108
|
"isRequired": false,
|
|
56
109
|
"type": "string"
|
|
57
110
|
},
|
|
111
|
+
"sequenceViewerHeight": {
|
|
112
|
+
"description": "Height of the sequence panel, as any CSS length; a number is read as\npixels, and a percentage is of the viewer's own height. The 3D view and the\nlegend move up to make room for it. Ignored while `showSequenceViewer` is\noff.\n\nLeft undefined, the panel takes `max(104px, 30%)` of the viewer, growing to\n`max(134px, 32%)` once the viewer is 880px wide or more. A height set here\nholds at every width.",
|
|
113
|
+
"isRequired": false,
|
|
114
|
+
"type": "string | number"
|
|
115
|
+
},
|
|
58
116
|
"showSequenceViewer": {
|
|
59
117
|
"defaultValue": true,
|
|
60
118
|
"description": "Show the sequence panel pinned along the bottom of the viewer.",
|
|
@@ -66,33 +124,6 @@
|
|
|
66
124
|
"isRequired": false,
|
|
67
125
|
"type": "(StructureStat | null)[]"
|
|
68
126
|
},
|
|
69
|
-
"resolution": {
|
|
70
|
-
"defaultValue": "medium",
|
|
71
|
-
"description": "1280x720, 1920x1080, 3840x2160 and 7680x4320 respectively. Also exported as DOWNLOAD_RESOLUTIONS, for labelling a control of your own.",
|
|
72
|
-
"isRequired": false,
|
|
73
|
-
"type": "\"low\" | \"medium\" | \"high\" | \"maximum\""
|
|
74
|
-
},
|
|
75
|
-
"filename": {
|
|
76
|
-
"description": "Name for the file, without an extension. Defaults to the one Mol* derives from the loaded structure.",
|
|
77
|
-
"isRequired": false,
|
|
78
|
-
"type": "string"
|
|
79
|
-
},
|
|
80
|
-
"structure": {
|
|
81
|
-
"defaultValue": "- (required)",
|
|
82
|
-
"description": "Structure to render, as raw PDB or mmCIF (PDBx) text.",
|
|
83
|
-
"isRequired": true,
|
|
84
|
-
"type": "string"
|
|
85
|
-
},
|
|
86
|
-
"plddt": {
|
|
87
|
-
"description": "Per-residue pLDDT confidence on a 0-1 scale, ordered by residue. When\nsupplied the structure is colored by pLDDT unless `residueOverlay` takes\nover.",
|
|
88
|
-
"isRequired": false,
|
|
89
|
-
"type": "number[] | null"
|
|
90
|
-
},
|
|
91
|
-
"residueOverlay": {
|
|
92
|
-
"description": "Per-residue values that override pLDDT coloring while set.",
|
|
93
|
-
"isRequired": false,
|
|
94
|
-
"type": "ResidueValueOverlay | null"
|
|
95
|
-
},
|
|
96
127
|
"selection": {
|
|
97
128
|
"description": "What is selected, or null when nothing is. Leave undefined to let the\nviewer own the selection, so clicking a residue zooms in on it with no\nstate on the consumer's side; passing it takes that over, and a click then\nmoves the camera only once `onSelectionChange` is echoed back here.\n\nEither way the camera frames whatever the selection covers, and clearing\nit zooms back out to the default view. Residues are drawn in\nball-and-stick over the cartoon; whole chains are left as they are and the\nchains around them dim, the same as hovering a chain's name.",
|
|
98
129
|
"isRequired": false,
|
|
@@ -123,85 +154,30 @@
|
|
|
123
154
|
"isRequired": false,
|
|
124
155
|
"type": "(hiddenChains: string[]) => void"
|
|
125
156
|
},
|
|
126
|
-
"
|
|
127
|
-
"description": "
|
|
128
|
-
"isRequired": false,
|
|
129
|
-
"type": "number[]"
|
|
130
|
-
},
|
|
131
|
-
"chains": {
|
|
132
|
-
"description": "Whole chains by chainId, each standing for every residue on it. Kept as named rather than expanded into indices, so a whole-chain selection survives a round trip through a consumer's state at its original size.",
|
|
133
|
-
"isRequired": false,
|
|
134
|
-
"type": "string[]"
|
|
135
|
-
},
|
|
136
|
-
"chainId": {
|
|
137
|
-
"defaultValue": "- (required)",
|
|
138
|
-
"description": "Chain as named in the file (auth_asym_id), e.g. \"A\".",
|
|
157
|
+
"onCameraChange": {
|
|
158
|
+
"description": "Called with the camera each time it comes to rest after moving, whether a\ndrag, a zoom, a selection framing it, or a new structure fitting it. The\nstate can be handed back as `initialCamera` to restore the view.",
|
|
139
159
|
"isRequired": false,
|
|
140
|
-
"type": "
|
|
160
|
+
"type": "(camera: CameraState) => void"
|
|
141
161
|
},
|
|
142
|
-
"
|
|
143
|
-
"
|
|
144
|
-
"description": "Lowest 0-based residue index of the chain's polymer.",
|
|
162
|
+
"onStructureLoad": {
|
|
163
|
+
"description": "Called for every structure that loads, reloads included - unlike\n`onChainsChange`, which stays quiet when the chains come back the same.\nWhat a consumer tracking \"loading\" and \"ready\" states listens for.",
|
|
145
164
|
"isRequired": false,
|
|
146
|
-
"type": "
|
|
165
|
+
"type": "(info: StructureLoadInfo) => void"
|
|
147
166
|
},
|
|
148
|
-
"
|
|
149
|
-
"
|
|
150
|
-
"description": "Highest 0-based residue index of the chain's polymer.",
|
|
167
|
+
"onReady": {
|
|
168
|
+
"description": "Called with the Mol* plugin once a structure is loaded into it, and again\nfor each structure that replaces it, which is how a consumer reaches the\nplugin to draw on it or drive it directly.\n\nCalled once the viewer has drawn its own scene, and awaited before it\nstarts answering clicks and hovers, so a scene built here is in place\nbefore a click reaches it. The viewer only ever recolors, hides or\nreplaces the components it built itself, so representations added here\nare left as they were made. Not called for a structure that failed to\nload, or for a plugin the viewer disposed of first.",
|
|
151
169
|
"isRequired": false,
|
|
152
|
-
"type": "
|
|
170
|
+
"type": "(plugin: PluginUIContext, loaded: LoadedStructureInfo) => void | Promise<void>"
|
|
153
171
|
},
|
|
154
|
-
"
|
|
155
|
-
"
|
|
156
|
-
"description": "Polymer residues the chain holds.",
|
|
172
|
+
"onError": {
|
|
173
|
+
"description": "Called when creating the plugin, loading a structure, capturing an image or\ndrawing a representation fails, in place of the message the viewer would\notherwise log. A rejected `onReady` is reported as a `\"load\"` failure.\nNothing is reported for a plugin the viewer has already disposed of.",
|
|
157
174
|
"isRequired": false,
|
|
158
|
-
"type": "
|
|
175
|
+
"type": "(error: unknown, phase: ViewerErrorPhase) => void"
|
|
159
176
|
},
|
|
160
|
-
"
|
|
161
|
-
"
|
|
162
|
-
"description": "0-based residue index to value. Residues absent from the map read as 0, so they render in the neutral gray rather than at the bottom of the scale.",
|
|
177
|
+
"onDispose": {
|
|
178
|
+
"description": "Called before the viewer disposes of a plugin it handed to `onReady`,\nincluding one whose `onReady` has not finished, so that whatever was built\non it can be let go.",
|
|
163
179
|
"isRequired": false,
|
|
164
|
-
"type": "
|
|
165
|
-
},
|
|
166
|
-
"max": {
|
|
167
|
-
"defaultValue": "- (required)",
|
|
168
|
-
"description": "The value mapped to the top of the color scale.",
|
|
169
|
-
"isRequired": false,
|
|
170
|
-
"type": "number"
|
|
171
|
-
},
|
|
172
|
-
"min": {
|
|
173
|
-
"defaultValue": 0,
|
|
174
|
-
"description": "Values at or below this render in a neutral gray rather than on the scale.",
|
|
175
|
-
"isRequired": false,
|
|
176
|
-
"type": "number"
|
|
177
|
-
},
|
|
178
|
-
"colorScale": {
|
|
179
|
-
"defaultValue": "PLASMA_COLOR_SCALE",
|
|
180
|
-
"description": "Scale used to color residues and to draw the legend.",
|
|
181
|
-
"isRequired": false,
|
|
182
|
-
"type": "ColorScale"
|
|
183
|
-
},
|
|
184
|
-
"tooltip": {
|
|
185
|
-
"description": "Help tooltip title on the legend caption. A string is enough for the common case; use tooltipProps for a subtitle, a custom body, or placement. Overrides tooltipProps.title when both are set.",
|
|
186
|
-
"isRequired": false,
|
|
187
|
-
"type": "string"
|
|
188
|
-
},
|
|
189
|
-
"tooltipProps": {
|
|
190
|
-
"description": "Props forwarded to the SDS Tooltip on the legend caption. The trigger is the caption's help icon, so children is omitted.",
|
|
191
|
-
"isRequired": false,
|
|
192
|
-
"type": "Partial<Omit<TooltipProps, \"children\">>"
|
|
193
|
-
},
|
|
194
|
-
"readoutLabel": {
|
|
195
|
-
"defaultValue": "Value",
|
|
196
|
-
"description": "Label for the per-residue readout that replaces a stat slot on hover.",
|
|
197
|
-
"isRequired": false,
|
|
198
|
-
"type": "string"
|
|
199
|
-
},
|
|
200
|
-
"value": {
|
|
201
|
-
"defaultValue": "- (required)",
|
|
202
|
-
"description": "The stat's value, already formatted for display.",
|
|
203
|
-
"isRequired": false,
|
|
204
|
-
"type": "string"
|
|
180
|
+
"type": "() => void"
|
|
205
181
|
}
|
|
206
182
|
}
|
|
207
183
|
}
|