How to set display settings for your floor plan drawings over the Measure Square Cloud API
In this article, you will learn how to customize the appearance of your diagrams when generating them through the MeasureSquare Cloud API.
The Get Layer Image endpoint allows you to retrieve visual representations of your project diagrams as PNG images. This endpoint is particularly useful when you need to embed diagrams in web pages, documents, or reports, and want control over the image size and how much details is shown.
Endpoint
GET /api/projects/{projectId}/layers/{layerIndex}/image
Use Cases
Below are examples of situations where you may want to use the Get Layer Image endpoint:
- Embedding floor plan diagrams in web applications or customer portals
- Generating printable reports with appropriately sized diagrams
- Creating thumbnail previews of project layers
- Displaying simplified floor plans without technical details
- Showing or hiding underlayment products based on audience needs
Customization Options
Image Size (width and height)
Control the dimensions of the returned image to fit your presentation needs:
- Large images (e.g., 1920×1080): Ideal for detailed reports or full-screen displays
- Medium images (e.g., 800×600): Suitable for web page embedding or standard documents
- Thumbnails (e.g., 300×200): Perfect for preview galleries or compact displays
Adjusting image size is useful when you want to reduce file size for faster loading or when display space is limited.
Dimension Labels (showDimensions)
Optional parameter. Set to False to hide dimension labels. If this is not provided in your API request, this is set to True by default.
Underlayment Products (showUnderlays)
Optional parameter. Set to false to hide underlayment layer. If this is not provided in your API request, this is set to True by default.
Show underlayment (true): Displays all underlayment products in the diagram
Hide underlayment (false): Simplifies the view to show only the main floor plan products.
Related Articles
How do I access my API key?
This article applies to the MeasureSquare Cloud. This article will show you how to access your API Key via the Cloud at cloud.measuresquare.com. If you do not already have a group set up in Measure Square Cloud, then to begin you must contact Measure ...How do I manage my Group settings in the Cloud?
This article is going to explain how to manage your group settings from the cloud at cloud.measuresquare.com. To start you must contact Measure Square Support and request they create a group for your account. Followed by adding other accounts to your ...How do I manage my Group settings in the Cloud?
This article is going to explain how to manage your group settings from the cloud at cloud.measuresquare.com. To start you must contact Measure Square Support and request they create a group for your account. Followed by adding other accounts to your ...How do I turn off the underlay view option on Measure Square Mobile for iPad?
In this article, we will show you how to turn off the underlay view option on Measure Square Mobile for iPad. This article applies to Measure Square Mobile for iPad Build 2.6.0 and newer. After applying your products you can remove the view for ...Learn how RollMaster integrates with Measure Square!
This integration works with all versions of MeasureSquare 8, iPad & Android Mobile. This video will show you how RollMaster & Measure Square talk to each other via the Cloud! See how to export job info to Measure Square, and how to import & update ...