Aspect ratio selection directive
The aspect ratio selection enables you to display and retrieve selected width, height, and aspect ratio.
The settings you select are kept in an object variable that has width, height, and aspectRatio properties. The default template renders four options for aspect ratio - Auto, 4x3, 16x9, Custom. When Auto is selected, you can not edit width and height. When 4x3 or 16x9 aspect ratio option is selected, when you edit the width or height, the other field will also change to fit in the selected aspect ratio.
You can use the aspect ratio selection in the frontend, as well as in the backend. For example, on a page, as well as in a widget designer.
The sfAspectRatioSelection is a directive with an isolated scope that is defined in a module with the same name: sfAspectRatioSelection.
For more information, see Isolating the Scope of a Directive
Attributes
The sfAspectRatioSelection directive exposes the following attributes:
| Attribute |
Description |
sf-model
|
Accepts a scope variable that holds the selected width, height and aspect ratio. |
sf-template-url
|
Allows you to override the template of the aspect ratio selection. |
sf-template-assembly
|
Specifies the assembly where the template of the aspect ratio selection is located. |
Add the aspect ratio selection directive
The following example demonstrates how to add a aspect ratio selection directive in a widget designer's view.
To enable AngularJS to link the sfAspectRatioSelection directive in your custom designer view, you must load the script of the directive and add a dependency to the module.
Perform the following:
- Sitefinity CMS automatically registers the scripts you need and, if no other designer view with explicitly set priority exists, Sitefinity CMS sets your designer view priority 1. In case you need to have full control over the scripts that are loaded or you want to set custom priority, you can alternatively create your own
DesignerView.YourView.json file. If you have a JSON file that matches the convention (even if empty), this automatic scripts registration will not occur. In your DesignerView.YourView.json file, add a scripts array.
Use the following code:
- In your
designerview-yourview.js file, place the following code snippet:
The code above shows an aspect ratio selection that enables you to select and edit aspect ratio, width and height. The selected values are kept in the aspectRatioModel object.
- In your
DesignerView.YourView.cshtml file, place the following tag where you want to render the sfAspectRatioSelection directive: