View of the sap.m.PlanningCalendar.
The PlanningCalendarView
defines the type of the intervals (hours, days, months) and how many intervals are displayed.
Constructor for a new PlanningCalendarView
.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.m.PlanningCalendarView(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
appointmentHeight | sap.ui.unified.CalendarAppointmentHeight | Regular | Determines the different possible sizes for appointments. |
description | string | Defines the description of the |
|
intervalLabelFormatter | object | A function that formats the interval. |
|
intervalSize | int | 1 | An integer that defines the period size. |
intervalType | sap.ui.unified.CalendarIntervalType | Hour | Determines the type of the intervals of the row. Note: Not all predefined interval types are supported for this property. For more information, see the descriptions in the CalendarIntervalType enumeration. Visibility: public |
intervalsL | int | 12 | Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is more than 1024 pixels wide. Visibility: public |
intervalsM | int | 8 | Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is between 600 and 1024 pixels wide. Visibility: public |
intervalsS | int | 6 | Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is less than 600 pixels wide. Note: On a phone the maximum visible intervals are 8. Visibility: public |
key | string | Defines the key of the view. This must be set to identify the used view in the sap.m.PlanningCalendar. Visibility: public |
|
relative | boolean | false | Defines if the view will be relative. NOTE: Relative views, can be only used with intervalType - Day and when used they need intervalSize and intervalLabelFormatter defined. |
showSubIntervals | boolean | false | If set, subintervals are displayed as lines in the rows.
|
Method | Description |
---|---|
sap.m.PlanningCalendarView.extend |
Creates a new subclass of class sap.m.PlanningCalendarView with name
|
getAppointmentHeight |
Gets current value of property appointmentHeight. Determines the different possible sizes for appointments. Default value is |
getDescription |
Gets current value of property description. Defines the description of the |
getIntervalLabelFormatter |
Gets current value of property intervalLabelFormatter. A function that formats the interval. |
getIntervalSize |
Gets current value of property intervalSize. An integer that defines the period size. Default value is |
getIntervalsL |
Gets current value of property intervalsL. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is more than 1024 pixels wide. Default value is |
getIntervalsM |
Gets current value of property intervalsM. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is between 600 and 1024 pixels wide. Default value is |
getIntervalsS |
Gets current value of property intervalsS. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is less than 600 pixels wide. Note: On a phone the maximum visible intervals are 8. Default value is |
getIntervalType |
Gets current value of property intervalType. Determines the type of the intervals of the row. Note: Not all predefined interval types are supported for this property. For more information, see the descriptions in the CalendarIntervalType enumeration. Default value is |
getKey |
Gets current value of property key. Defines the key of the view. This must be set to identify the used view in the sap.m.PlanningCalendar. |
sap.m.PlanningCalendarView.getMetadata |
Returns a metadata object for class sap.m.PlanningCalendarView. |
getRelative |
Gets current value of property relative. Defines if the view will be relative. NOTE: Relative views, can be only used with intervalType - Day and when used they need intervalSize and intervalLabelFormatter defined. Default value is |
getShowSubIntervals |
Gets current value of property showSubIntervals. If set, subintervals are displayed as lines in the rows.
Default value is |
setAppointmentHeight |
Sets a new value for property appointmentHeight. Determines the different possible sizes for appointments. When called with a value of Default value is |
setDescription |
Sets a new value for property description. Defines the description of the When called with a value of |
setIntervalLabelFormatter |
Sets a new value for property intervalLabelFormatter. A function that formats the interval. When called with a value of |
setIntervalSize |
Sets a new value for property intervalSize. An integer that defines the period size. When called with a value of Default value is |
setIntervalsL |
Sets a new value for property intervalsL. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is more than 1024 pixels wide. When called with a value of Default value is |
setIntervalsM |
Sets a new value for property intervalsM. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is between 600 and 1024 pixels wide. When called with a value of Default value is |
setIntervalsS |
Sets a new value for property intervalsS. Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is less than 600 pixels wide. Note: On a phone the maximum visible intervals are 8. When called with a value of Default value is |
setIntervalType |
Sets a new value for property intervalType. Determines the type of the intervals of the row. Note: Not all predefined interval types are supported for this property. For more information, see the descriptions in the CalendarIntervalType enumeration. When called with a value of Default value is |
setKey |
Sets a new value for property key. Defines the key of the view. This must be set to identify the used view in the sap.m.PlanningCalendar. When called with a value of |
setRelative |
Sets a new value for property relative. Defines if the view will be relative. NOTE: Relative views, can be only used with intervalType - Day and when used they need intervalSize and intervalLabelFormatter defined. When called with a value of Default value is |
setShowSubIntervals |
Sets a new value for property showSubIntervals. If set, subintervals are displayed as lines in the rows.
When called with a value of Default value is |
Creates a new subclass of class sap.m.PlanningCalendarView 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.Element.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property appointmentHeight.
Determines the different possible sizes for appointments.
Default value is Regular
.
Gets current value of property description.
Defines the description of the PlanningCalendarView
.
Gets current value of property intervalLabelFormatter.
A function that formats the interval.
Gets current value of property intervalSize.
An integer that defines the period size.
Default value is 1
.
Gets current value of property intervalsL.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is more than 1024 pixels wide.
Default value is 12
.
Gets current value of property intervalsM.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is between 600 and 1024 pixels wide.
Default value is 8
.
Gets current value of property intervalsS.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is less than 600 pixels wide. Note: On a phone the maximum visible intervals are 8.
Default value is 6
.
Gets current value of property intervalType.
Determines the type of the intervals of the row.
Note: Not all predefined interval types are supported for this property. For more information, see the descriptions in the CalendarIntervalType enumeration.
Default value is Hour
.
Gets current value of property key.
Defines the key of the view. This must be set to identify the used view in the sap.m.PlanningCalendar.
Returns a metadata object for class sap.m.PlanningCalendarView.
Gets current value of property relative.
Defines if the view will be relative. NOTE: Relative views, can be only used with intervalType - Day and when used they need intervalSize and intervalLabelFormatter defined.
Default value is false
.
Gets current value of property showSubIntervals.
If set, subintervals are displayed as lines in the rows.
Hour
.Day
, Week
and OneMonth
.Month
.Default value is false
.
Sets a new value for property appointmentHeight.
Determines the different possible sizes for appointments.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Regular
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAppointmentHeight | sap.ui.unified.CalendarAppointmentHeight | Regular |
New value for property |
Sets a new value for property description.
Defines the description of the PlanningCalendarView
.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sDescription | string |
New value for property |
Sets a new value for property intervalLabelFormatter.
A function that formats the interval.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oIntervalLabelFormatter | object |
New value for property |
Sets a new value for property intervalSize.
An integer that defines the period size.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 1
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iIntervalSize | int | 1 |
New value for property |
Sets a new value for property intervalsL.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is more than 1024 pixels wide.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 12
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iIntervalsL | int | 12 |
New value for property |
Sets a new value for property intervalsM.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is between 600 and 1024 pixels wide.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 8
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iIntervalsM | int | 8 |
New value for property |
Sets a new value for property intervalsS.
Defines the number of intervals that are displayed for a sap.m.PlanningCalendar that is less than 600 pixels wide. Note: On a phone the maximum visible intervals are 8.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 6
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iIntervalsS | int | 6 |
New value for property |
Sets a new value for property intervalType.
Determines the type of the intervals of the row.
Note: Not all predefined interval types are supported for this property. For more information, see the descriptions in the CalendarIntervalType enumeration.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Hour
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIntervalType | sap.ui.unified.CalendarIntervalType | Hour |
New value for property |
Sets a new value for property key.
Defines the key of the view. This must be set to identify the used view in the sap.m.PlanningCalendar.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sKey | string |
New value for property |
Sets a new value for property relative.
Defines if the view will be relative. NOTE: Relative views, can be only used with intervalType - Day and when used they need intervalSize and intervalLabelFormatter defined.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bRelative | boolean | false |
New value for property |
Sets a new value for property showSubIntervals.
If set, subintervals are displayed as lines in the rows.
Hour
.Day
, Week
and OneMonth
.Month
.When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowSubIntervals | boolean | false |
New value for property |