About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface DataViewRow

Represents a row of data in a DataView. Each row can be thought of as a data point that the mod visualization renders.

interface DataViewRow {
    categorical(axisName: string): DataViewCategoricalValue;
    color(): DataViewColorInfo;
    continuous<T extends DataViewValueType>(
        axisName: string,
    ): DataViewContinuousValue<T>;
    elementId(useStableId?: boolean, omitAxisNames?: string[]): string;
    isMarked(): boolean;
    leafNode(axisName: string): null | DataViewHierarchyNode;
    mark(operation?: MarkingOperation): void;
}

Index

Methods

categorical color continuous elementId isMarked leafNode mark

Methods

categorical

categorical(axisName: string): DataViewCategoricalValue
Gets a DataViewCategoricalValue representing the value of the axis with the specified axisName. This method will throw an error if there is no categorical axis by that name or if the expression is empty. Use DataView.categoricalAxis to check the current existence of a categorical value.
Parameters
- axisName: string
  The name of the axis to get the value for.
Returns DataViewCategoricalValue

color

color(): DataViewColorInfo
Gets the DataViewColorInfo for the row, if a color axis is defined in the mod manifest. The underlying data value can be retrieved by using DataViewRow.categorical("Color") or DataViewRow.continuous("Color"), depending on the mode of the color axis.

Returns DataViewColorInfo

continuous

continuous<T extends DataViewValueType>(
axisName: string,
): DataViewContinuousValue<T>
Gets a DataViewContinuousValue representing the value of the axis with the specified axisName. This method will throw an error if there is no continuous axis by that name or if the expression is empty. Use DataView.continuousAxis to check the current existence of a continuous value.
Type Parameters
- T extends DataViewValueType
Parameters
- axisName: string
  The name of the axis to get the value for.
Returns DataViewContinuousValue<T>

elementId

elementId(useStableId?: boolean, omitAxisNames?: string[]): string
Calculates an element id for this row, suitable for identifying rows between data views. When stable identifiers is not used, only rows in immediately following data view are guaranteed to re-use previous id. If a row is filtered out in a new data view, this row is thus not guaranteed to yield the same id when it re-appears.
Parameters
- OptionaluseStableId: boolean
  When true, the id will be a (longer) stable id guarranteed to be the same over time.
- OptionalomitAxisNames: string[]
  Axis names to omit when creating the identifier. Can be used to group multiple elements split by these axes, for example to create animation effects in one data view.
Returns string
Note
A stable element id is only stable in the current session, thus it should not be stored in the document, e.g. as a ModProperty or AnalysisProperty.

Version
1.1

isMarked

isMarked(): boolean
Gets a value indicating whether this row is marked.

Returns boolean

leafNode

leafNode(axisName: string): null | DataViewHierarchyNode
Gets the leaf DataViewHierarchyNode for the specified axis, or null for dual mode axes with continuous axis expression. This method will throw an error for continuous mode axes or if there is no axis by that name.
Parameters
- axisName: string
  The name of the axis
Returns null | DataViewHierarchyNode
Version
1.1

mark

mark(operation?: MarkingOperation): void
Performs the specified marking operation in the current marking.

Note All mark operations within one Mod.transaction must have the same MarkingOperation.

See DataView.mark for more details.
Parameters
- Optionaloperation: MarkingOperation
  Optional MarkingOperation. Default value is Replace.
Returns void