MAIDR JavaScript API
    Preparing search index...

    Interface ExtremaTarget

    Represents a single extrema target that can be navigated to

    interface ExtremaTarget {
        label: string;
        value: number;
        pointIndex: number;
        segment: string;
        type: "min" | "max" | "intersection";
        intersectionKind?: "point" | "slope";
        groupIndex?: number;
        categoryIndex?: number;
        navigationType: "point" | "group";
        xValue?: string | number;
        intersectingLines?: number[];
        display?: {
            name?: string;
            x?: string;
            y?: string;
            coords?: string;
            otherLines?: string;
        };
    }
    Index

    Properties

    label value pointIndex segment type intersectionKind? groupIndex? categoryIndex? navigationType xValue? intersectingLines? display?

    Properties

    label: string

    Human-readable label for the extrema (e.g., "Max Open", "Min Volatility")

    value: number

    The actual numeric value of the extrema

    pointIndex: number

    Index of the point to navigate to

    segment: string

    Identifier for the segment/group this extrema belongs to

    type: "min" | "max" | "intersection"

    Type of extrema - maximum, minimum, or intersection

    intersectionKind?: "point" | "slope"

    Classification for intersection targets

    groupIndex?: number

    Index of the group this extrema belongs to (for group-based plots)

    categoryIndex?: number

    Index of the category within the group (for group-based plots)

    navigationType: "point" | "group"

    Type of navigation this extrema requires

    xValue?: string | number

    Raw x-axis value for formatting (e.g., timestamp before date conversion)

    intersectingLines?: number[]

    For intersection targets: indices of all lines that intersect at this point Used for multiline plots to track which lines are involved in the intersection

    display?: {
        name?: string;
        x?: string;
        y?: string;
        coords?: string;
        otherLines?: string;
    }

    The parts the Go To dialog composes its line from, so that no consumer has to parse label — a sentence whose word order is the language's.

    Type Declaration

    • Optionalname?: string

      The extremum without its position, translated: "Max Bar", "Row Maximum"

    • Optionalx?: string

      The x value, or category, as label speaks it. The view model swaps in the layer's formatted form when this is xValue written out.

    • Optionaly?: string

      The row a grid cell is on, spoken after x

    • Optionalcoords?: string

      Pre-formatted coordinates string (e.g., "x=1.50, y=2.50")

    • OptionalotherLines?: string

      Names of other lines involved (for intersections, excludes current line)

    Settings

    Member Visibility

    On This Page

    Properties