SheetXL - v1.0.2
    Preparing search index...

    Interface RangeAnnotationChipProps

    What a tag (in view, or waiting at an edge) is rendered from.

    interface RangeAnnotationChipProps {
        address: string;
        annotation: RangeAnnotation;
        cornerOff: boolean;
        isCurrent: boolean;
        isHovered: boolean;
        more: number;
        onCardSize?: (width: number, height: number) => void;
        position: number;
        side: "left" | "right";
        state: StickyState;
        style: RangeAnnotationStyle;
        total: number;
        toward?: GridFloatSide | null;
        workbook: IWorkbook;
    }
    Index
    address annotation cornerOff isCurrent isHovered more onCardSize? position side state style total toward? workbook
    address: string

    The range's address on its sheet (C8:D8), unqualified.

    annotation: RangeAnnotation

    The annotation the tag stands for — the current one of its group when it is among them.

    cornerOff: boolean

    The tag does not stand on a corner: the range has no corner in view (it runs past both ends of an axis) or is out of view altogether.

    isCurrent: boolean
    isHovered: boolean

    Under the pointer — here, or in a host's list of the same annotations.

    more: number

    Others sharing this tag's anchor cell.

    onCardSize?: (width: number, height: number) => void

    Reports the open card's size, which the layer uses to choose where the tag stands.

    position: number

    1-based position in the walked list; 0 for a working annotation.

    side: "left" | "right"

    Which way the tag stands off the corner it points at — always outward, off the range's cells: left of a left corner, right of a right one. Top or bottom is the float's placement.

    state: StickyState

    The float's resolved state (slid, outOfView, scrollIntoView, …).

    style: RangeAnnotationStyle
    total: number

    How many are walked.

    toward?: GridFloatSide | null

    When the tag stands on a visible edge of a range with no corner in view: which way the range lies from it. null on a corner, and for the marker of a range out of view.

    workbook: IWorkbook

    Settings
    Member Visibility

    On This Page
    Properties