MAIDR JavaScript API
    Preparing search index...

    Interface ChartObjectList

    Everything a trace offers the object list.

    interface ChartObjectList {
        title: string;
        count: (count: number) => string;
        objects: readonly ChartObject[];
        measures: readonly ObjectMeasure[];
        sorts: readonly ObjectSortOption[];
        filters: readonly ObjectFilterOption[];
        deferred?: Readonly<Record<string, () => readonly number[]>>;
    }
    Index

    Properties

    title count objects measures sorts filters deferred?

    Properties

    title: string

    What the objects are, as a heading: "Nodes".

    count: (count: number) => string

    How many there are, in words: "1 node", "42 nodes". A function rather than a noun to put after a number, because a noun cannot be: English has a singular, German capitalises, and Korean, Japanese and Chinese count with a counter word.

    objects: readonly ChartObject[]

    Every object, in the chart's own order.

    measures: readonly ObjectMeasure[]

    The numbers the sorts below order by.

    sorts: readonly ObjectSortOption[]

    The sorts that make sense on this chart. The first is the default.

    filters: readonly ObjectFilterOption[]

    The filters that make sense on this chart, in the order they are stepped through. Showing everything is implicit and not listed, and a filter that would match nothing, or everything, is not offered.

    deferred?: Readonly<Record<string, () => readonly number[]>>

    Measures too costly to work out until a sort asks for them, by measure id: each gives one value per object, in the order of objects. A graph's centrality is the case -- a walk from every node, which the reader should pay for only when they choose to sort by it, not on every o.

    Settings

    Member Visibility

    On This Page

    Properties