Skip to main content
Version: 8.1

Carousel Component Examples

Example 1

In this example we made two view containers. One is a coordinate container and the other is flex container, named generic_coordinate and generic_flex, respectively. Each has a Label component and a Cylindrical Tank component. The Label's text property shows the name of the view it is in. The Cylindrical Tank's value property shows a level above 20. The generic_flex view is set to display as a row. We did not adjust any other settings on these two generic screens.

Once the two view containers are set up, we can create the Carousel with the following properties and values:

PropertyValueStyle Category
props.views.0.viewPathgeneric_coordinateN/A
props.view.1.viewPathgeneric_flexN/A
props.autoplay.enabledtrueN/A
props.autoplay.pauseOnHovertrueN/A
props.appearance.useDefaultViewWidthfalseN/A
props.appearance.useDefaultViewHeightfalseN/A
props.appearance.dots.iconPath/system/images/material/crop_squareN/A
props.appearance.arrows.enabledtrueN/A
props.style.borderStylesolidborder
props.style.borderWidth1pxborder
props.style.backgroundColor#EFEFEFbackground

Example 2

In this example, we have set up a Carousel component that enables users to quickly move between four views showing valves and multistate buttons. The views must be created before the carousel, but it doesn't matter what the contents of the views are. You could use any combination of views including duplicates. Example 3 below describes setting up the views to scroll through in more detail.

They are named as follows in a Views - Test folder:

  • CarouselView
  • FirstView
  • SecondView
  • ThirdView
  • FourthView

The properties used for the Carousel component are as follows:

PropertyValueStyle Category
props.views.0.viewPathViews - Test/FirstViewN/A
props.views.1.viewPathViews - Test/SecondViewN/A
props.views.2.viewPathViews - Test/ThirdViewN/A
props.views.3.viewPathViews - Test/FourthViewN/A
props.autoplay.enabledfalseN/A
props.appearance.useDefaultViewWidthtrueN/A
props.appearance.useDefaultViewHeighttrueN/A
props.appearance.dots.enabledtrueN/A
props.appearance.dots.iconPathmaterial/adjustN/A
props.appearance.dots.styles.active.fillColor#0000D9N/A
props.appearance.arrows.enabledtrueN/A
props.appearance.arrows.next.iconPathmaterial/arrow_rightN/A
props.appearance.arrows.next.fillColor#0000D9N/A
props.appearance.arrows.previous.iconPathmaterial/arrow_leftN/A
props.appearance.arrows.previous.fillColor#0000D9N/A
props.style.borderStyleridgeborder
props.style.borderWidth5pxborder
props.style.borderRadius20border
props.style.borderColor#808080border

Example 3

This example demonstrates a more complex case of how to configure side scrolling using the Carousel component starting with the initial project setup.

Initial Project Setup

First we'll create three views for the carousel to scroll through.

  1. In the Project Browser, right-click on Views and select the NewFolder option. We named our folder Carousel Example.

  2. Right-click on the Carousel Example folder and select the NewView option.

    • Name: Motor
    • Layout: Coordinate
    • Page URL: unchecked

  3. Click Create View.

  4. Next, create a view parameter that we can use for the motor number. In the Property Editor under PARAMS, click on the Add View Parameter icon.

    1. Select value.

    2. Change key to Motor_Num.

    3. Change value to 1.

    4. Make sure the arrow icon is facing to the left, indicting this is an input parameter.

  5. Next, make a title that will change depending on the Motor that's being displayed. Drag a Label component onto the view.

  6. Bind the Label's text property to the view parameter as follows:

    1. Click the binding icon next to the text property.

    2. Select Expression as the binding type.

    3. Enter "Motor " +.

    4. Click the Property icon then scroll down and select the Motor_Num view parameter.

    5. Click OK. You'll now see the binding preview shows "Motor 1."

    6. Click OK to save the binding.

  7. Next, drag a Gauge component onto the view to display motor Amps.

  8. Align the Motor label centered above the Gauge component.

  9. In the Property Editor, expand the outerAxis properties. Change the properties as follows:

    • minValue: -50

    • maxValue: 100

  10. Now we'll set up an indirect tag binding using one of the motor tags in the Dairy simulator. (For more information on the Dairy simulator, see Programmable Device Simulator.) Select the Gauge component.

  11. In the Property Editor, click the binding icon next to the value property. On the Configure Tag Binding page set the following:

    1. Choose Tag as the binding type.

    2. Select the Indirect option.

    3. Next to the Tag Path field, click on the Tag icon and navigate to the the Motor 1/Amps tag in the Dairy simulator program.

    4. Click OK.

    5. In the Tag Path field, replace the 1 with {1}.

    6. In the References list, under Property, click on the Functions icon.

    7. Click the Properties icon.

    8. Scroll to the view params folder and select Motor_Num. Click OK.

    9. Click OK again. You'll see the binding in the preview area.

    10. Click OK to save the binding.

  12. Confirm the Gauge now displays the value of the Amps tag.

  13. Drag a Label component onto your view. Place it under the Gauge component and change the text property to AMPS.

  14. Drag another Label component onto your view and place it next to the AMPS label. We'll set up a similar indirect tag binding on this label.

  15. Select the second Label click the binding icon next to the value property.

    1. Select Tag as the binding type and click the Indirect radio button.

    2. Next to the Tag Path field, click on the Tag icon and navigate to the the Motor 1/Amps Tag in the Dairy simulator program.

    3. Click OK.

    4. In the Tag Path field, replace the 1 with {1}.

    5. In the References list, under Property, click on the Functions icon.

    6. Click the Properties icon.

    7. Scroll to the view params folder and select Motor_Num. Click OK.

    8. Click Apply. You'll see the binding in the preview area.

    9. For this Label component we don't want the full tag value displayed. So we'll add a Transform to limit it to two decimal points. Click on Add Transform.

    10. Select Format, then click Add Transform.

    11. Select Numeric as the Format type. The displayed value will now be shortened to just two decimal points. You can see the format in the Binding Preview.

    12. Click OK to save the binding.

Now we'll set up a view that holds the Carousel component.

  1. Right-click on the Carousel Example folder and select the NewView option.

  2. Name the view Carousel Overview. Check the Page URL option.

  3. Click Create View.

  4. Drag a Carousel component onto the view.

  5. In the Property Editor, click the Expand icon in expand the props.views.0.viewPath property and select the Motor view.

  6. Under viewParams, click the Add icon then choose value.

  7. Replace key with Motor_Num and replace value with 1.

  8. Click OK. The Motor view now appears in the Carousel component. You may need to expand your Carousel component slightly to fit the Motor view in without scrollbars.

  9. Next, we'll add two more views. Click on the Add icon two times for the Property Editor's views property.

  10. Under the props.views.1.viewPath property, choose the Motor view.

    1. Under viewParams, click the Add icon then choose value.
    2. Replace key with Motor_Num and replace value with 2. This will point this instance to the Motor 2/AMPS Tag.
    3. Click OK.
  11. Under the props.views.2.viewPath property, choose the Motor view.

    1. Under viewParams, click the Add icon then choose value.
    2. Replace key with Motor_Num and replace value with 3. This will point this instance to the Motor 3/AMPS Tag.
    3. Click OK.
  12. Save your project.

  13. Put the Designer into Preview mode. Click the left and right arrows or the dots to scroll between the three Motor views.

  14. Lastly, we decided to change a few properties on the Carousel to update the appearance. Here are the settings we used:

PropertyValue
props.appearance.dots.enabledfalse
props.appearance.arrows.next.iconPathmaterial/navigate_next
props.appearance.arrows.next.fillColor#AC00AC
props.appearance.arrows.previous.iconPathmaterial/navigate_before
props.appearance.arrows.previous.fillColor#AC00AC
props.style.borderStyleoutset
props.style.borderColor#AC00AC
props.style.borderWidth7
props.style.borderTopLeftRadius15
props.style.borderTopRightRadius15
props.style.borderBottomLeftRadius15
props.style.borderBottomRightRadius15