getState

获取甘特图的当前状态

GanttUIState getState();
GanttUIState状态对象

Example

const opened_task = gantt.getState().lightbox;

Details

该状态对象表示甘特图的内部UI设置,包含以下属性:

  • autoscroll - (boolean) - 指示甘特图是否处于自动滚动状态(true)。仅当click_drag 扩展启用时存在。
  • batch_update - (boolean) - 表示更新模式。如果方法在batchUpdate 方法内部调用,则为 true
  • drag_from_start - (boolean | null) - 定义任务调整大小的模式。true 表示从开始端调整,false 表示从结束端调整,null 表示没有调整大小操作。
  • drag_id - (string | null | undefined) - 当前被拖动任务的id。如果没有任务被拖动,则为 undefinednull
  • drag_mode - (string | null | undefined) - 显示拖动模式,可能的值有 'move'、'resize'、'progress' 或 'ignore',当任务被拖动时有效,否则为 nullundefined
  • fullscreen - (boolean) - 指示甘特图是否处于全屏模式(true)或非全屏模式(false)。
  • lightbox - (string | null | undefined) - 当前在lightbox中打开的任务id。undefinednull 表示没有任务被打开。
  • link_from_start - (boolean | null) - 表示新链接是否从前置任务的开始端创建(true)。
  • link_landing_area - (boolean) - 指示鼠标是否指向链接拖动元素(气泡)区域,在创建链接时使用。
  • link_source_id - (string | number | null) - 新链接创建时的源任务(前置任务)id。
  • link_target_id - (string | number | null) - 新链接创建时的目标任务(后续任务)id。
  • link_to_start - (boolean) - 表示链接是否创建到后续任务的开始端(true)。
  • min_date - (Date) - 甘特图上显示任务的起始日期。
  • max_date - (Date) - 甘特图上显示任务的结束日期。
  • scale_unit - (string) - 时间线背景grid使用的单位。
  • scale_step - (number) - 时间线背景grid的步进大小。
  • selected_task - (string | null | undefined) - 当前选中任务的id。如果没有选中任务,则为 undefinednull

注意,该对象仅供参考,修改它不会影响甘特图的行为。

Back to top