PlanningCalendar

extends Control

The PlanningCalendar can display rows with appointments for different persons. It is possible to define different views and switch between the views. You can add your own buttons or other controls to the toolbar.

Note: The PlanningCalendar uses parts of the sap.ui.unified library. If the sap.ui.unified library is not loaded before the PlanningCalendar is loaded, it will be loaded after the PlanningCalendar is loaded. This could lead to a waiting time before a PlanningCalendar is used for the first time. To prevent this, applications using the PlanningCalendar should also load the sap.ui.unified library.

Since: 1.34.0.

Constructor Summary

new sap.m.PlanningCalendar(sID?, mSettings?)Constructor for a new PlanningCalendar.

Event Summary

appointmentSelect(oControlEvent)Fired if an appointment was selected

intervalSelect(oControlEvent)Fired if an interval was selected in the header calendar or in the row

rowSelectionChange(oControlEvent)Fires when row selection is changed

startDateChange(oControlEvent)startDate was changed while navigating in PlanningCalendar

viewChange(oControlEvent)viewKey was changed by user interaction

Events borrowed from class sap.ui.core.Control

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.m.PlanningCalendar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.PlanningCalendar with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.PlanningCalendar.getMetadata()Returns a metadata object for class sap.m.PlanningCalendar.

addRow(oRow)Adds some row to the aggregation rows.

addSpecialDate(oSpecialDate)Adds some specialDate to the aggregation specialDates.

addToolbarContent(oToolbarContent)Adds some toolbarContent to the aggregation toolbarContent.

addView(oView)Adds some view to the aggregation views.

attachAppointmentSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the appointmentSelect event of this sap.m.PlanningCalendar.

attachIntervalSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the intervalSelect event of this sap.m.PlanningCalendar.

attachRowSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the rowSelectionChange event of this sap.m.PlanningCalendar.

attachStartDateChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the startDateChange event of this sap.m.PlanningCalendar.

attachViewChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the viewChange event of this sap.m.PlanningCalendar.

destroyRows()Destroys all the rows in the aggregation rows.

destroySpecialDates()Destroys all the specialDates in the aggregation specialDates.

destroyToolbarContent()Destroys all the toolbarContent in the aggregation toolbarContent.

destroyViews()Destroys all the views in the aggregation views.

detachAppointmentSelect(fnFunction, oListener)Detaches event handler fnFunction from the appointmentSelect event of this sap.m.PlanningCalendar.

detachIntervalSelect(fnFunction, oListener)Detaches event handler fnFunction from the intervalSelect event of this sap.m.PlanningCalendar.

detachRowSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the rowSelectionChange event of this sap.m.PlanningCalendar.

detachStartDateChange(fnFunction, oListener)Detaches event handler fnFunction from the startDateChange event of this sap.m.PlanningCalendar.

detachViewChange(fnFunction, oListener)Detaches event handler fnFunction from the viewChange event of this sap.m.PlanningCalendar.

fireAppointmentSelect(mArguments?)Fires event appointmentSelect to attached listeners.

fireIntervalSelect(mArguments?)Fires event intervalSelect to attached listeners.

fireRowSelectionChange(mArguments?)Fires event rowSelectionChange to attached listeners.

fireStartDateChange(mArguments?)Fires event startDateChange to attached listeners.

fireViewChange(mArguments?)Fires event viewChange to attached listeners.

getAppointmentsReducedHeight()Gets current value of property appointmentsReducedHeight.

getHeight()Gets current value of property height.

getMaxDate()Gets current value of property maxDate.

getMinDate()Gets current value of property minDate.

getNoDataText()Gets current value of property noDataText.

getRows()Gets content of aggregation rows.

getSelectedRows()Returns an array containing the selected rows.

getShowEmptyIntervalHeaders()Gets current value of property showEmptyIntervalHeaders.

getShowIntervalHeaders()Gets current value of property showIntervalHeaders.

getShowRowHeaders()Gets current value of property showRowHeaders.

getSingleSelection()Gets current value of property singleSelection.

getSpecialDates()Gets content of aggregation specialDates.

getStartDate()Gets current value of property startDate.

getToolbarContent()Gets content of aggregation toolbarContent.

getViewKey()Gets current value of property viewKey.

getViews()Gets content of aggregation views.

getWidth()Gets current value of property width.

indexOfRow(oRow)Checks for the provided sap.m.PlanningCalendarRow in the aggregation rows.

indexOfSpecialDate(oSpecialDate)Checks for the provided sap.ui.unified.DateTypeRange in the aggregation specialDates.

indexOfToolbarContent(oToolbarContent)Checks for the provided sap.ui.core.Control in the aggregation toolbarContent.

indexOfView(oView)Checks for the provided sap.m.PlanningCalendarView in the aggregation views.

insertRow(oRow, iIndex)Inserts a row into the aggregation rows.

insertSpecialDate(oSpecialDate, iIndex)Inserts a specialDate into the aggregation specialDates.

insertToolbarContent(oToolbarContent, iIndex)Inserts a toolbarContent into the aggregation toolbarContent.

insertView(oView, iIndex)Inserts a view into the aggregation views.

removeAllRows()Removes all the controls from the aggregation rows.

removeAllSpecialDates()Removes all the controls from the aggregation specialDates.

removeAllToolbarContent()Removes all the controls from the aggregation toolbarContent.

removeAllViews()Removes all the controls from the aggregation views.

removeRow(vRow)Removes a row from the aggregation rows.

removeSpecialDate(vSpecialDate)Removes a specialDate from the aggregation specialDates.

removeToolbarContent(vToolbarContent)Removes a toolbarContent from the aggregation toolbarContent.

removeView(vView)Removes a view from the aggregation views.

selectAllRows(bSelect)Selects or deselects all PlanningCalendarRows.

setAppointmentsReducedHeight(bAppointmentsReducedHeight)Sets a new value for property appointmentsReducedHeight.

setHeight(sHeight)Sets a new value for property height.

setMaxDate(oMaxDate)Sets a new value for property maxDate.

setMinDate(oMinDate)Sets a new value for property minDate.

setNoDataText(sNoDataText)Sets a new value for property noDataText.

setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders)Sets a new value for property showEmptyIntervalHeaders.

setShowIntervalHeaders(bShowIntervalHeaders)Sets a new value for property showIntervalHeaders.

setShowRowHeaders(bShowRowHeaders)Sets a new value for property showRowHeaders.

setSingleSelection(bSingleSelection)Sets a new value for property singleSelection.

setStartDate(oStartDate)Sets a new value for property startDate.

setViewKey(sViewKey)Sets a new value for property viewKey.

setWidth(sWidth)Sets a new value for property width.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.m.PlanningCalendar(sID?, mSettings?)

Constructor for a new PlanningCalendar.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

Properties
- startDate : object
- viewKey : string (default: sap.ui.unified.CalendarIntervalType.Hour)
- singleSelection : boolean (default: true)
- width : sap.ui.core.CSSSize
- height : sap.ui.core.CSSSize
- showIntervalHeaders : boolean (default: true)
- showEmptyIntervalHeaders : boolean (default: true)
- showRowHeaders : boolean (default: true)
- noDataText : string
- appointmentsReducedHeight : boolean (default: false)
- minDate : object
- maxDate : object
Aggregations
- rows : sap.m.PlanningCalendarRow[]
- views : sap.m.PlanningCalendarView[]
- specialDates : sap.ui.unified.DateTypeRange[]
- toolbarContent : sap.ui.core.Control[]
Events
- appointmentSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- intervalSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- rowSelectionChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- startDateChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- viewChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:

{string}	sID?	ID for the new control, generated automatically if no ID is given
{object}	mSettings?	Initial settings for the new control

Event Detail

appointmentSelect(oControlEvent)

Fired if an appointment was selected

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.ui.unified.CalendarAppointment}	oControlEvent.getParameters.appointment	Selected appointment
{sap.ui.unified.CalendarAppointment[]}	oControlEvent.getParameters.appointments	Selected appointments in case a group appointment is selected
{boolean}	oControlEvent.getParameters.multiSelect	If set, the appointment was selected using multiple selection (e.g. Shift + single mouse click), meaning more than the current appointment could be selected.

intervalSelect(oControlEvent)

Fired if an interval was selected in the header calendar or in the row

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{object}	oControlEvent.getParameters.startDate	Start date of the selected interval, as JavaScript date object.
{object}	oControlEvent.getParameters.endDate	Interval end date as JavaScript date object
{boolean}	oControlEvent.getParameters.subInterval	If set, the selected interval is a subinterval
{sap.m.PlanningCalendarRow}	oControlEvent.getParameters.row	Row of the selected interval

rowSelectionChange(oControlEvent)

Fires when row selection is changed

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{sap.m.PlanningCalendarRow[]}	oControlEvent.getParameters.rows	Array of rows whose selection has changed.

startDateChange(oControlEvent)

startDate was changed while navigating in PlanningCalendar

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

viewChange(oControlEvent)

viewKey was changed by user interaction

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Method Detail

sap.m.PlanningCalendar.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.PlanningCalendar with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.m.PlanningCalendar.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.m.PlanningCalendar.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addRow(oRow): sap.m.PlanningCalendar

Adds some row to the aggregation rows.

Parameters:

{sap.m.PlanningCalendarRow}

oRow

the row to add; if empty, nothing is inserted

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

addSpecialDate(oSpecialDate): sap.m.PlanningCalendar

Adds some specialDate to the aggregation specialDates.

Parameters:

{sap.ui.unified.DateTypeRange}

oSpecialDate

the specialDate to add; if empty, nothing is inserted

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

addToolbarContent(oToolbarContent): sap.m.PlanningCalendar

Adds some toolbarContent to the aggregation toolbarContent.

Parameters:

{sap.ui.core.Control}

oToolbarContent

the toolbarContent to add; if empty, nothing is inserted

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

addView(oView): sap.m.PlanningCalendar

Adds some view to the aggregation views.

Parameters:

{sap.m.PlanningCalendarView}

oView

the view to add; if empty, nothing is inserted

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

attachAppointmentSelect(oData?, fnFunction, oListener?): sap.m.PlanningCalendar

Attaches event handler fnFunction to the appointmentSelect event of this sap.m.PlanningCalendar.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PlanningCalendar itself.

Fired if an appointment was selected

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.PlanningCalendar` itself

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

attachIntervalSelect(oData?, fnFunction, oListener?): sap.m.PlanningCalendar

Attaches event handler fnFunction to the intervalSelect event of this sap.m.PlanningCalendar.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PlanningCalendar itself.

Fired if an interval was selected in the header calendar or in the row

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.PlanningCalendar` itself

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

attachRowSelectionChange(oData?, fnFunction, oListener?): sap.m.PlanningCalendar

Attaches event handler fnFunction to the rowSelectionChange event of this sap.m.PlanningCalendar.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PlanningCalendar itself.

Fires when row selection is changed

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.PlanningCalendar` itself

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

attachStartDateChange(oData?, fnFunction, oListener?): sap.m.PlanningCalendar

Attaches event handler fnFunction to the startDateChange event of this sap.m.PlanningCalendar.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PlanningCalendar itself.

startDate was changed while navigating in PlanningCalendar

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.PlanningCalendar` itself

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

attachViewChange(oData?, fnFunction, oListener?): sap.m.PlanningCalendar

Attaches event handler fnFunction to the viewChange event of this sap.m.PlanningCalendar.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.m.PlanningCalendar itself.

viewKey was changed by user interaction

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.m.PlanningCalendar` itself

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

destroyRows(): sap.m.PlanningCalendar

Destroys all the rows in the aggregation rows.

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

destroySpecialDates(): sap.m.PlanningCalendar

Destroys all the specialDates in the aggregation specialDates.

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

destroyToolbarContent(): sap.m.PlanningCalendar

Destroys all the toolbarContent in the aggregation toolbarContent.

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

destroyViews(): sap.m.PlanningCalendar

Destroys all the views in the aggregation views.

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

detachAppointmentSelect(fnFunction, oListener): sap.m.PlanningCalendar

Detaches event handler fnFunction from the appointmentSelect event of this sap.m.PlanningCalendar.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

detachIntervalSelect(fnFunction, oListener): sap.m.PlanningCalendar

Detaches event handler fnFunction from the intervalSelect event of this sap.m.PlanningCalendar.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

detachRowSelectionChange(fnFunction, oListener): sap.m.PlanningCalendar

Detaches event handler fnFunction from the rowSelectionChange event of this sap.m.PlanningCalendar.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

detachStartDateChange(fnFunction, oListener): sap.m.PlanningCalendar

Detaches event handler fnFunction from the startDateChange event of this sap.m.PlanningCalendar.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

detachViewChange(fnFunction, oListener): sap.m.PlanningCalendar

Detaches event handler fnFunction from the viewChange event of this sap.m.PlanningCalendar.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

fireAppointmentSelect(mArguments?): sap.m.PlanningCalendar

Fires event appointmentSelect to attached listeners.

Expects the following event parameters:

appointment of type sap.ui.unified.CalendarAppointmentSelected appointment
appointments of type sap.ui.unified.CalendarAppointment[]Selected appointments in case a group appointment is selected
multiSelect of type booleanIf set, the appointment was selected using multiple selection (e.g. Shift + single mouse click), meaning more than the current appointment could be selected.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

fireIntervalSelect(mArguments?): sap.m.PlanningCalendar

Fires event intervalSelect to attached listeners.

Expects the following event parameters:

startDate of type objectStart date of the selected interval, as JavaScript date object.
endDate of type objectInterval end date as JavaScript date object
subInterval of type booleanIf set, the selected interval is a subinterval
row of type sap.m.PlanningCalendarRowRow of the selected interval

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

fireRowSelectionChange(mArguments?): sap.m.PlanningCalendar

Fires event rowSelectionChange to attached listeners.

Expects the following event parameters:

rows of type sap.m.PlanningCalendarRow[]Array of rows whose selection has changed.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

fireStartDateChange(mArguments?): sap.m.PlanningCalendar

Fires event startDateChange to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

fireViewChange(mArguments?): sap.m.PlanningCalendar

Fires event viewChange to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

getAppointmentsReducedHeight(): boolean

Gets current value of property appointmentsReducedHeight.

If set the appointments without text (only title) are rendered with a smaller height.

Note: On phone devices this property is ignored, appointments are always rendered in full height to allow touching.

Default value is false.

Since:: 1.38.0

Returns:

{boolean} Value of property appointmentsReducedHeight

getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Height of the PlanningCalendar

Returns:

{sap.ui.core.CSSSize} Value of property height

getMaxDate(): object

Gets current value of property maxDate.

Maximum date that can be shown and selected in the PlanningCalendar. This must be a JavaScript date object.

Note: If the maxDate is set to be before the minDate, the minDate is set to the begin of the month of the maxDate.

Since:: 1.38.0

Returns:

{object} Value of property maxDate

getMinDate(): object

Gets current value of property minDate.

Minimum date that can be shown and selected in the PlanningCalendar. This must be a JavaScript date object.

Note: If the minDate is set to be after the maxDate, the maxDate is set to the end of the month of the minDate.

Since:: 1.38.0

Returns:

{object} Value of property minDate

getNoDataText(): string

Gets current value of property noDataText.

This text is displayed when no rows are assigned.

Returns:

{string} Value of property noDataText

getRows(): sap.m.PlanningCalendarRow[]

Gets content of aggregation rows.

rows of the PlanningCalendar

Returns:

{sap.m.PlanningCalendarRow[]}

getSelectedRows(): sap.m.PlanningCalendarRow[]

Returns an array containing the selected rows. If no row is selected, an empty array is returned.

Returns:

{sap.m.PlanningCalendarRow[]}

selected rows

getShowEmptyIntervalHeaders(): boolean

Gets current value of property showEmptyIntervalHeaders.

If set, interval headers are shown even if no intervalHeaders are assigned to the visible time frame.

If not set, no interval headers are shown if no intervalHeaders are assigned.

Note: This property is only used if showIntervalHeaders is set to true.

Default value is true.

Since:: 1.38.0

Returns:

{boolean} Value of property showEmptyIntervalHeaders

getShowIntervalHeaders(): boolean

Gets current value of property showIntervalHeaders.

If set, interval headers are shown like specified in showEmptyIntervalHeaders.

If not set, no interval headers are shown even if intervalHeaders are assigned.

Default value is true.

Returns:

{boolean} Value of property showIntervalHeaders

getShowRowHeaders(): boolean

Gets current value of property showRowHeaders.

If set, headers of the PlanningCalendarRows are shown. This means the column with the headers is shown.

If not set, the header column is not shown at all, even if header information is provided.

Default value is true.

Returns:

{boolean} Value of property showRowHeaders

getSingleSelection(): boolean

Gets current value of property singleSelection.

If set, only a single row can be selected

Default value is true.

Returns:

{boolean} Value of property singleSelection

getSpecialDates(): sap.ui.unified.DateTypeRange[]

Gets content of aggregation specialDates.

Date range along with a type to visualize special days in the header calendar. If one day is assigned to more than one type, only the first one will be used.

Returns:

{sap.ui.unified.DateTypeRange[]}

getStartDate(): object

Gets current value of property startDate.

Start date of the row, as JavaScript date object. As a default the current date is used.

Returns:

{object} Value of property startDate

getToolbarContent(): sap.ui.core.Control[]

Gets content of aggregation toolbarContent.

The content of the toolbar.

Returns:

{sap.ui.core.Control[]}

getViewKey(): string

Gets current value of property viewKey.

Key of the PlanningCalendarView used for the output. The default value uses a default view. If you are using own views, the keys of these views must be used instead.

Default value is sap.ui.unified.CalendarIntervalType.Hour.

Returns:

{string} Value of property viewKey

getViews(): sap.m.PlanningCalendarView[]

Gets content of aggregation views.

Views of the PlanningCalendar.

If not set, three default views are used to allow you to switch between hour, day and month granularity. The default views have the keys defined in sap.ui.unified.CalendarIntervalType

Returns:

{sap.m.PlanningCalendarView[]}

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of the PlanningCalendar

Returns:

{sap.ui.core.CSSSize} Value of property width

indexOfRow(oRow): int

Checks for the provided sap.m.PlanningCalendarRow in the aggregation rows. and returns its index if found or -1 otherwise.

Parameters:

{sap.m.PlanningCalendarRow}

oRow

The row whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfSpecialDate(oSpecialDate): int

Checks for the provided sap.ui.unified.DateTypeRange in the aggregation specialDates. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.unified.DateTypeRange}

oSpecialDate

The specialDate whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfToolbarContent(oToolbarContent): int

Checks for the provided sap.ui.core.Control in the aggregation toolbarContent. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Control}

oToolbarContent

The toolbarContent whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

indexOfView(oView): int

Checks for the provided sap.m.PlanningCalendarView in the aggregation views. and returns its index if found or -1 otherwise.

Parameters:

{sap.m.PlanningCalendarView}

oView

The view whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertRow(oRow, iIndex): sap.m.PlanningCalendar

Inserts a row into the aggregation rows.

Parameters:

{sap.m.PlanningCalendarRow}	oRow	the row to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted at position 0; for a value greater than the current size of the aggregation, the row is inserted at the last position

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

insertSpecialDate(oSpecialDate, iIndex): sap.m.PlanningCalendar

Inserts a specialDate into the aggregation specialDates.

Parameters:

{sap.ui.unified.DateTypeRange}	oSpecialDate	the specialDate to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the specialDate should be inserted at; for a negative value of `iIndex`, the specialDate is inserted at position 0; for a value greater than the current size of the aggregation, the specialDate is inserted at the last position

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

insertToolbarContent(oToolbarContent, iIndex): sap.m.PlanningCalendar

Inserts a toolbarContent into the aggregation toolbarContent.

Parameters:

{sap.ui.core.Control}	oToolbarContent	the toolbarContent to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the toolbarContent should be inserted at; for a negative value of `iIndex`, the toolbarContent is inserted at position 0; for a value greater than the current size of the aggregation, the toolbarContent is inserted at the last position

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

insertView(oView, iIndex): sap.m.PlanningCalendar

Inserts a view into the aggregation views.

Parameters:

{sap.m.PlanningCalendarView}	oView	the view to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the view should be inserted at; for a negative value of `iIndex`, the view is inserted at position 0; for a value greater than the current size of the aggregation, the view is inserted at the last position

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

removeAllRows(): sap.m.PlanningCalendarRow[]

Removes all the controls from the aggregation rows.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.m.PlanningCalendarRow[]}

An array of the removed elements (might be empty)

removeAllSpecialDates(): sap.ui.unified.DateTypeRange[]

Removes all the controls from the aggregation specialDates.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.unified.DateTypeRange[]}

An array of the removed elements (might be empty)

removeAllToolbarContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation toolbarContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAllViews(): sap.m.PlanningCalendarView[]

Removes all the controls from the aggregation views.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.m.PlanningCalendarView[]}

An array of the removed elements (might be empty)

removeRow(vRow): sap.m.PlanningCalendarRow

Removes a row from the aggregation rows.

Parameters:

{int|string|sap.m.PlanningCalendarRow}

vRow

The rowto remove or its index or id

Returns:

{sap.m.PlanningCalendarRow} The removed row or null

removeSpecialDate(vSpecialDate): sap.ui.unified.DateTypeRange

Removes a specialDate from the aggregation specialDates.

Parameters:

{int|string|sap.ui.unified.DateTypeRange}

vSpecialDate

The specialDateto remove or its index or id

Returns:

{sap.ui.unified.DateTypeRange} The removed specialDate or null

removeToolbarContent(vToolbarContent): sap.ui.core.Control

Removes a toolbarContent from the aggregation toolbarContent.

Parameters:

{int|string|sap.ui.core.Control}

vToolbarContent

The toolbarContentto remove or its index or id

Returns:

{sap.ui.core.Control} The removed toolbarContent or null

removeView(vView): sap.m.PlanningCalendarView

Removes a view from the aggregation views.

Parameters:

{int|string|sap.m.PlanningCalendarView}

vView

The viewto remove or its index or id

Returns:

{sap.m.PlanningCalendarView} The removed view or null

selectAllRows(bSelect): sap.m.PlanningCalendar

Selects or deselects all PlanningCalendarRows.

Note: Selection only works if singleSelection is not set

Parameters:

{boolean} bSelect Indicator showing whether PlanningCalendarRows should be selected or deselected

Returns:

{sap.m.PlanningCalendar} this to allow method chaining

setAppointmentsReducedHeight(bAppointmentsReducedHeight): sap.m.PlanningCalendar

Sets a new value for property appointmentsReducedHeight.

If set the appointments without text (only title) are rendered with a smaller height.

Note: On phone devices this property is ignored, appointments are always rendered in full height to allow touching.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:

{boolean} bAppointmentsReducedHeight New value for property appointmentsReducedHeight

Since:: 1.38.0

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setHeight(sHeight): sap.m.PlanningCalendar

Sets a new value for property height.

Height of the PlanningCalendar

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{sap.ui.core.CSSSize} sHeight New value for property height

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setMaxDate(oMaxDate): sap.m.PlanningCalendar

Sets a new value for property maxDate.

Maximum date that can be shown and selected in the PlanningCalendar. This must be a JavaScript date object.

Note: If the maxDate is set to be before the minDate, the minDate is set to the begin of the month of the maxDate.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{object} oMaxDate New value for property maxDate

Since:: 1.38.0

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setMinDate(oMinDate): sap.m.PlanningCalendar

Sets a new value for property minDate.

Minimum date that can be shown and selected in the PlanningCalendar. This must be a JavaScript date object.

Note: If the minDate is set to be after the maxDate, the maxDate is set to the end of the month of the minDate.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{object} oMinDate New value for property minDate

Since:: 1.38.0

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setNoDataText(sNoDataText): sap.m.PlanningCalendar

Sets a new value for property noDataText.

This text is displayed when no rows are assigned.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{string} sNoDataText New value for property noDataText

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setShowEmptyIntervalHeaders(bShowEmptyIntervalHeaders): sap.m.PlanningCalendar

Sets a new value for property showEmptyIntervalHeaders.

If set, interval headers are shown even if no intervalHeaders are assigned to the visible time frame.

If not set, no interval headers are shown if no intervalHeaders are assigned.

Note: This property is only used if showIntervalHeaders is set to true.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bShowEmptyIntervalHeaders New value for property showEmptyIntervalHeaders

Since:: 1.38.0

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setShowIntervalHeaders(bShowIntervalHeaders): sap.m.PlanningCalendar

Sets a new value for property showIntervalHeaders.

If set, interval headers are shown like specified in showEmptyIntervalHeaders.

If not set, no interval headers are shown even if intervalHeaders are assigned.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bShowIntervalHeaders New value for property showIntervalHeaders

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setShowRowHeaders(bShowRowHeaders): sap.m.PlanningCalendar

Sets a new value for property showRowHeaders.

If set, headers of the PlanningCalendarRows are shown. This means the column with the headers is shown.

If not set, the header column is not shown at all, even if header information is provided.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bShowRowHeaders New value for property showRowHeaders

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setSingleSelection(bSingleSelection): sap.m.PlanningCalendar

Sets a new value for property singleSelection.

If set, only a single row can be selected

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:

{boolean} bSingleSelection New value for property singleSelection

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setStartDate(oStartDate): sap.m.PlanningCalendar

Sets a new value for property startDate.

Start date of the row, as JavaScript date object. As a default the current date is used.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{object} oStartDate New value for property startDate

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setViewKey(sViewKey): sap.m.PlanningCalendar

Sets a new value for property viewKey.

Key of the PlanningCalendarView used for the output. The default value uses a default view. If you are using own views, the keys of these views must be used instead.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.ui.unified.CalendarIntervalType.Hour.

Parameters:

{string} sViewKey New value for property viewKey

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining

setWidth(sWidth): sap.m.PlanningCalendar

Sets a new value for property width.

Width of the PlanningCalendar

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

{sap.m.PlanningCalendar} Reference to this in order to allow method chaining