Merge pull request #235 from datavisyn/keckelt/comments

Comments for ARankingView

src/extensions.ts

@@ -164,7 +164,7 @@ export interface IViewGroupExtensionDesc extends IPluginDesc {
 
 
 export interface ISelection {
-  readonly idtype: IDType;
+  readonly idtype: IDType; // see phovea_core/src/idtype/manager#resolve
   readonly range: Range;
 
   /**
@@ -175,7 +175,7 @@ export interface ISelection {
 
 export interface IViewContext {
   readonly graph: ProvenanceGraph;
-  readonly desc: IViewPluginDesc;
+  readonly desc: IViewPluginDesc; // see tdp_core/src/views/interfaces#toViewPluginDesc and phovea_core/src/plugin#get
   readonly ref: IObjectRef<any>;
 }
 

src/lineup/ARankingView.ts

@@ -91,6 +91,7 @@ export interface IARankingViewOptions {
 
 /**
  * base class for views based on LineUp
+ * There is also AEmbeddedRanking to display simple rankings with LineUp.
  */
 export abstract class ARankingView extends AView {
 
@@ -158,6 +159,17 @@ export abstract class ARankingView extends AView {
 
   private readonly selectionAdapter: ISelectionAdapter | null;
 
+  /**
+   * Creates a RankingView with the given selection.
+   * Can be wrapped with a ViewWrapper.
+   *
+   * @remarks You need to call init() to actually display the Ranking View.
+   *
+   * @param context with provenance graph to store the executed operations
+   * @param selection The Ids and IdType of the selection
+   * @param parent where to put the ranking view
+   * @param options to configure the ranking view
+   */
   constructor(context: IViewContext, selection: ISelection, parent: HTMLElement, options: Partial<IARankingViewOptions> = {}) {
     super(context, selection, parent);
 
@@ -247,6 +259,10 @@ export abstract class ARankingView extends AView {
     this.selectionAdapter = this.createSelectionAdapter();
   }
 
+  /**
+   * @param params Seperate element that displays the "Showing x of y ..." message
+   * @param onParameterChange eventlistener for content changes
+   */
   init(params: HTMLElement, onParameterChange: (name: string, value: any, previousValue: any) => Promise<any>) {
     return super.init(params, onParameterChange).then(() => {
       // inject stats