Skip to main content
Version: 1.0.4

IPlannerOptions

@spartanfx/react v1.0.4


@spartanfx/react / IPlannerOptions

Interface: IPlannerOptions

Planner configuration options and event callbacks.

Remarks

Callbacks allow external applications to respond to user actions such as adding, moving, duplicating, or removing items and ranges.

Properties

PropertyTypeDescription
callBacks?objectCallback collection for interactions.
callBacks.onAdd?(item) => anyCalled when a new item is added.
callBacks.onAddNewClick?() => voidCalled when the "add new" button is clicked.
callBacks.onClick?(item) => anyCalled when an item is clicked.
callBacks.onDuplicateItemClick?(item) => voidCalled when duplicating a segment (from context menu).
callBacks.onDuplicateRangeClick?(item) => voidCalled when duplicating a range (from context menu).
callBacks.onItemChange?(changes) => void | Promise<void>Called when an item is updated via drag/resize.
callBacks.onMoveItemClick?(item) => voidCalled when a segment is moved (from context menu).
callBacks.onMoveRangeClick?(item) => voidCalled when a range is moved (from context menu).
callBacks.onReAssignItemClick?(item) => voidCalled when reassigning a segment (from context menu).
callBacks.onReAssignRangeClick?(item) => voidCalled when reassigning a full range (from context menu).
endDate?DateOptional end date, otherwise computed automatically.
startDateDateThe starting date of the planner view.