Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

There may be situations where you may need a customized view for 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 for a particular dashboard. However, if you do not require a custom theme for your dashboard you can simply use the default theme that is provided.

Follow the instructions below to create a custom theme per dashboard:

  1. Create a custom theme file.
    Create a custom theme file as a Carbon archive file, which has the .car extension. The artifact type of the theme file should be dashboards/theme.
    For example, the artifact.xml file for a custom theme is as follows:

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

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

    Code Block
    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. Choose the Carbon Application Artifact (.car) file and upload it.
Info

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.