Embedding: Javascript API Reference

To use the JavaScript API object specified below, be sure to specify the URL to the JavaScript API file in your web page. For more information, see Embedding with Javascript API or code samples. The JavaScript API file is a library that contains functions for interacting with the JavaScript API. It's a minified file and production-ready to be downloaded by the browser.

This section defines the available options for configuring the Knowi Javascript Class. 

This section defines the available options for configuring the view object from the Knowi class.

menuOptions: {
    logo: true,
    dashboards: true,
    widgets: false,
    queries: true,
    alerts: false,
    reports: false,
    more: false,
    help: false,
    profile: false,
    ml: false,
    ai: false,
    logout: true,
    agent: true,
    opsdash: false,
    dashSettings: true,
    nlpPrompt:true
}

function onWidget(widget) {
 alert(Widget created with id:" + widget.id + " name:" + widget.name);)
}
Knowi.render('#knowi-div', {
type: 'nlp',
token: "ADD KNOWI SESSION TOKEN HERE",
url: 'https://www.knowi.com',
view: {
 nlpOptions: {
  icon: "on",
  css: {
      background: 'transparent',
      width: '80%'
},
placeholder: "Ask a question...",
help: "on",
helpText: "Ability to customize the help text of the question mark",
createWidget: 'onWidget'
}
}
}, function () {
});}

view: {
aiConverseOptions: {
useSources: 'all', // datasets, documents, all.
displayFoundSources: true,
      sources: {
          datasets: ['movies_data', 16648, 16649],
          documents: ['doc1.pdf', 'John_Doe_Contract.pdf', 3001, 3002]
}}}

Menu Options

The menu options available are:

• logo - Enables displaying the logo on the dashboard by setting it to true
• dashboards - Enables dashboards by setting them to true
• widgets - Enables widgets on setting it to true
• queries - Enables queries on setting it to true
• alerts - Enables alerts on setting it to true
• reports - Enables reports on setting it to true
• more - Enables the more button on setting it to true
• help - Enables the help option on setting it to be true
• profile  - Enables setting up and maintaining profiles by setting them to true
• ml  - Enables ML on setting it to true
• ai - Enables AI button on the navigation menu
• logout - When disabled users will not see the option to log out
• agent - Enables agent to set it to true
• opsdash - Enables ops dashboards by setting it to true
• dashSettings - Enable or disable the settings icon on the dashboard
• nlpPrompt - Enable or disable the NLP prompt on the dashboard

CSS Customization

Your own custom CSS can be injected into the API. Simply specify a comma-separated list of CSS files and their full path during the initialization.

Knowi.render('#cloud9charts', {
    type: 'touchdown',
    username: 'name',
    password: 'pass',
    view: {
      title: true,
      css: ['https://rawgit.com/AntonLapshin/csharp/master/custom1.css', 'https://rawgit.com/AntonLapshin/csharp/master/custom2.css']
    },
}, function() {
    alert("Loaded")
});

See sample JSFiddle.

Filters

To pass in filters:

    Knowi.render('#cloud9charts', {
       type: 'share',
       dashboard: 'CnzzWr6ZGrii4BYsa295HoVWzNB7VaZey6StgO1uFw2kie'
       view: {
         title: true,
         contentFilters: [
            {
               "fieldName":
               "opened",
               "values":[1000],
               "operator":">"
            },
            {
                "fieldName":"message_type",
                "values":["marketing"],
                "operator":"="
            }
         ]
       },
    }, function() {
       alert("Loaded")
    });

Note: Secure URL modes require contentFilters to be encrypted.

Themes

To apply a custom theme to an embedded dashboard, pass the theme ID as themeId in the top-level configuration object:

Knowi.render('#knowi-div', {
    type: 'single',
    token: 'YOUR_SESSION_TOKEN',
    themeId: 'YOUR_THEME_ID',
    view: {
        title: true,
        // ...
    }
}, function() {});

Theme styling is applied in the following order of precedence (highest to lowest):

1. Custom CSS
2. Custom widget properties
3. Widget-level theme
4. themeId

themeId overrides any dashboard-level theme configured in Knowi. However, widgets with explicit theme assignments (e.g., "light" or "dark") are unaffected -- only widgets inheriting their theme from the dashboard will reflect the themeId value.