Skip to main content

IPlannerSchema

@spartanfx/react v1.2.2


@spartanfx/react / index / IPlannerSchema

Interface: IPlannerSchema

Schema describing how raw incoming item data maps to planner items.

Properties​

Required​

PropertyTypeDescription
endDateFieldISchemaFieldMaps to the end date.
groupFieldISchemaFieldMaps to the grouping field.
idFieldISchemaFieldMaps to the planner item ID.
startDateFieldISchemaFieldMaps to the start date.
titleFieldISchemaFieldMaps to the item title.

Options​

PropertyTypeDescription
descriptionField?ISchemaFieldMaps to the optional description.
durationField?ISchemaFieldMaps to duration if provided.
rangeGroupField?ISchemaFieldMaps the item's range grouping key.

Appearance & theming​

PropertyTypeDescription
colorField?ISchemaFieldMaps to a color value.