Search results

Members

serverUrl

string

Your Bold BI application URL needs to be assigned to this member.


Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         serverUrl: "https://mydashboard.com/bi/site/site1",
    });
    dashboard.loadDashboard();

    dashboardId

    string

    The Id of the dashboard, which needs to be embedded in a page from your Bold BI application.


    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         dashboardId: "5cb065f7-dabb-4b0c-9b45-c60a5730e963"                
    });
    dashboard.loadDashboard();

    dashboardPath

    string

    This will hold the dashboard path as category name followed by dashboard name.


    Syntax

  • /{category-name}/{dashboard-name}


  • Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         dashboardPath: "/Samples/Sample Dashboard"
    });
    dashboard.loadDashboard();

    pinboardName

    string

    The name of the pinboard that needs to be embedded in a page from your Bold BI application.


    Default value : empty

  • ""

  • Example

    var pinboard = BoldBI.create({
         pinboardName: "Pinboard Name"                
    });
    pinboard.loadPinboard();

    embedContainerId

    string

    The Id of a div element in which the dashboard will be initialized and rendered.


    Default value : empty

  • ""

  • Example

    <div id="container"></div> 
    <script> 
         // Embed Dashboard 
         var dashboard = BoldBI.create({
              embedContainerId: "container",        
         });
         dashboard.loadDashboard();
    </script>

    embedType

    object

    Providing the two types of embedding. One is component and the other is iframe. In component type, you will use the embedding SDK for rendering the dashboard. In iframe type, you will load the dashboard URL in the iframe and the dashboard will be rendered.


    Possible values

  • BoldBI.EmbedType.Component
  • BoldBI.EmbedType.IFrame


  • Default value

  • BoldBI.EmbedType.Component

  • Example

    var dashboard = BoldBI.create({
         embedType: BoldBI.EmbedType.Component,        
    });
    dashboard.loadDashboard();

    environment

    object

    Environment refers to the Bold BI application type. Bold BI offers Cloud and Enterprise editions of the dashboard application. You need to assign your application type in this member.


    Possible values

  • BoldBI.Environment.Cloud
  • BoldBI.Environment.Enterprise


  • Default value

  • BoldBI.Environment.Enterprise

  • Example

    var dashboard = BoldBI.create({
         environment: BoldBI.Environment.Enterprise,        
    });
    dashboard.loadDashboard();

    mode

    object

    Mode refers to the dashboard rendering mode such as view, design, connection, and datasource. The default value was view, which is used to render the dashboard for viewing.


    Possible values

  • BoldBI.Mode.View
  • BoldBI.Mode.Design
  • BoldBI.Mode.Connection
  • BoldBI.Mode.DataSource


  • Default value

  • BoldBI.Mode.View

  • Example

    var dashboard = BoldBI.create({
         mode: BoldBI.Mode.View,        
    });
    dashboard.loadDashboard();

    Set a Culture for the Current User in Embedding

    You can set a culture for the current user using the API in embedding. For example, if you configure the widget to showcase the currency value, it will be displayed with Auto (English(en-US)) format by default as shown in the following image.

    Default Curreny Culture

    And the values in the widget will be rendered as follows,

    Default Curreny Culture Grid

    You can embed the Bold BI dashboards in your web page by following the steps in this link.

    After embedding the dashboard, you can change the culture settings on the embedding dashboard instance to get the desired currency format by passing it using the following highlighted API.

    Culture Settings API

    After this, the values in the widget will be displayed as follows within your application.

    Modified Currency Culture

    dashboardSettings

    dashboardSettings.showHeader

    boolean

    Enable or disable the header panel in the Dashboard Viewer.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              showHeader: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.showExport

    boolean

    Specifies whether to show or hide the Export icon in dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              showExport: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.showRefresh

    boolean

    Specifies whether to show or hide the Refresh icon in dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              showRefresh: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.showMoreOption

    boolean

    Specifies whether to show or hide the Option icon in dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              showMoreOption: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.enableTheme

    boolean

    Specifies whether to show or hide the Theme icon in the dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              enableTheme: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.enableFilterOverview

    boolean

    Specifies whether to show or hide the Filter Overview icon in the dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              enableFilterOverview: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.enableFullScreen

    boolean

    Specifies whether to show or hide the Full Screen icon in dashboard banner.


    Default value

  • false

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              enableFullScreen: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.showDashboardParameter

    boolean

    Specifies whether to show or hide the Dashboard Parameter icon in dashboard banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              showDashboardParameter: true,
         }
    });
    dashboard.loadDashboard();

    dashboardSettings.dashboardName


    Specifies whether or not to update the Dashboards’ Name in the Header Section.

    Dashboard

    string

    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
              dashboardName: "name",
         }
    });
    dashboard.loadDashboard();

    Specifies the unique id of the dashboard if it is present within the multi-tab dashboard and mention the Name in which dashboard to be rendered.

    Multi-Tabbed Dashboard

    array

    Default value

  • []

  • Example

    var dashboard = BoldBI.create({
         dashboardSettings: {
           dashboardName: [
            { dashboardId: "fb63ae99-83b6-4752-97b7-890182a3729f", dashboardName: "value 1" },
            { dashboardId: "77fd95ce-ec8b-4f68-817c-f41cabfabd3a", dashboardName: "value 2" }  
           ]
         }
    });
    dashboard.loadDashboard();

    widgetSettings

    widgetSettings.showExport

    boolean

    Specifies whether to show or hide the Export icon in widget banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         widgetSettings: {
              showExport: true,
         }
    });
    dashboard.loadDashboard();

    widgetSettings.showMoreOption

    boolean

    Specifies whether to show or hide the Option icon in widget banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         widgetSettings: {
              showMoreOption: true,
         }
    });
    dashboard.loadDashboard();

    widgetSettings.showFilter

    boolean

    Specifies whether to show or hide the Clear Filter icon in widget banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         widgetSettings: {
              showFilter: true,
         }
    });
    dashboard.loadDashboard();

    widgetSettings.showMaximize

    boolean

    Specifies whether to show or hide the Maximize icon in widget banner.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         widgetSettings: {
              showMaximize: true,
         }
    });
    dashboard.loadDashboard();

    filterParameters

    string

    Specifies the filter that has to be applied to the dashboard.


    Default value

  • ""

  • Example

    var dashboard = BoldBI.create({
         filterParameters: "Continent=Asia,Africa,Europe"
    });
    dashboard.loadDashboard();

    dynamicConnection

    Dashboard server provides dynamic connection string feature to fetch the data for rendering the dashboard.

    dynamicConnection.isEnabled

    boolean

    Specifies whether to enable or disable the dynamic connection string feature.


    Default value

  • false

  • Example

    var dashboard = BoldBI.create({
         dynamicConnection: {
              isEnabled: false,
         }
    });
    dashboard.loadDashboard();

    dynamicConnection.identity

    boolean

    This property, holds the values that will be passed to the API in dynamic connection string feature so that the user can use this identity in their API for validating and providing the required connection string.


    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({     
         dynamicConnection: {
              isEnabled: true,
              identity: "",
         }
    });
    dashboard.loadDashboard();

    exportSettings

    exportSettings.showExcel

    boolean

    Specifies whether to show or hide the Excel export option.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         exportSettings: {
              showExcel: true,
         }
    });
    dashboard.loadDashboard();

    exportSettings.showPDF

    boolean

    Specifies whether to show or hide the PDF export option.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         exportSettings: {
              showPDF: true,
         }
    });
    dashboard.loadDashboard();

    exportSettings.showImage

    boolean

    Specifies whether to show or hide the Image export option.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         exportSettings: {
              showImage: true,
         }
    });
    dashboard.loadDashboard();

    exportSettings.showCSV

    boolean

    Specifies whether to show or hide the CSV export option.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         exportSettings: {
              showCSV: true,
         }
    });
    dashboard.loadDashboard();

    height

    string

    Set the height of the Dashboard Viewer in % or in pixels.


    Default value

  • 768px

  • Example

    var dashboard = BoldBI.create({
         height:"768px",
    });
    dashboard.loadDashboard();

    width

    string

    Set the width of the Dashboard Viewer in % or in pixels.


    Default value

  • 1024px

  • Example

    var dashboard = BoldBI.create({
         width:"1024px",
    });
    dashboard.loadDashboard();

    theme

    object

    Bold BI provides dark theming support for Dashboard Viewer. So, user can choose the desired theming for their choice.


    Default value

  • BoldBI.Theme.Light

  • Possible values

  • BoldBI.Theme.Light
  • BoldBI.Theme.Dark

  • Example

    var dashboard = BoldBI.create({
         theme:BoldBI.Theme.Dark,
    });
    dashboard.loadDashboard();

    authorizationServer

    authorizationServer.url

    string

    Any application that embeds Bold BI dashboard and widget needs to be authenticated with Bold BI server and this authentication flow requires sending the confidential information like user email, group details, and embed signature to the Bold BI server. So, you need to implement this authentication flow in your server application and provide the URL for connecting to your server in Bold BI embed instance.

    So this property holds the URL of the embedding application that will implement authorization. Learn more about the authorization server here.


    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         authorizationServer: {
              url:"https://serversample.com/embed-details/get",
         }
    });
    dashboard.loadDashboard();

    authorizationServer.headers

    object

    This property, holds the headers needs to be sent in your application while connecting to the authorization server.


    Default value

  • {}

  • Example

    var dashboard = BoldBI.create({
         authorizationServer:{
              headers: {
                   "Authorization": "Bearer eDIHDIJAdjakdnajdbaidhoasjasajnsJNININfsbfskdnskdnskdn"
              }
         }
    });
    dashboard.loadDashboard();

    expirationTime

    number

    Specifies the access token expiration time of the dashboard in seconds.


    Default value

  • 86400

  • Example

    var dashboard = BoldBI.create({
         expirationTime:100000,          
    });
    dashboard.loadDashboard();

    autoRefreshSettings

    The auto refresh allows you to configure the scheduled refreshing process of the dashboard. It is used to refresh the data based on the specified time.

    autoRefreshSettings.enabled

    boolean

    Specifies whether to enable or disable the autoRefreshSettings option.


    Default value

  • false

  • Example

    var dashboard = BoldBI.create({
         autoRefreshSettings:{
              enabled: false,
         }
    });
    dashboard.loadDashboard();

    hourlySchedule

    autoRefreshSettings.hourlySchedule.hours

    number

    Specifies the hourly time interval for auto refreshing of data.


    Default value

  • 0

  • Example

    var dashboard = BoldBI.create({
         autoRefreshSettings:{
              enabled: true,
              hourlySchedule: {
                   hours: 1,
              }
         }
    });
    dashboard.loadDashboard();

    autoRefreshSettings.hourlySchedule.minutes

    number

    Specifies the minute by minute time interval for auto refreshing of data.


    Default value

  • 0

  • Example

    var dashboard = BoldBI.create({
         autoRefreshSettings:{
              enabled: true,
              hourlySchedule: {
                   minutes: 10,
              }
         }
    });
    dashboard.loadDashboard();

    autoRefreshSettings.hourlySchedule.seconds

    number

    Specifies the second by second time interval for auto refreshing of data.


    Default value

  • 0

  • Example

    var dashboard = BoldBI.create({
         autoRefreshSettings:{
              enabled: true,
              hourlySchedule: {
                   seconds: 30,
              }
         }
    });
    dashboard.loadDashboard();

    localeSettings

    The locale allows you to change the localization of the dashboard. It is used to change the data based on the specified localization.

    localeSettings.culture

    string

    This property holds the values that will be passed to the dashboard in order to change the culture of dashboard.


    Default value

  • en-US

  • Example

    var dashboard = BoldBI.create({
         localeSettings:{
              culture: "en-US",
         }
    });
    dashboard.loadDashboard();

    pinboardSettings

    pinboardSettings.enablePinboardHeader

    boolean

    Enable or disable the header panel in the pinboard.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         pinboardSettings: {
              enablePinboardHeader: true,
         }
    });
    dashboard.loadPinboard();

    pinboardSettings.enableUnpinWidget

    boolean

    Enable or disable the unPin option from the Pinboard.


    Default value

  • true

  • Example

    var dashboard = BoldBI.create({
         pinboardSettings: {
              enableUnpinWidget: true,
         }
    });
    dashboard.loadPinboard();

    designCanvasSettings

    designCanvasSettings.margin

    integer

    Customize the dashboard margins with the corresponding integer values.


    Default value

  • null

  • Example

    var dashboard = BoldBI.create({
         designCanvasSettings: {
              margin: null,
         }
    });
    dashboard.loadDesigner();

    widgetContainerSettings

    widgetContainerSettings.margin

    integer

    Customize the widget margins with the corresponding integer values.

    NOTE: It is not necessary to specify the px suffix. It support only integer values.


    Default value

  • null

  • Example

    var dashboard = BoldBI.create({
         widgetContainerSettings: {
              margin: null,
         }
    });
    dashboard.loadDesigner();

    widgetContainerSettings.boxShadow

    string

    Customize the box-shadow of the widgets.


    Default value

  • null

  • Example

    var dashboard = BoldBI.create({
         widgetContainerSettings: {
              boxShadow: null,
         }
    });
    dashboard.loadDesigner();

    data sources

    datasources

    array

    This property is used to add the multiple data sources in the designer page.

    Example

    var dashboard = BoldBI.create({
         datasources: [
              {"id": "348e414b-c8c6-4542-839a-2e12934fe64f", "canDelete" : false},  
              {"id": "d9a28bba-e6dd-46c9-89d7-810ebb4796b3", "canDelete" : true}
         ]
    });
    dashboard.loadDesigner();

    preConfiguredWidgets

    Predefined or Preconfigured widgets are a list of widgets that appear under ‘Default Widget Panel’ while initializing the dashboard designer itself. For this, you need to create a dashboard called template dashboard and configure the widgets that will be considered as predefined widgets for your designer.

    preConfiguredWidgets.dashboardId

    string

    The preconfigured widgets will be listed from the mentioned dashboard Id within the dashboard designer embedded in your application.


    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         preConfiguredWidgets: {
              dashboardId: "",
         }
    });
    dashboard.loadDesigner();

    preConfiguredWidgets.categoryName

    string

    The name of the category where the widget to be added in designer.


    Default value : empty

  • ""

  • Example

    var dashboard = BoldBI.create({
         preConfiguredWidgets: {
              categoryName: "",
         }
    });
    dashboard.loadDesigner();

    disableAutoRecover

    boolean

    Specifies whether to show or hide the Auto Recover Popup in the Dashboard Designer.


    Default value

  • false

  • Example

    var dashboard = BoldBI.create({
         disableAutoRecover: false,
    });
    dashboard.loadDashboard();

    NOTE:
    1. If the categoryName already exists, the predefined widgets were added in that category.
    2. If the categoryName not exists in the panel, the widgets were added by creating a new category with the given name.
    3. Otherwise, by default the widgets were added into the Miscellaneous category.