Class Segment

A Segment gives access to the data elements that form a tuple or a slot. A data provider is able to provide 'stacked' data, where each tuple or slot is mapped to multiple segments. These segments can be accessed through the 'segments' property on a tuple or slot. In many cases a visualization is only interested in the contents of the entire tuple, but in some situations the visualizations needs to display the individual tuple segment. Examples are the rendering of a hierachical view of the associated data item, or providing an alternative representation of the tuple caption.

// Returns a caption for the given tuple.
function getCaption( _tuple )
{
    // Use ', ' as a separator, instead of the default ' | '.
    return _tuple.segments.map( _segment => _segment.caption ).join( ", " );
}

Hierarchy

  • Segment

Index

Properties

Accessors

Properties

caption

caption: string

The caption of the segment.

key

key: string

A unique key value for the segment. You can use this key when you perform data binding.

Accessors

highlighted

  • get highlighted(): boolean

  • Returns true if the segment is highlighted.

    Returns boolean

selected

  • get selected(): boolean

  • Returns true if the segment is selected. Note that the visual selection state of a segment might depend on the selected state of other data elements.

    Returns boolean