@sjcrh/proteinpaint-types 2.79.7-1 → 2.80.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjcrh/proteinpaint-types",
-  "version": "2.79.7-1",
+  "version": "2.80.0",
   "type": "module",
   "description": "Shared type definitions between ProteinPaint server and client code",
   "main": "src/index.ts",

package/src/dataset.ts

@@ -690,6 +690,9 @@ type SelectCohortEntry = {
 	values: SelectCohortValuesEntry[]
 	description?: string
 	asterisk?: string
+	//The profile has clearOnChange. The terms used in the plots are not always the same for the profile.
+	//Therefore when switching cohorts, it is necessary to delete the plots opened and the global filter
+	clearOnChange?: { [index: string]: boolean }
 }
 
 type MissingAccess = {
@@ -939,9 +942,8 @@ type Termdb = {
 	dataDownloadCatch?: DataDownloadCatch
 	helpPages?: URLEntry[]
 	multipleTestingCorrection?: MultipleTestingCorrection
-	/** regression settings for neuro-oncology portals:
+	/** regression settings for neuro-oncology datasets:
 	- no interaction terms
-	- report event counts of cox coefficients
 	- hide type III stats and miscellaneous statistical tests */
 	neuroOncRegression?: boolean
 	urlTemplates?: {
@@ -990,21 +992,6 @@ type Termdb = {
 	/** in development!
 	 * Supports the About tab in mass UI
 	 */
-	about?: {
-		/** Customization for the tab */
-		tab?: {
-			/** show in a specific order of tabs */
-			order?: number
-			/** label appearing in the top row in upper case */
-			topLabel?: string
-			/** biggest label appearing in the middle row in upper case */
-			midLabel?: string
-			/** label appearing in the bottom row*/
-			btmLabel?: string
-		}
-		/** html code */
-		html: string
-	}
 	hasSampleAncestry?: boolean
 	sampleTypes?: SampleType[]
 
@@ -1086,20 +1073,7 @@ type AssayAvailability = {
 
 //Shared with genome.ts
 export type Cohort = {
-	hideGroupsTab?: boolean
-	tabs?: { [index: string]: string } //Customizes tab top label
-	/** customize the default chart to open on mass ui when there's no charts. if missing it opens dictionary ui */
-	defaultChartType?: string
 	allowedChartTypes?: string[]
-	hiddenChartTypes?: string[]
-	renamedChartTypes?: { singleCellPlot?: string; sampleScatter?: string }
-	mutationset?: MutationSet[]
-	db: FileObj
-	termdb: Termdb
-	scatterplots?: Scatterplots
-	matrixplots?: MatrixPlots
-	/** optional title of this ds, if missing use ds.label. shown on mass nav header. use blank string to not to show a label*/
-	title?: Title
 	cumburden?: {
 		files: {
 			fit: string
@@ -1107,6 +1081,43 @@ export type Cohort = {
 			sample: string
 		}
 	}
+	db: FileObj
+	/** customize the default chart to open on mass ui when there's no charts. if missing it opens dictionary ui */
+	defaultChartType?: string
+	hiddenChartTypes?: string[]
+	massNav?: MassNav
+	matrixplots?: MatrixPlots
+	mutationset?: MutationSet[]
+	renamedChartTypes?: { singleCellPlot?: string; sampleScatter?: string }
+	scatterplots?: Scatterplots
+	termdb: Termdb
+}
+
+/** Customizations specific to the mass nav component */
+type MassNav = {
+	/** optional title of this ds, if missing use ds.label. shown on mass nav header.
+	 * use blank string to not to show a label*/
+	title?: Title
+	/** Customization for the tabs*/
+	tabs?: {
+		/** about, charts, groups, and fitler */
+		[index: string]: {
+			/** show in a specific order of tabs */
+			order?: number
+			/** label appearing in the top row in upper case */
+			top?: string
+			/** biggest label appearing in the middle row in upper case */
+			mid?: string
+			/** label appearing in the bottom row*/
+			btm?: string
+			/** if true, does not show the tab */
+			hide?: boolean
+			/** html code, specifically for the about tab
+			 * maybe used for other tabs as well.
+			 */
+			html?: string
+		}
+	}
 }
 
 type Title = {

package/src/termsetting.ts

@@ -43,6 +43,10 @@ export type NoTermPromptOptsEntry = {
 	text?: string
 	html?: string
 	q?: Q
+	/** whether or not opt is invalid */
+	invalid?: boolean
+	/** message displayed when opt is invalid */
+	invalidMsg?: string
 }
 
 type NumericContEditOptsEntry = {