WSO2 Data Analytics Server is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

Generally, you can use the default theme to create a dashboard. However, there may be situations where you may need a customized view of a particular dashboard, and need to maintain different custom themes per dashboard. In such situations, you can create your own custom theme and apply it to a particular dashboard. 

Creating a custom theme for a specific dashboard

Follow the instructions below to create a custom theme for a specific dashboard:

  1. Create a custom theme file.
    Create a custom theme file as a Carbon archive file, which has the .car extension (e.g., Custom-Theme.car). Use dashboards/theme as the artifact type of the theme file.
    For example, the artifact.xml file for a custom theme is as follows:

    <artifact name="custom-theme-sample" version="1.0.0" type="dashboards/theme" serverRole="DataAnalyticsServer">
            <file>custom-theme-sample</file>
    </artifact>

    The folder structure for the custom theme file is as follows:

    css  
    js    -----
            ues.js
            ues-prefs.js
            ues-gadgets.js
            ues-dashboards.js
            gadget-properties.js
            gadget-handlebar-helpers.js
            dashboard.js
            ds-ajax-api.js
    templates ---
            includes ----
                    portal-header.jag
                    portal-footer.jag
                    control-panel.jag
                    light-dark-switcher.jag
                    project-title.jag


    The css folder can contain any stylesheets with the .css extension. However, the js and template folders should contain the files defined in the above structure.

  2. Deploy the custom theme.

    1. Sign into the WSO2 Data Analytics Server (WSO2 DAS) Management Console.
      https://<hostname>:9443/carbon

    2. Click Main, navigate to Carbon Application and click Add.
    3. Select the Carbon Application Artifact (.car) file and upload it.

      The uploaded custom theme appears as follows:

Applying the custom theme to a dashboard

You can use one of the following methods to apply your custom theme to a specific dashboard.

  • When creating a dashboard, you can select the your custom theme.
  • You can also change the existing theme of a dashboard via the settings view of that respective dashboard.

After creating a custom dashboard theme and applying the theme, you can preview the final view of the dashboard using the dashboard view option.

  • No labels