From d074415a260002872b2d7b2abcdf6a8573162af4 Mon Sep 17 00:00:00 2001
From: Alexander Rose <alex.rose@rcsb.org>
Date: Wed, 25 Sep 2019 11:55:00 -0700
Subject: [PATCH] added more param docs
---
src/mol-canvas3d/controls/trackball.ts | 2 +-
src/mol-gl/renderer.ts | 2 +-
src/mol-plugin/ui/structure/representation.tsx | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/mol-canvas3d/controls/trackball.ts b/src/mol-canvas3d/controls/trackball.ts
index 3fd77fb7f..f1f3ffcfd 100644
--- a/src/mol-canvas3d/controls/trackball.ts
+++ b/src/mol-canvas3d/controls/trackball.ts
@@ -40,7 +40,7 @@ export const TrackballControlsParams = {
zoomSpeed: PD.Numeric(6.0, { min: 0.1, max: 10, step: 0.1 }),
panSpeed: PD.Numeric(0.8, { min: 0.1, max: 5, step: 0.1 }),
- spin: PD.Boolean(false),
+ spin: PD.Boolean(false, { description: 'Spin the 3D scene around the x-axis in view space' }),
spinSpeed: PD.Numeric(1, { min: -100, max: 100, step: 1 }),
staticMoving: PD.Boolean(true, { isHidden: true }),
diff --git a/src/mol-gl/renderer.ts b/src/mol-gl/renderer.ts
index e661ad686..a4ba67c88 100644
--- a/src/mol-gl/renderer.ts
+++ b/src/mol-gl/renderer.ts
@@ -45,7 +45,7 @@ interface Renderer {
}
export const RendererParams = {
- backgroundColor: PD.Color(Color(0x000000)),
+ backgroundColor: PD.Color(Color(0x000000), { description: 'Background color of the 3D canvas' }),
pickingAlphaThreshold: PD.Numeric(0.5, { min: 0.0, max: 1.0, step: 0.01 }, { description: 'The minimum opacity value needed for an object to be pickable.' }),
interiorDarkening: PD.Numeric(0.5, { min: 0.0, max: 1.0, step: 0.01 }),
diff --git a/src/mol-plugin/ui/structure/representation.tsx b/src/mol-plugin/ui/structure/representation.tsx
index cbbb6e33d..848270313 100644
--- a/src/mol-plugin/ui/structure/representation.tsx
+++ b/src/mol-plugin/ui/structure/representation.tsx
@@ -106,8 +106,8 @@ export class StructureRepresentationControls extends CollapsableControls {
const { options } = this.values
return {
options: PD.Group({
- showHydrogens: PD.Boolean(options.showHydrogens),
- visualQuality: PD.Select<VisualQuality>(options.visualQuality, VisualQualityOptions),
+ showHydrogens: PD.Boolean(options.showHydrogens, { description: 'Toggle display of hydrogen atoms in representations' }),
+ visualQuality: PD.Select<VisualQuality>(options.visualQuality, VisualQualityOptions, { description: 'Control the visual/rendering quality of representations' }),
}, { isExpanded: true })
}
}
--
GitLab