{
  "scriptappy": "1.0.0",
  "info": {
    "name": "SingleIntegrationAPI",
    "description": "The Single Integration API provides parameters that can be used to create a URL that returns a complete HTML page containing, for example, an embedded Qlik Sense visualization.\nThis URL can be embedded in a web page by including it in an iFrame.",
    "version": "1.2.1",
    "stability": "stable",
    "x-qlik-since-sense": "2.2",
    "x-qlik-visibility": "public"
  },
  "entries": {},
  "definitions": {
    "URL": {
      "kind": "interface",
      "returns": {
        "description": "HTML page rendering a Qlik Sense visualization or a sheet.",
        "type": "string"
      },
      "entries": {
        "appid": {
          "description": "ID of a Qlik Sense app. If no `appid` is available, the file name will be listed.",
          "type": "string"
        },
        "obj": {
          "description": "ID of a Qlik Sense visualization.",
          "type": "string"
        },
        "sheet": {
          "description": "ID of a sheet in a Qlik Sense app.",
          "type": "string"
        },
        "snapshot": {
          "description": "ID of a snapshot in a Qlik Sense app. Introduced in Qlik Sense 1.1.",
          "type": "string"
        },
        "identity": {
          "description": "Session identity. If no identity is defined, the session and selection state will be shared with the client.\nIf an identity is defined, a separate session is created and any selections made in the single feature do not affect a concurrent session in the Qlik Sense client.",
          "optional": true,
          "type": "string"
        },
        "lang": {
          "description": "Override default language settings by defining the language for the specific object.",
          "optional": true,
          "type": "string"
        },
        "opt": {
          "description": "Defining options. Supported options are:",
          "optional": true,
          "kind": "object",
          "entries": {
            "currsel": {
              "description": "displays the Selection bar.",
              "optional": true,
              "type": "string"
            },
            "currsel-dark": {
              "description": "displays the Selection bar dark mode.",
              "x-qlik-visibility": "private",
              "optional": true,
              "type": "string"
            },
            "debug": {
              "description": "starts a JavaScript debugger. The debug option can only be defined in the URL.",
              "optional": true,
              "type": "string"
            },
            "noanimate": {
              "description": "turns off animations.",
              "optional": true,
              "type": "string"
            },
            "noselections": {
              "description": "turns off selections.",
              "optional": true,
              "type": "string"
            },
            "nointeraction": {
              "description": "turns off interaction.",
              "optional": true,
              "type": "string"
            },
            "ctxmenu": {
              "description": "enables the context menu.",
              "optional": true,
              "type": "string"
            }
          }
        },
        "callback": {
          "description": "Registering callbacks.",
          "optional": true,
          "type": "string"
        },
        "bookmark": {
          "description": "ID of a bookmark in a Qlik Sense app.",
          "optional": true,
          "type": "string"
        },
        "select": {
          "description": "Field name and values to select.",
          "optional": true,
          "type": "string"
        },
        "theme": {
          "description": "Add a theme definition by stating the theme ID in addition to the Base URL. Introduced in Qlik Sense 4.0.",
          "optional": true,
          "type": "string"
        }
      },
      "examples": [
        "**Defining multiple preselected values:**\n```html\n<iframe src='https://sense-demo.qlik.com/single/?appid=133dab5d-8f56-4d40-b3e0-a6b401391bde&obj=298bbd6d-f23d-4469-94a2-df243d680e0c&select=Priority,High,Medium&select=Year,2012' frameborder='0'>\n```\n\n**Defining preselected values and bookmarks:**\n```\nhttp[s]://<machinename | servername>/{virtual proxy}/single?appid=133dab5d-8f56-4d40-b3e0-a6b401391bde&\n```"
      ]
    }
  }
}