Columns Reference

This page describes the various types of columns (and other related types) that can be used in configuring the display of data in Large Group Report.

Columns may be specified as a list of ColumnDefinition objects. Each ColumnDefinition has a type (matching one of the column types listed) and a set of additional properties specific to that type. The available properties for each type are documented here.

GroupName

A type of column that represents the name of the group for each row in a group-level dataset.

This column type is only applicable in group-level columns configuration. It will automatically obtain its value from the group_name field in the dataset. In addition to rendering each group's name, this column type can be used for navigating down the group hierarchy to view the data for that group.

This type supports the use of the displayNameListener() callback. Using this will replace the on-screen value for each cell in the column. The value that is passed to the callback for each row is the group_name.

{
    type: "group_name"
}

UserId

A type of column that represents the identifier or name of a user for each row in a user-level dataset.

This column type is only applicable in user-level columns configuration. It will automatically obtain its value from the user_id field in the dataset.

This type supports the use of the displayNameListener() callback. Using this will replace the on-screen value for each cell in the column. The value that is passed to the callback for each row is the user_id.

{
    type: "user_id",
    label: "Student"
}

Numeric

A type of column that represents a simple numeric value. Useful for rendering fields from the dataset containing numeric values.

{
    type: "numeric",
    field: "score",
    decimals: 2
}

1DPlot

A type of column that allows plotting a variety of graphical elements (chart components) in a cell to represent 1-dimensional values and ranges.

{
    type: "1d_plot",
    label: "Results",
    elements: [
        {
            type: "shading_plot",
            source: "ancestor_1",
            shape: "area",
            min: "lowest_percent",
            max: "highest_percent",
            class: "shading-outer-quartile"
        },
        {
            type: "score_plot",
            shape: "down_chevron",
            source: "row",
            score: "median_percent",
            label: true,
            label_y: "top"
        }
    ]
}

PlotElementDefinition Types

This section lists the types of plot elements that can be used in the 1DPlot column type.

ScaleBracket

Represents a scale bracket in a 1D-plot cell.

{
    type: "scale_bracket",
    labels: false
}

BoxPlot

Represents the box component of a box-and-whisker in a 1D-plot cell. Use the optional middle property to plot a vertical line at a given score within the box.

{
    type: "box_plot",
    source: "row",
    min: "p25_percent",
    max: "p75_percent",
    middle: "median_percent",
    labels: true
}

WhiskerPlot

Represents the whisker component of a box-and-whisker in a 1D-plot cell.

{
    type: "whisker_plot",
    source: "row",
    min: "lowest_percent",
    max: "highest_percent"
}

ShadingPlot

Represents a lightly shaded area taking the full height of a 1D-plot cell.

{
    type: "shading_plot",
    source: "ancestor_1",
    min: "p25_percent",
    max: "p75_percent",
    class: "shading-inner-quartile"
}

LinePlot

Represents a vertical line taking the full height of a 1D-plot cell.

{
    type: "line_plot",
    source: "ancestor_1",
    score: "median_percent",
    class: "shading-reference-percentile",
    label: false
}

ScorePlot

Represents a point (defined by a numeric score) along the plane of a 1D-plot cell.

Example of ScorePlot using a score parameter.

{
    type: "score_plot",
    source: "row",
    score: "median_percent",
    shape: "down_chevron",
    class: "reference-percentile-marker",
    label_y: "top"
}

A second example using percent to plot a user's score as a percentage of the maximum score.

{
    type: "score_plot",
    source: "row",
    percent: ["score", "max_score"],
    shape: "circle",
    class: "score-marker",
    label_y: "top"
}

Other Types

This section lists other important type definitions that occur commonly throughout columns configurations.

GroupField

The name of a raw data field that exists in the group-level data of the report dataset.

This type is used by plot elements to reference specific group data values in the dataset (e.g. mean_score, stddev_percent) from a given data source.

// The score property in the object below specifies a sample GroupField
// "median_percent" as its value:
{
    type: "score_plot",
    source: "ancestor_1",
    score: "median_percent"
}

UserField

The name of a raw data field that exists in the user-level data of the report dataset.

This type is used by plot elements to reference specific user data values in the dataset (e.g. score, max_score) from a given data source.

// The score property in the object below specifies a sample UserField
// "max_score" as its value:
{
    type: "line_plot",
    source: "row",
    score: "max_score"
}

ElementSource

Enumerated string value, used to identify which data source should supply the score values for a plot element.

Valid ElementSource values are "row", "parent", or "ancestor_n".

• row: retrieve score values from this row's data (ie. the group data represented by this row, or the student scores represented by this row).
• parent: retrieve score values from the parent group of this row.
• ancestor_n: retrieve score values from the nominated ancestor row n, where 0 represents the root group of the aggregate report.

// The source property in the object below specifies an ElementSource of
// "row", meaning that the data should come from the current row:
{
    type: "score_plot",
    source: "row"
}