SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IMetrics

    The measurements of a header at one moment, from ISheetHeader.getMetrics. Sizes are in pixels: the native size of each header multiplied by the scale factor. A hidden header measures 0.

    interface IMetrics {
        getDefaultSize(): number;
        getIndex(offset: number): number;
        getOffset(index: number): number;
        getScaleFactor(): number;
        getSpanSize(indexFrom: number, indexTo?: number): number;
        getVisibleCount(indexFrom: number, indexTo: number): number;
        getVisibleIndex(index: number): Readonly<RunCoords>;
        hasHidden(): boolean;
        hiddenHeadersAt(index: number, reverse?: boolean): number;
    }
    Index
    getDefaultSize getIndex getOffset getScaleFactor getSpanSize getVisibleCount getVisibleIndex hasHidden hiddenHeadersAt

    • The default header size in pixels, for a header that has not been sized.

      Returns number

    • Returns the index for the given header offset in pixels.

      Parameters

      • offset: number

        0-based pixels.

      Returns number

    • Returns the offset in pixels for the given header index.

      Parameters

      • index: number

        0-based absolute index.

      Returns number

    • The factor that converts native header sizes to pixels.

      Returns number

    • Returns the size in pixels of the header at indexFrom, or of the headers from indexFrom up to (not including) indexTo.

      Parameters

      • indexFrom: number

        0-based absolute index.

      • OptionalindexTo: number

        0-based absolute index, not less than indexFrom. Defaults to indexFrom + 1.

      Returns number

    • Returns the number of visible headers from indexFrom to indexTo, inclusive.

      Parameters

      • indexFrom: number

        0-based absolute index.

      • indexTo: number

        0-based absolute index, not less than indexFrom.

      Returns number

    • Returns the visible run around an absolute index.

      • If it's hidden it will return a range of 1 with a value before the offset and after.
      • If it's visible then it will return a range of 0 with the min and max that exactly match the offset.

      Parameters

      • index: number

        0-based absolute index.

      Returns Readonly<RunCoords>

      A RunCoords that can be used to determine if an index is hidden.

      If this is on the edge of the bounds this will return a +/- 1 the max bounds.

    • Returns true if any header is hidden or has a size of 0.

      Returns boolean

    • Returns how many hidden headers run on from index: 0 if index is visible, 1 if only it is hidden. Lets a caller skip a hidden run instead of stepping through it.

      Parameters

      • index: number

        The location to start from.

      • Optionalreverse: boolean

        Count backwards instead. Defaults to false.

      Returns number

    Settings
    Member Visibility

    On This Page
    Methods