MetricDefinition object

[This documentation is preliminary and is subject to change.]

Information that fully describes an assessment metric. Metrics are defined by the author of the assessment manifest. The MetricDefinitions element is a collection of MetricDefinition elements.

  • Properties

Properties

The MetricDefinition object has the following properties.

Property Access type Description

BetterDirection

Read-only

Describes which sense of relative change in the metric is to be considered improvement. The possible values are None, HigherIsBetter, and LowerIsBetter. Received from the BetterDirection element in the assessment manifest.

Description

Read-only

Descriptive information for the metric received from the assessment manifest.

The values of the following sub-elements of the Description element provide the information describing the metric:

Name provides the localized human-readable name. ProgrammaticName provides the non-localized programmatic name that can be used by applications. ToolTip provides the localized human-readable short description. Tags provides a collection of Tag elements. This field may be empty. Categories provides a collection of Category elements. This collection may be empty. Details provides a rich documentation as a RTF stream. This stream may have zero length (be empty.)

MetricThreshold

Read-only

Describes how to interpret a metric value. Received from the assessment manifest. MetricThresholds is a collection of MetricThreshold elements.

PrimaryDescriptiveStatistic

Read-only

Describes the primary descriptive statistic for the metric recommended by the assessment author. It can have exactly one of the values: Mean or Median. Received from the PrimaryStatistic element in the assessment manifest.

Relationships

Read-only

Collection of MetricRelationship objects. These object define relationships between metrics. The PartOfWhole and PartOfDetailelements comprise a list of metrics that make up this metric.

SecondaryDescriptiveStatistic

Read-only

Describes the secondary descriptive statistics for the metric recommended by the assessment author. It can have one or more of the values: None, Mean, Median, LowerQuartile, UpperQuartile, Minimum, Maximum, and StandardDeviation. Received from the SecondaryStatistic element in the assessment manifest.

Type

Read-only

Type for the metric. Received from the Type element in the assessment manifest.

Units

Read-only

Units for the metric value. Received from the Units element in the assessment manifest.

 

 

 

Build date: 9/6/2011