SheetXL - v1.0.2
    Preparing search index...

    Interface RangeAnnotationLayerProps

    interface RangeAnnotationLayerProps {
        className?: string;
        dimOpacity?: number;
        filter?: (annotation: RangeAnnotation) => boolean;
        onBlur?: (event: FocusEvent) => void;
        onContextMenu?: (event: MouseEvent) => void;
        onDoubleClick?: (event: MouseEvent) => void;
        onFocus?: (event: FocusEvent) => void;
        onKeyDown?: (event: KeyboardEvent) => void;
        onKeyPress?: (event: KeyboardEvent) => void;
        onKeyUp?: (event: KeyboardEvent) => void;
        onMouseDown?: (event: MouseEvent) => void;
        onMouseEnter?: (event: MouseEvent) => void;
        onMouseLeave?: (event: MouseEvent) => void;
        onMouseMove?: (event: MouseEvent) => void;
        onMouseOut?: (event: MouseEvent) => void;
        onMouseOver?: (event: MouseEvent) => void;
        onMouseUp?: (event: MouseEvent) => void;
        onPointerDown?: (event: PointerEvent) => void;
        onPointerLeave?: (event: PointerEvent) => void;
        onPointerMove?: (event: PointerEvent) => void;
        onPointerUp?: (event: PointerEvent) => void;
        renderChip?: (props: RangeAnnotationChipProps) => ReactNode;
        renderMarker?: (props: RangeAnnotationChipProps) => ReactNode;
        sheet?: IWorksheet;
        showChip?: (annotation: RangeAnnotation) => boolean;
        style?: CSSProperties;
        styles?: Readonly<Record<string, RangeAnnotationStyle>>;
        zIndex?: number;
    }

    Hierarchy

    • Omit<LayerProps, "children">
      • RangeAnnotationLayerProps
    Index
    className? dimOpacity? filter? onBlur? onContextMenu? onDoubleClick? onFocus? onKeyDown? onKeyPress? onKeyUp? onMouseDown? onMouseEnter? onMouseLeave? onMouseMove? onMouseOut? onMouseOver? onMouseUp? onPointerDown? onPointerLeave? onPointerMove? onPointerUp? renderChip? renderMarker? sheet? showChip? style? styles? zIndex?
    className?: string

    Class for the layer's boundary div (devtools identification).

    dimOpacity?: number

    How much a box that is not the navigator's current one fades. Boxes only — never tags.

    0.45
    filter?: (annotation: RangeAnnotation) => boolean

    Which of the workbook's annotations this layer draws: boxes, tags and the tags' grouping alike. A feature that writes annotations draws its own, so it passes a test on its source. An annotation this layer leaves out is still in the store and the navigator, and another layer can draw it. Escape and a press on the grid close the open card whichever layer drew it.

    every annotation
    onBlur?: (event: FocusEvent) => void
    onContextMenu?: (event: MouseEvent) => void
    onDoubleClick?: (event: MouseEvent) => void
    onFocus?: (event: FocusEvent) => void
    onKeyDown?: (event: KeyboardEvent) => void
    onKeyPress?: (event: KeyboardEvent) => void
    onKeyUp?: (event: KeyboardEvent) => void
    onMouseDown?: (event: MouseEvent) => void
    onMouseEnter?: (event: MouseEvent) => void
    onMouseLeave?: (event: MouseEvent) => void
    onMouseMove?: (event: MouseEvent) => void
    onMouseOut?: (event: MouseEvent) => void
    onMouseOver?: (event: MouseEvent) => void
    onMouseUp?: (event: MouseEvent) => void
    onPointerDown?: (event: PointerEvent) => void
    onPointerLeave?: (event: PointerEvent) => void
    onPointerMove?: (event: PointerEvent) => void
    onPointerUp?: (event: PointerEvent) => void
    renderChip?: (props: RangeAnnotationChipProps) => ReactNode

    Render the tag beside an annotation that is in view. Omit for RangeAnnotationTag.

    renderMarker?: (props: RangeAnnotationChipProps) => ReactNode

    Render the marker that stands in for a tag whose range is scrolled out of view. Omit for RangeAnnotationTag, which turns its pointer toward the range.

    sheet?: IWorksheet

    The sheet whose annotations are drawn.

    the sheet in context (an injected layer needs none)
    showChip?: (annotation: RangeAnnotation) => boolean

    Whether an annotation gets a tag (and, scrolled off, a marker) or is drawn as its box alone — for a host that shows some annotations elsewhere (an agent's cursor, in its own status control).

    every walked annotation, and a working one only when it has a label

    style?: CSSProperties

    Style for the layer's boundary div — e.g. display: 'none' or opacity to hide or fade a layer. The boundary's own placement (position, inset, pointer-events: none) comes from the grid; overriding it here breaks the layer's containment.

    styles?: Readonly<Record<string, RangeAnnotationStyle>>

    Per-intent look. Merged over DEFAULT_ANNOTATION_STYLES.

    zIndex?: number

    Explicit stacking override, read by normalizeLayers off the grid-child element to sort the layer list (higher sorts later = on top; omitted ⇒ declaration order). It is honored ONLY at the grid-children level — the layer's actual dispatch slot always comes from the resulting order index (via LayerOrderContext), never from this raw number, so paint order and event order can never disagree.

    Settings
    Member Visibility

    On This Page
    Properties