跳到主要内容

EntityListComponent

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:181

实体列表组件

封装了实体列表的完整 UI:工具栏(显示名称、筛选、撤销/重做、新增)+ 数据表格。 通过 namespace 和 name 输入定位 RxDB 实体,实现懒加载分页和 CRUD 操作。

Example​

<rxdb-entity-list [namespace]="namespace()" [name]="name()" />

Constructors​

Constructor​

new EntityListComponent(): EntityListComponent;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:496

Returns​

EntityListComponent

Properties​

$isFilterQuery​

readonly $isFilterQuery: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:370


alreadyLinkedIds​

readonly alreadyLinkedIds: InputSignal<Set<string>>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:352

已关联的实体 ID 集合(选择模式下过滤掉,不再展示)


canRedo​

readonly canRedo: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:412


canUndo​

readonly canUndo: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:411


createFormFieldConfigs​

readonly createFormFieldConfigs: Signal<FormFieldConfig[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:450


creationChain​

readonly creationChain: InputSignal<string[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:337

创建链路中的实体类型(namespace:name),用于阻断循环创建


displayName​

readonly displayName: Signal<string>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:384


draftParentEntity​

readonly draftParentEntity: InputSignal<EntityInstance | null>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:331

草稿父实体(用于级联新增场景,子实体通过关系API注册到父实体)


editChain​

readonly editChain: InputSignal<string[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:340

已打开详情对话框的记录 id 栈(含祖先记录),「查看」前检查以防无限套娃


filteredCount​

readonly filteredCount: Signal<number>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:397


filterQuery​

readonly filterQuery: WritableSignal<FilterQuery>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:364


fixedFormData​

readonly fixedFormData: InputSignal<EntityFormData | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:328

预填充的外键数据(级联新增时传递给子实体对话框)


fixedQuery​

readonly fixedQuery: InputSignal<FilterQuery | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:322

固定查询条件,与用户筛选条件做 AND 合并(用于关系属性过滤,如 ownerId = currentId)


Funnel​

protected readonly Funnel: typeof LucideFunnel;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:291


initialFilter​

readonly initialFilter: InputSignal<string | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:325

外部导航传入的初始筛选条件(JSON 字符串),如 Query Builder「应用到实体浏览」


isBrowser​

readonly isBrowser: boolean;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:382


isCreateBlocked​

readonly isCreateBlocked: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:392

当前实体不接受从列表新增:create 只许系统写,或已在祖先创建链路中(循环创建检测)


isInitialLoading​

readonly isInitialLoading: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:399


isLoadingMore​

readonly isLoadingMore: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:404


isM2m​

readonly isM2m: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:459


isQueryActive​

readonly isQueryActive: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:396


isSelectMode​

readonly isSelectMode: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:458


listTableOptions​

protected readonly listTableOptions: Partial<ListTableConstructorOptions> = LIST_TABLE_OPTIONS;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:292


loadMore​

protected readonly loadMore: Signal<(() => void) | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:312


m2mAlreadyLinkedIds​

readonly m2mAlreadyLinkedIds: Signal<Set<string>>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:488


m2mSelectTpl​

readonly m2mSelectTpl: Signal<TemplateRef<void> | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:461


mode​

readonly mode: InputSignal<"select" | "default">;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:349

列表模式:default=普通列表, select=选择模式(带 checkbox 列)


name​

readonly name: InputSignal<string>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:319


namespace​

readonly namespace: InputSignal<string>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:318


overlayPositions​

protected readonly overlayPositions: (
| {
offsetY: number;
originX: "end";
originY: "bottom";
overlayX: "end";
overlayY: "top";
}
| {
offsetY: number;
originX: "end";
originY: "top";
overlayX: "end";
overlayY: "bottom";
})[];

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:295

CDK Overlay 定位策略:优先下方右对齐,其次上方右对齐


parentEntity​

readonly parentEntity: InputSignal<EntityInstance | null>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:346

父实体实例(用于 M2M 关系操作,包含 draft 和已保存实体)


parentRelationName​

readonly parentRelationName: InputSignal<string | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:334

父实体上关系属性名(如 'children'),用于调用 parent.children$.add(child)


pendingQuery​

readonly pendingQuery: WritableSignal<FilterQuery>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:374


pendingQueryValid​

readonly pendingQueryValid: WritableSignal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:380


queryBuilderFields​

readonly queryBuilderFields: Signal<FieldMetadata[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:414


Redo2​

protected readonly Redo2: typeof LucideRedo2;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:290


redoCount​

readonly redoCount: Signal<number>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:410


relationKind​

readonly relationKind: InputSignal<RelationKind | undefined>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:343

关系类型(MANY_TO_MANY 时启用选择模式)


reorderError​

readonly reorderError: WritableSignal<string | null>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:465

最近一次拖放排序落库失败的提示;null 为无错误


rowDragEnabled​

readonly rowDragEnabled: Signal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:468

当前列表是否允许拖放排序(行拖动手柄是否显示)


selectedCount​

readonly selectedCount: Signal<number>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:486


selectedIds​

readonly selectedIds: WritableSignal<Set<string>>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:485


selectionCancelled​

readonly selectionCancelled: OutputEmitterRef<void>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:361

选择模式:取消选择时触发


selectionConfirmed​

readonly selectionConfirmed: OutputEmitterRef<EntityInstance[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:358

选择模式:确认选择时触发,携带选中的实体实例


showFilterPopover​

readonly showFilterPopover: WritableSignal<boolean>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:372


tableColumns​

readonly tableColumns: Signal<ColumnsDefine>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:440


tableRecords​

readonly tableRecords: Signal<EntityTableRecord[]>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:420


Undo2​

protected readonly Undo2: typeof LucideUndo2;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:289


undoCount​

readonly undoCount: Signal<number>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:409


viewEntity​

readonly viewEntity: OutputEmitterRef<EntityTableRecord>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:355

点击「查看」按钮时触发,携带对应行记录;组件同时打开内置编辑对话框(记录已在 editChain 中或为未保存草稿时仅 emit)

Methods​

applyFilter()​

applyFilter(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:522

Returns​

void


cancelSelection()​

cancelSelection(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:724

Returns​

void


confirmSelection()​

confirmSelection(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:714

Returns​

void


m2mCancelSelection()​

m2mCancelSelection(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:710

Returns​

void


onBatchUpdated()​

onBatchUpdated(mutations): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:617

Parameters​

ParameterType
mutationsBatchChangeItem[]

Returns​

void


onCellChanged()​

onCellChanged(event): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:559

Parameters​

ParameterType
eventCellChangeEvent

Returns​

void


onIconClicked()​

onIconClicked(event): Promise<void>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:589

Parameters​

ParameterType
event{ name: string; record: EntityTableRecord; }
event.namestring
event.recordEntityTableRecord

Returns​

Promise<void>


onKeydown()​

onKeydown(e): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:533

Parameters​

ParameterType
eKeyboardEvent

Returns​

void


onM2mSelectionConfirmed()​

onM2mSelectionConfirmed(entities): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:687

Parameters​

ParameterType
entitiesEntityInstance[]

Returns​

void


onQueryChange()​

onQueryChange(query): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:551

Parameters​

ParameterType
query| { combinator: "and" | "or"; rules: unknown[]; } | undefined

Returns​

void


onRowDeleted()​

onRowDeleted(event): Promise<void>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:613

Parameters​

ParameterType
eventEntityTableRecord

Returns​

Promise<void>


onRowMoved()​

onRowMoved(move): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:731

单行拖放:允许时按界面上的邻居落库重排,不允许或失败时把表格恢复原顺序(US-028)。

Parameters​

ParameterType
moveRowMoveEvent

Returns​

void


onSortClicked()​

onSortClicked(event): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:746

列头排序点击:驱动 cursor orderBy 重查(VTable 客户端排序已禁用)。

Parameters​

ParameterType
event{ field: unknown; order: unknown; }
event.fieldunknown
event.orderunknown

Returns​

void


onValidationChange()​

onValidationChange(result): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:555

Parameters​

ParameterType
resultValidationResult

Returns​

void


openCreateDialog()​

openCreateDialog(): Promise<void>;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:624

Returns​

Promise<void>


openM2mSelectDialog()​

openM2mSelectDialog(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:668

Returns​

void


redo()​

redo(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:585

Returns​

void


resetFilter()​

resetFilter(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:527

Returns​

void


toggleFilterPopover()​

toggleFilterPopover(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:518

Returns​

void


undo()​

undo(): void;

Defined in: packages/rxdb-model-angular/src/entity-list/entity-list.component.ts:581

Returns​

void