跳转到内容

日历

用于显示和选择日期。其主要功能包括:展示时间轴,月/周/日视图, 支持日程查看,高亮当前日期,标记特殊事件,是日程管理类应用的核心组件。

  • 在配置日历部件样式为【时间轴】时,会按照时间的顺序依次展示事件数据;
  • 在配置日历部件样式为【月】时,可一次性显示一个月的时间以及该时间段内的事件数据,同时该模式下部件参数showmode可额外配置值为'daterange'和'expand'(详情见控件动态参数);
  • 在配置日历部件样式为【周】时,可一次性显示一周的时间以及每天的事件数据;
  • 在配置日历部件样式为【天】时,可一次性显示一天24小时的时间以及各时间段内的事件数据;
  • 当在配置日历部件样式为【用户自定义1】时,该模式是以只读模式的周视图进行展示;

常规

多数据源

布局面板

上下文菜单

内置导航

显示模式

刷新模式

事件

能力调用

输入参数

名称说明类型默认值
modelData日历模型数据Object as ISysCalendar-
context应用上下文对象Object as IContext-
params视图参数对象Object as IParams{}
provider部件适配器Object as IControlProvider-
mdctrlActiveMode部件激活模式,值为0:表示无激活,1:表示单击激活,2:表示双击激活Number-
isSimple是否是简单模式,即直接传入数据,不加载数据Boolean-
loadDefault是否默认加载Booleantrue

状态

名称说明类型默认值
isCreated控制器是否走完created生命周期booleanfalse
isMounted控制器是否走完mounted生命周期booleanfalse
isDestroyed控制器是否走完destroy生命周期booleanfalse
context应用上下文对象IApiContext{}
activated当前部件是否为激活状态(缓存下的激活状态,一般与框架的生命周期相同)booleanfalse
isSimple是否是简单模式,简单模式下不加载数据,而是由父组件传值booleanfalse
isLoading部件是否正在加载booleanfalse
loadDefault是否默认加载数据booleantrue
disabled部件禁用状态booleanfalse
maskOption部件遮罩参数IApiMaskOption-
items日历项数据IApiCalendarItemData[][]
selectedData多数据部件已选中的数据集合IApiData[][]
selectedKeys多数据部件选中数据主键集合string[]-
singleSelect是否是单项选择booleantrue
mdctrlActiveMode多数据部件激活模式,0:无激活;1:单击激活;2:双击激活number | 0 | 1 | 20
curPage当前页number1
size分页条数number20
total总条数number0
totalx全部计数条数,数据集配置需勾选返回全部计数number0
totalPages总页数number-
isLoaded是否加载过数据,用于某些需要等待数据加载回来之后的场景。booleanfalse
searchParams搜索部件的查询参数IApiParams{}
noSort是否禁用排序booleanfalse
sortQuery排序查询条件string''
groups日历分组数据IApiCalendarGroup[][]
hideNoDataImage隐藏无数据图片,该状态仅PC端使用。booleanfalse
enableNavView是否启用内置导航视图,该状态仅PC端使用。booleanfalse
showNavView是否显示内置导航视图,该状态仅PC端使用。booleanfalse
showNavIcon是否显示内置导航图标,导航视图显示模式为程序控制时不显示。该状态仅PC端使用。booleanfalse
showRowDetail是否显示行明细,该状态仅PC端(表格,列表)使用。booleanfalse
enableGroup是否启用分组,该状态仅PC端(表格,卡片,列表)使用。boolean-
selectedDate选中的日期DateDate
legends图例IApiData[][]
calendarTitle日历名称string''

控制器

名称说明类型
id控制器实例的唯一标识,创建时自动生成 string
state状态对象,泛型 S
model模型对象,泛型 T
context应用上下文对象 IApiContext
params视图参数对象 IApiParams
view当前视图控制器 IApiViewController & IApiData
ctrlId部件标识 string
controlParams部件参数 IApiParams
layoutPanel部件布局面板控制器 IApiViewLayoutPanelController & IApiData
runMode运行模式(DESIGN:设计模式,RUNTIME:运行时) 'DESIGN' | 'RUNTIME'
force强制更新,触发render函数(_callback?: () => void) => void
startLoading开始加载() => Promise<void>
endLoading加载完毕() => Promise<void>
getControlType获取部件类型() => string
enable取消部件禁用() => void
disabled设置部件禁用(options?: IApiMaskOption) => void
emitDEDataChange触发实体数据变更的通知(type: 'create' | 'update' | 'remove', data: IApiData) => void
setSort设置排序(key?: string, order?: 'asc' | 'desc') => void
loadMore加载更多() => Promise<void>
load加载数据(args?: IApiMDCtrlLoadParams) => Promise<IApiData[]>
remove删除数据(args?: IApiMDCtrlRemoveParams) => Promise<void>
refresh刷新数据() => Promise<void>
importData导入数据() => Promise<void>
getData获取选中数据() => IApiData[]
setSelection设置选中数据,设置的数据和已经选中的一样时会触发onSelectionChange事件(selection: IApiData[], isEmit?: boolean) => void
setActive设置激活数据(data: IApiData, event?: MouseEvent | undefined) => Promise<void>
goToFirstPage跳转第一页() => Promise<IApiData[]>
goToPreviousPage跳转上一页() => Promise<IApiData[]>
goToNextPage跳转下一页() => Promise<IApiData[]>
goToLastPage跳转最后一页() => Promise<IApiData[]>
selectAll选中全部数据(state?: boolean) => void
execGroup执行多数据分组(arg: IApiMDGroupParams[], params?: IApiParams) => Promise<void>
setSelectedData设置选中数据(items: IData[]) => void
newRow新建行(args?: IApiMDCtrlLoadParams) => Promise<void>
setSelectDate设置选中日期(date: Date) => void

事件

名称描述类型
onCreated自身的准备工作完成(如模型加载,各种初始化,init结束){eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onMounted没有下级组件created之后的生命周期,有下级时需要等所有下级组件onMounted完成后触发{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeDestroy组件销毁前{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onDestroyed自身组件被销毁时触发{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onActivated自身组件重新激活{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onDeactivated自身组件暂时停用{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onUIAction界面行为执行{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onRefreshSuccess刷新成功{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onActive数据激活事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onSelectionChange选中数据变更事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeSave保存之前{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onSaveSuccess保存成功后{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onSaveError保存失败{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeRemove删除之前{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onRemoveSuccess删除成功之后{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onRemoveError删除失败{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onBeforeLoad加载前事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onLoadSuccess加载后处理事件{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onLoadError加载失败{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}
onNavDataChange导航数据变更{eventName:string, context:IApiContext, params:IApiParams, data:IApiData[], targetName:string, view:IApiViewController, ctrl:IApiControlController, [key: string]: any}

控件动态参数

名称说明类型默认值
showmode该值为 'DEFAULT' 时正常显示无数据提示图片,该值为 'ONLYDATA' 和 'MIXIN' 时,不显示无数据提示图片;当日历部件样式为时,默认情况下,时间单元格内仅显示首个事件数据,剩余事件数据隐藏,点击 更多 按钮后,剩余事件数据会以气泡形式展示。当该值为 'daterange' 时,会依据事件数据中的时间范围,在对应时间单元格内以连续的色块覆盖形式展示日历项范围。当该值为 'expand' 时,时间单元格内的事件数据会从上至下平铺展示'DEFAULT' | 'ONLYDATA' | 'MIXIN' | 'daterange' | 'expand''DEFAULT'
showdetail当日历部件样式为时生效,鼠标悬浮到显示日历事件项之上时是否弹出气泡框显示事件项详情booleanfalse
defaultdatetime当日历部件样式为用户自定义时生效,用于设置日历初始化的时间,值格式化为YYYY-MM-DDstring''
mdctrlrefreshmode多数据部件刷新模式,当值为 'cache',部件刷新时保留选中数据;当值为 'nocache',部件刷新时清空选中数据'nocache' | 'cache''cache'
未来已来,立即拥抱应用融合的力量
Released under the MIT License.