d2l-insights-tiles v1.14.1

insights-tiles

Overview

This library contains the React components for the tiles. Currently being used in insights-class-insights.

Version Handling

This repository is part of Orcavenger's CI pipeline. On merge to master the minor version will increment automatically, and tagged for release. If you want to increment the major version write increment major in the box provided when merging. If you want to increment the patch version write increment patch in the box provided when merging. There is no need for a developer to manually update this module's version.

Usage

Inactive Aggregation Tile Engagement

Use this tile to display the number of student have have not accessed the course in the past 7 days in an aggregation tile. You can find an example usage at insights-class-insights.

<NumberOfInactiveStudentsTile
      data={classroomData}
      filteredData={classroomData}
      filters={[f1, f2, ... fn]}
      context={{timezone: 'someTimezone'}} />
      setFilter={function(name, filter) {//do something}}
      removeFilter={function(filterName) {//do something}}

Computing Aggregation Tile

Use this tile to configure an aggregation tile that will display some value and description that is computed by the dataset it is given. You are responsible for ensuring the functions for computing the value, description.

 <ComputingAggregationTile
    click={onclickFunction()}
    computeDescription={computingDescriptionFunction(computedValue, data, computedMetaValue, metaData)}
    computeDisability={this.computingDisabilityFunction(computedValue, data, computedMetaValue, metaData)}
    computeMetaValue={computingMetaValueFunction(metaData)}
    computeValue={computingValueFunction(data, computedMetaValue, metaData)}
    data={yourDataset}
    metaData={yourDataset} />

Aggregation Tile

Use this tile if you already know the final value for your aggregation and the associated description.

 <AggregationTile
     data={{value: expectedValue, description: expectedDescription}}
     disabled={true/false}
     click={expectedClick}
     selected={true/false}
     freezeOnZero={true/false} />

Grade Distribution Tile

<GradeDistributionTile
      data={students:[array of student data]}
      filteredData={students:[array of filtered student data]}
      langTerms={Object containing lang terms}
      setFilter={setFilterCallback}
      removeFilter={removeFilterCallback}
      filters={KVP object of current filters}
      />

##Example Student Object:

{
    "firstName": "string", //User's first name
    "lastName": "string", //User's last name
    "studentId": "string", //User's username (Login name)
    "studentNumber": "string", //User's Org Defined ID
    "userId": "int", //User's D2LID (duplicate)
    "key": "int", //User's D2LID
    "currentGrade": "int", //Aggregated value that represents the users current grade
    "lastCourseAccess": "Moment.js object with LE timezone",
    "predictedGrade": "int", //Aggregated value that predicts the user's final grade (via S3)
    "threadsStarted": "int", //Aggregated count of threads the user has started
    "postsRepliedTo": "int", //Aggregated count of posts the user has replied to
    "fullName": "string", //full name of the student
    "discussions": "int" //value that represents the sort
}