@univerjs/sheets-ui/lib/types/services/selection/selection-render-model.d.ts

Spreadsheet UI layer for Univer Sheets.

/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { ICellWithCoord, IRangeWithCoord, Nullable } from '@univerjs/core';
import type { ISelectionWithCoord } from '@univerjs/sheets';
import { RANGE_TYPE } from '@univerjs/core';
/**
 * Data model for SelectionControl.model
 * NOT Same as @univerjs/sheet.WorkbookSelectionModel, that's data model for Workbook
 */
export declare class SelectionRenderModel implements IRangeWithCoord {
    private _startColumn;
    private _startRow;
    private _endColumn;
    private _endRow;
    private _startX;
    private _startY;
    private _endX;
    private _endY;
    /**
     * The highlight cell of a selection. aka: current cell
     */
    private _primary;
    private _rangeType;
    constructor();
    get startColumn(): number;
    get startRow(): number;
    get endColumn(): number;
    get endRow(): number;
    get startX(): number;
    get startY(): number;
    get endX(): number;
    get endY(): number;
    get currentCell(): Nullable<ICellWithCoord>;
    get rangeType(): RANGE_TYPE;
    /**
     * @deprecated, Duplicate with `Rectangle`
     */
    isEqual(rangeWithCoord: IRangeWithCoord): boolean;
    highlightToSelection(): Nullable<IRangeWithCoord>;
    getRange(): IRangeWithCoord;
    getCell(): Nullable<ICellWithCoord>;
    getRangeType(): RANGE_TYPE;
    setRangeType(rangeType: RANGE_TYPE): void;
    getValue(): ISelectionWithCoord;
    setValue(newSelectionRange: IRangeWithCoord, currentCell: Nullable<ICellWithCoord>): void;
    /**
     * Set primary cell.
     * @TODO lumixraku there are 3 concepts for same thing, primary and current and highlight
     * highlight is best. primary sometimes means the actual cell(actual means ignore merge)
     * @param currentCell
     */
    setCurrentCell(currentCell: Nullable<ICellWithCoord>): void;
    clearCurrentCell(): void;
}