--- schema_version: "1" id: 9e04ea95e9db4452ce283b7272231f4028f8df9ab243e7cfb23a9468a2fb09d7 title: Canvas Layout Component collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_responses_canvas_layout_component.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_canvas_layout_component.htm source_site: developer.salesforce.com content_type: documentation content_hash: 03e600a32901fc65c82f39a2278c770a91ba434b94643009799e060b7ae15e1e description: A canvas component on a record page layout. --- # Canvas Layout Component A canvas component on a record page layout.
Property Name Type Description Filter Group and Version Available Version
apiName String The API name of the canvas app. Small, 41.0 41.0
componentType String The value is Canvas. Small, 41.0 41.0
displayLocation String The location in the application where the canvas app is being called from. One of these values:
  • Chatter—The canvas app was called from the Chatter tab.
  • ChatterFeed—The canvas app was called from a Chatter canvas feed item.
  • MobileNav—The canvas app was called from the navigation menu in the Salesforce mobile app.
  • OpenCTI—The canvas app was called from an Open CTI component.
  • PageLayout—The canvas app was called from an element within a page layout. If the displayLocation is PageLayout, one of the subLocation values can be returned.
  • Publisher—The canvas app was called from a canvas custom quick action.
  • ServiceDesk—The canvas app was called from a Salesforce Console component.
  • Visualforce—The canvas app was called from a Visualforce page.
  • None—The canvas app was called from the Canvas App Previewer.

The sublocation in the application where the canvas app was called from when the canvas app is loaded in a mobile device. The possible values are:

  • S1MobileCardFullview—The canvas app was called from a mobile card.
  • S1MobileCardPreview—The canvas app was called from a mobile card preview.
  • S1RecordHomePreview—The canvas app was called from a record detail page preview.
  • S1RecordHomeFullview—The canvas app was called from a page layout.
Small, 41.0 41.0
height String The height of the component. Small, 41.0 41.0
referenceId String The unique ID of the canvas app definition. Small, 41.0 41.0
showScroll Boolean Indicates whether to show the scroll bar on the canvas component (true) or not (false). Small, 41.0 41.0
width String The width of the component. Small, 41.0 41.0
#### See Also - [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")