class sap.ui.vk.ContentResource

Control sample: sap.ui.vk.ContentResource
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/ContentResource
Application Component: CA-UI5-VTK

Specifies a resource to load.


Constructor

Constructor for a new ContentResource.

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.ui.vk.ContentResource(sId?, mSettings?, oScope?)
Param Type Default Value Description
sId? string

ID of the new content resource. sIdis generated automatically if no non-empty ID is given. Note: this can be omitted, regardless of whether mSettings will be provided or not.

mSettings? object

An optional map/JSON object with initial property values, aggregated objects etc. for the new content resource.

oScope? object

scope An object for resolving string-based type and formatter references in bindings.


Properties

Name Type Default Value Description
activateView string

Optional parameter with view id which shall be activated when scene is loaded.

Visibility: public
enableLogger boolean false

Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.

Visibility: public
includeAnimation boolean true

Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.

Visibility: public
includeBackground boolean true

If set to true, will return nodes with the type background

Visibility: public
includeHidden boolean true

Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.

Visibility: public
includeParametric boolean true

If set to true, will load parametric nodes

Visibility: public
includeUsageId sap.ui.vk.IncludeUsageIdType false

Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.

Visibility: public
localMatrix sap.ui.vk.TransformationMatrix

The local transformation matrix of the node created for this content resource.

Visibility: public
metadataFilter string

Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.

Visibility: public
name string

The name of the node created for this content resource.

Visibility: public
password string

The password to use when opening the resource.

Visibility: public
pushPMI boolean false

If set to true, elements for PMI rendering content will be returned. Default: false.

Visibility: public
pushViewGroups boolean true

If set to true, information of view groups will be returned. Default: true.

Visibility: public
source any

The source URL or the File object of the content resource/file to load from. The source may be omitted if a grouping node is needed.

Visibility: public
sourceId string

The unique ID of the content resource.

Visibility: public
sourceType string

The source type of the content resource. Valid types:

  • vds
  • vds4
  • svg
  • png
  • jpg
  • jpeg
  • gif
  • bmp
  • tif*
  • tiff*
  • stream
The source type may be omitted if this is a grouping content node.
NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.

Visibility: public
useSecureConnection boolean true

If set to false, unsecure connections will be used. Default: true.

Visibility: public
veid string

Id of scene to retrieve tree for. Mandatory for the stream source type.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
contentResources 0..n sap.ui.vk.ContentResource

Child content resources.


Methods Overview

Method Description
addContentResource

Adds some contentResource to the aggregation contentResources.

sap.ui.vk.ContentResource.collectCategories

Collects content resource categories. The result is tested if the content resource hierarchy has the same category - 2D or 3D.

destroyContentResources

Destroys all the contentResources in the aggregation contentResources.

sap.ui.vk.ContentResource.extend

Creates a new subclass of class sap.ui.vk.ContentResource 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.base.ManagedObject.extend.

getActivateView

Gets current value of property activateView.

Optional parameter with view id which shall be activated when scene is loaded.

getContentResources

Gets content of aggregation contentResources.

Child content resources.

getEnableLogger

Gets current value of property enableLogger.

Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.

Default value is false.

getIncludeAnimation

Gets current value of property includeAnimation.

Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.

Default value is true.

getIncludeBackground

Gets current value of property includeBackground.

If set to true, will return nodes with the type background

Default value is true.

getIncludeHidden

Gets current value of property includeHidden.

Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.

Default value is true.

getIncludeParametric

Gets current value of property includeParametric.

If set to true, will load parametric nodes

Default value is true.

getIncludeUsageId

Gets current value of property includeUsageId.

Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.

Default value is false.

getLocalMatrix

Gets current value of property localMatrix.

The local transformation matrix of the node created for this content resource.

sap.ui.vk.ContentResource.getMetadata

Returns a metadata object for class sap.ui.vk.ContentResource.

getMetadataFilter

Gets current value of property metadataFilter.

Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.

getName

Gets current value of property name.

The name of the node created for this content resource.

getNodeProxy

Gets the NodeProxy object created for this content resource.

If this is the only top level content resource, the NodeProxy object is not set since the grouping node is not created, which means that there may be multiple top level nodes.

getPassword

Gets current value of property password.

The password to use when opening the resource.

getPushPMI

Gets current value of property pushPMI.

If set to true, elements for PMI rendering content will be returned. Default: false.

Default value is false.

getPushViewGroups

Gets current value of property pushViewGroups.

If set to true, information of view groups will be returned. Default: true.

Default value is true.

getSource

Gets current value of property source.

The source URL or the File object of the content resource/file to load from. The source may be omitted if a grouping node is needed.

getSourceId

Gets current value of property sourceId.

The unique ID of the content resource.

getSourceProperties

Gets content resource source properties.

The content resource source properties depend on the content resource source type. They are different for VDS and PNG for example. The list of possible source properties:

  • version - object
    • major - number
    • minor - number
  • compressed - boolean
  • encrypted - boolean
The source properties are optional and the list might be extended in future versions.

getSourceType

Gets current value of property sourceType.

The source type of the content resource. Valid types:

  • vds
  • vds4
  • svg
  • png
  • jpg
  • jpeg
  • gif
  • bmp
  • tif*
  • tiff*
  • stream
The source type may be omitted if this is a grouping content node.
NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.

getUseSecureConnection

Gets current value of property useSecureConnection.

If set to false, unsecure connections will be used. Default: true.

Default value is true.

getVeid

Gets current value of property veid.

Id of scene to retrieve tree for. Mandatory for the stream source type.

indexOfContentResource

Checks for the provided sap.ui.vk.ContentResource in the aggregation contentResources. and returns its index if found or -1 otherwise.

insertContentResource

Inserts a contentResource into the aggregation contentResources.

removeAllContentResources

Removes all the controls from the aggregation contentResources.

Additionally, it unregisters them from the hosting UIArea.

removeContentResource

Removes a contentResource from the aggregation contentResources.

setActivateView

Sets a new value for property activateView.

Optional parameter with view id which shall be activated when scene is loaded.

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

setEnableLogger

Sets a new value for property enableLogger.

Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.

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

Default value is false.

setIncludeAnimation

Sets a new value for property includeAnimation.

Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.

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

Default value is true.

setIncludeBackground

Sets a new value for property includeBackground.

If set to true, will return nodes with the type background

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

Default value is true.

setIncludeHidden

Sets a new value for property includeHidden.

Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.

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

Default value is true.

setIncludeParametric

Sets a new value for property includeParametric.

If set to true, will load parametric nodes

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

Default value is true.

setIncludeUsageId

Sets a new value for property includeUsageId.

Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.

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

Default value is false.

setLocalMatrix

Sets a new value for property localMatrix.

The local transformation matrix of the node created for this content resource.

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

setMetadataFilter

Sets a new value for property metadataFilter.

Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.

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

setName

Sets a new value for property name.

The name of the node created for this content resource.

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

setPassword

Sets a new value for property password.

The password to use when opening the resource.

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

setPushPMI

Sets a new value for property pushPMI.

If set to true, elements for PMI rendering content will be returned. Default: false.

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

Default value is false.

setPushViewGroups

Sets a new value for property pushViewGroups.

If set to true, information of view groups will be returned. Default: true.

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

Default value is true.

setSource

Sets a new value for property source.

The source URL or the File object of the content resource/file to load from. The source may be omitted if a grouping node is needed.

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

setSourceId

Sets a new value for property sourceId.

The unique ID of the content resource.

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

setSourceType

Sets a new value for property sourceType.

The source type of the content resource. Valid types:

  • vds
  • vds4
  • svg
  • png
  • jpg
  • jpeg
  • gif
  • bmp
  • tif*
  • tiff*
  • stream
The source type may be omitted if this is a grouping content node.
NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.

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

setUseSecureConnection

Sets a new value for property useSecureConnection.

If set to false, unsecure connections will be used. Default: true.

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

Default value is true.

setVeid

Sets a new value for property veid.

Id of scene to retrieve tree for. Mandatory for the stream source type.

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

addContentResource

Adds some contentResource to the aggregation contentResources.

Param Type DefaultValue Description
oContentResource sap.ui.vk.ContentResource

The contentResource to add; if empty, nothing is inserted

sap.ui.vk.ContentResource.collectCategories

Collects content resource categories. The result is tested if the content resource hierarchy has the same category - 2D or 3D.

Param Type DefaultValue Description
resources sap.ui.vk.ContentResource[]

The array of content resources.

destroyContentResources

Destroys all the contentResources in the aggregation contentResources.

sap.ui.vk.ContentResource.extend

Creates a new subclass of class sap.ui.vk.ContentResource 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.base.ManagedObject.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

getActivateView

Gets current value of property activateView.

Optional parameter with view id which shall be activated when scene is loaded.

getContentResources

Gets content of aggregation contentResources.

Child content resources.

getEnableLogger

Gets current value of property enableLogger.

Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.

Default value is false.

getIncludeAnimation

Gets current value of property includeAnimation.

Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.

Default value is true.

getIncludeBackground

Gets current value of property includeBackground.

If set to true, will return nodes with the type background

Default value is true.

getIncludeHidden

Gets current value of property includeHidden.

Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.

Default value is true.

getIncludeParametric

Gets current value of property includeParametric.

If set to true, will load parametric nodes

Default value is true.

getIncludeUsageId

Gets current value of property includeUsageId.

Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.

Default value is false.

getLocalMatrix

Gets current value of property localMatrix.

The local transformation matrix of the node created for this content resource.

sap.ui.vk.ContentResource.getMetadata

Returns a metadata object for class sap.ui.vk.ContentResource.

getMetadataFilter

Gets current value of property metadataFilter.

Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.

getName

Gets current value of property name.

The name of the node created for this content resource.

getNodeProxy

Gets the NodeProxy object created for this content resource.

If this is the only top level content resource, the NodeProxy object is not set since the grouping node is not created, which means that there may be multiple top level nodes.

getPassword

Gets current value of property password.

The password to use when opening the resource.

getPushPMI

Gets current value of property pushPMI.

If set to true, elements for PMI rendering content will be returned. Default: false.

Default value is false.

getPushViewGroups

Gets current value of property pushViewGroups.

If set to true, information of view groups will be returned. Default: true.

Default value is true.

getSource

Gets current value of property source.

The source URL or the File object of the content resource/file to load from. The source may be omitted if a grouping node is needed.

getSourceId

Gets current value of property sourceId.

The unique ID of the content resource.

getSourceProperties

Gets content resource source properties.

The content resource source properties depend on the content resource source type. They are different for VDS and PNG for example. The list of possible source properties:

The source properties are optional and the list might be extended in future versions.

getSourceType

Gets current value of property sourceType.

The source type of the content resource. Valid types:

The source type may be omitted if this is a grouping content node.
NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.

getUseSecureConnection

Gets current value of property useSecureConnection.

If set to false, unsecure connections will be used. Default: true.

Default value is true.

getVeid

Gets current value of property veid.

Id of scene to retrieve tree for. Mandatory for the stream source type.

indexOfContentResource

Checks for the provided sap.ui.vk.ContentResource in the aggregation contentResources. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContentResource sap.ui.vk.ContentResource

The contentResource whose index is looked for

insertContentResource

Inserts a contentResource into the aggregation contentResources.

Param Type DefaultValue Description
oContentResource sap.ui.vk.ContentResource

The contentResource to insert; if empty, nothing is inserted

iIndex int

The 0-based index the contentResource should be inserted at; for a negative value of iIndex, the contentResource is inserted at position 0; for a value greater than the current size of the aggregation, the contentResource is inserted at the last position

removeAllContentResources

Removes all the controls from the aggregation contentResources.

Additionally, it unregisters them from the hosting UIArea.

removeContentResource

Removes a contentResource from the aggregation contentResources.

Param Type DefaultValue Description
vContentResource int string sap.ui.vk.ContentResource

The contentResource to remove or its index or id

setActivateView

Sets a new value for property activateView.

Optional parameter with view id which shall be activated when scene is loaded.

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

Param Type DefaultValue Description
sActivateView string

New value for property activateView

setEnableLogger

Sets a new value for property enableLogger.

Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.

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
bEnableLogger boolean false

New value for property enableLogger

setIncludeAnimation

Sets a new value for property includeAnimation.

Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.

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

Default value is true.

Param Type DefaultValue Description
bIncludeAnimation boolean true

New value for property includeAnimation

setIncludeBackground

Sets a new value for property includeBackground.

If set to true, will return nodes with the type background

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

Default value is true.

Param Type DefaultValue Description
bIncludeBackground boolean true

New value for property includeBackground

setIncludeHidden

Sets a new value for property includeHidden.

Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.

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

Default value is true.

Param Type DefaultValue Description
bIncludeHidden boolean true

New value for property includeHidden

setIncludeParametric

Sets a new value for property includeParametric.

If set to true, will load parametric nodes

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

Default value is true.

Param Type DefaultValue Description
bIncludeParametric boolean true

New value for property includeParametric

setIncludeUsageId

Sets a new value for property includeUsageId.

Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.

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
sIncludeUsageId sap.ui.vk.IncludeUsageIdType false

New value for property includeUsageId

setLocalMatrix

Sets a new value for property localMatrix.

The local transformation matrix of the node created for this content resource.

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

Param Type DefaultValue Description
sLocalMatrix sap.ui.vk.TransformationMatrix

New value for property localMatrix

setMetadataFilter

Sets a new value for property metadataFilter.

Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.

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

Param Type DefaultValue Description
sMetadataFilter string

New value for property metadataFilter

setName

Sets a new value for property name.

The name of the node created for this content resource.

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

Param Type DefaultValue Description
sName string

New value for property name

setPassword

Sets a new value for property password.

The password to use when opening the resource.

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

Param Type DefaultValue Description
sPassword string

New value for property password

setPushPMI

Sets a new value for property pushPMI.

If set to true, elements for PMI rendering content will be returned. Default: false.

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
bPushPMI boolean false

New value for property pushPMI

setPushViewGroups

Sets a new value for property pushViewGroups.

If set to true, information of view groups will be returned. Default: true.

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

Default value is true.

Param Type DefaultValue Description
bPushViewGroups boolean true

New value for property pushViewGroups

setSource

Sets a new value for property source.

The source URL or the File object of the content resource/file to load from. The source may be omitted if a grouping node is needed.

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

Param Type DefaultValue Description
oSource any

New value for property source

setSourceId

Sets a new value for property sourceId.

The unique ID of the content resource.

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

Param Type DefaultValue Description
sSourceId string

New value for property sourceId

setSourceType

Sets a new value for property sourceType.

The source type of the content resource. Valid types:

The source type may be omitted if this is a grouping content node.
NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.

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

Param Type DefaultValue Description
sSourceType string

New value for property sourceType

setUseSecureConnection

Sets a new value for property useSecureConnection.

If set to false, unsecure connections will be used. Default: true.

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

Default value is true.

Param Type DefaultValue Description
bUseSecureConnection boolean true

New value for property useSecureConnection

setVeid

Sets a new value for property veid.

Id of scene to retrieve tree for. Mandatory for the stream source type.

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

Param Type DefaultValue Description
sVeid string

New value for property veid