跳到主要内容

MultiSelectEditor

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:36

VTable 自定义多选编辑器

弹出浮层显示 checkbox 列表,支持 toggle 多选;禁用的选项不可勾选。 结束编辑时以选中 id 列表(逗号分隔)写回单元格,并通过 onCommit 回调给出 id 数组。 未显式传入初始选中时,从单元格 origin 值读取。

Extends​

Constructors​

Constructor​

new MultiSelectEditor(
options,
selectedIds?,
onCommit?
): MultiSelectEditor;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:60

创建多选编辑器

Parameters​

ParameterTypeDescription
optionsMultiSelectOption[]全部可选项
selectedIds?string[] | null初始选中的选项 ID;不传(null / undefined)时从单元格 origin 值读取
onCommit?(ids) => void结束编辑时的提交回调,收到当前选中的 ID 列表

Returns​

MultiSelectEditor

Overrides​

GlobalOverlayEditor.constructor

Properties​

container​

protected container: HTMLElement | null = null;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:99

Inherited from​

GlobalOverlayEditor.container


editCol​

protected editCol: number = 0;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:101

Inherited from​

GlobalOverlayEditor.editCol


editorType​

readonly editorType: "multiselect-editor" = 'multiselect-editor';

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:51

VTable 编辑器类型标识(注册到 VTable 的编辑器名)

Overrides​

GlobalOverlayEditor.editorType


editRow​

protected editRow: number = 0;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:102

Inherited from​

GlobalOverlayEditor.editRow


table​

protected table:
| {
getCellOriginValue: unknown;
}
| null = null;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:100

Inherited from​

GlobalOverlayEditor.table

Accessors​

focusedIndex​

Get Signature​

get protected focusedIndex(): number;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:107

Returns​

number

Inherited from​

GlobalOverlayEditor.focusedIndex


initialFocusIndex​

Get Signature​

get protected initialFocusIndex(): number;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:42

Returns​

number

Overrides​

GlobalOverlayEditor.initialFocusIndex


itemCount​

Get Signature​

get protected itemCount(): number;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:46

Returns​

number

Overrides​

GlobalOverlayEditor.itemCount

Methods​

adjustPosition()​

adjustPosition(rect): void;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:207

根据新的单元格矩形重新定位浮层面板

Parameters​

ParameterType
rectRectProps

Returns​

void

Inherited from​

GlobalOverlayEditor.adjustPosition


buildRows()​

protected buildRows(panel): void;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:90

Parameters​

ParameterType
panelHTMLDivElement

Returns​

void

Overrides​

GlobalOverlayEditor.buildRows


close()​

protected close(): void;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:230

Returns​

void

Inherited from​

GlobalOverlayEditor.close


getValue()​

getValue(): string;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:86

返回当前选中选项的 id,以逗号加空格拼接(存储值口径,非显示名)

Returns​

string

Overrides​

GlobalOverlayEditor.getValue


isEditorElement()​

isEditorElement(target): boolean;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:202

判断目标元素是否属于浮层面板

Parameters​

ParameterType
targetHTMLElement

Returns​

boolean

Inherited from​

GlobalOverlayEditor.isEditorElement


onDeleteKey()​

protected onDeleteKey(): void;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:226

Returns​

void

Inherited from​

GlobalOverlayEditor.onDeleteKey


onEnd()​

onEnd(): void;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:80

结束编辑时以当前选中的 ID 列表触发提交回调

Returns​

void

Overrides​

GlobalOverlayEditor.onEnd


onFocusChange()​

protected onFocusChange(idx, prev): void;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:165

Parameters​

ParameterType
idxnumber
prevnumber

Returns​

void

Overrides​

GlobalOverlayEditor.onFocusChange


onRowClick()​

protected onRowClick(idx): void;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:152

Parameters​

ParameterType
idxnumber

Returns​

void

Overrides​

GlobalOverlayEditor.onRowClick


onStart()​

onStart(ctx): void;

Defined in: packages/rxdb-model/src/entity-table/editors/multiselect-editor.ts:69

打开浮层:无显式初始选中时从单元格 origin 值解析已选 id

Parameters​

ParameterType
ctxEditContext<string, any>

Returns​

void

Overrides​

GlobalOverlayEditor.onStart


refocusTable()​

protected refocusTable(): void;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:235

Returns​

void

Inherited from​

GlobalOverlayEditor.refocusTable


rowAt()​

protected rowAt(idx): HTMLElement | null;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:215

Parameters​

ParameterType
idxnumber

Returns​

HTMLElement | null

Inherited from​

GlobalOverlayEditor.rowAt


setFocused()​

protected setFocused(idx): void;

Defined in: packages/rxdb-model/src/entity-table/editors/global-overlay-editor.ts:219

Parameters​

ParameterType
idxnumber

Returns​

void

Inherited from​

GlobalOverlayEditor.setFocused