defaultOptions will be used.",
"is_constructor": 1,
"params": [
{
"name": "options",
"description": "Object standard options"
}
]
},
"Xmla.Rowset": {
"name": "Xmla.Rowset",
"shortname": "Xmla.Rowset",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "xmla",
"namespace": "",
"file": "../src/Xmla.js",
"line": 4508,
"description": "\nThis class implements an XML/A Rowset object.\n
\n\nYou do not need to instantiate objects of this class yourself.\nRather, the Xmla class will instantiate this class to convey the result of any of the various discoverXXX() methods\n(see discover()).\nIn addition, this class is also used to instantiate a Resultset for the\nexecute() method in case the\nFormat property is set to Tabular\n(see OPTION_FORMAT and OPTION_FORMAT_TABULAR).\nThe request() method itself will also return an instance of this class in case the method is used to do a\nDiscover request, or in case it is used to do a Execute request and the Format property is set to Tabular.\n
\nAn instance of the Xmla.Rowset class is returned immediately as return value from the disoverXXX() or execute() method when doing a synchronous request.\nIn addition, the rowset is available in the eventdata passed to any registered listeners\n(see addListener()).\nNote that for asynchronous requests, the only way to obtain the returned Rowset instance is through the listeners.\n
Discover request.",
"type": "DOMDocument"
},
{
"name": "requestTtype",
"description": "The requestType identifying the particular schema rowset to construct. This facilitates implementing field getters for a few complex types.",
"type": "String"
},
{
"name": "xmla",
"description": "The Xmla instance that created this Rowset. This is mainly used to allow the Rowset to access the options passed to the Xmla constructor.",
"type": "Xmla"
}
]
},
"Xmla.Dataset": {
"name": "Xmla.Dataset",
"shortname": "Xmla.Dataset",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "xmla",
"namespace": "",
"file": "../src/Xmla.js",
"line": 5542,
"description": "\nThis class implements an XML/A multidimensional Dataset object.\n
\n\nYou do not need to instantiate objects of this class yourself.\nRather, the Xmla class will instantiate this class\nto convey the result of the executeMultiDimensional method\n(see executeMultiDimensional()),\nand possibly the execute method.\n(Note that the execute() instantiates either the\nXmla.Rowset or the Xmla.Dataset class\ndepending on the value of the Format property in the options passed to the execute() method.)\n
\nAn instance of the Xmla.Dataset class may be returned immediately as return value from these methods when doing a synchronous request.\nIn addition, the Xmla.Dataset object is available in the eventdata passed to any registered listeners\n(see addListener()).\n
Execute request.",
"type": "DOMDocument"
}
]
},
"Xmla.Dataset.Axis": {
"name": "Xmla.Dataset.Axis",
"shortname": "Xmla.Dataset.Axis",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "xmla",
"namespace": "",
"file": "../src/Xmla.js",
"line": 5984,
"description": "\nThis class implements an Axis object.\n
\n\nYou do not need to instantiate objects of this class yourself.\nRather, the Xmla.Dataset class creates instances of this class to represent the axes of an MDX query.\n(see getAxis().)",
"is_constructor": 1
},
"Xmla.Dataset.Cellset": {
"name": "Xmla.Dataset.Cellset",
"shortname": "Xmla.Dataset.Cellset",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "xmla",
"namespace": "",
"file": "../src/Xmla.js",
"line": 6565,
"description": "
\nThis class implements a Cellset object.\n
\n\nYou do not need to instantiate objects of this class yourself.\nRather, the Xmla.Dataset class creates instances of this class to represent the cells (the value of the measures) of an MDX query.\n(see getCellset().)",
"is_constructor": 1
},
"Xmla.Exception": {
"name": "Xmla.Exception",
"shortname": "Xmla.Exception",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "xmla",
"namespace": "",
"file": "../src/Xmla.js",
"line": 6964,
"description": "
\nThis class is used to indicate an runtime errors occurring in any of the methods of the xmla4js classes.\n
\n\nYou do not need to instantiate objects of this class yourself.\nRather, instances of this class are created and thrown at runtime whenever an error occurs.\nThe purpose is to provide a clean and clear way for applications that use xmla4js to recognize and handle Xmla4js specific runtime errors.\n
\n\nTo handle Xmla4js errors, you can use a try...catch block like this:\n
\n try {\n ...general xmla4js work...\n } catch (exception) {\n if (exception instanceof Xmla.Exception) {\n ...use exception.code, exception.message and exception.data to handle the exception.\n } else {\n ...handle other errors...\n }\n }\n",
"is_constructor": 1
}
},
"classitems": [
{
"file": "../src/Xmla.js",
"line": 634,
"description": "These are the default options used for new Xmla instances in case no custom properties are set.\nIt sets the following properties:\nrequestTimeout int: 30000 - number of milliseconds before a request to the XML/A server will timeout async boolean: false - determines whether synchronous or asynchronous communication with the XML/A server will be used.addFieldGetters boolean: true - determines whether Xml.Rowset objects will be created with a getter method for each column.forceResponseXMLEmulation boolean: false - determines whether to parse responseText or to use the native responseXML from the xhr object.request() method to invoke the XML/A Discover method on the server.\nInstead of explicitly setting the method yourself, consider using the discover() method.\nThe discover() method automatically sets the method option to METHOD_DISCOVER.",
"itemtype": "property",
"name": "METHOD_DISCOVER",
"static": 1,
"final": 1,
"type": "string",
"default": "Discover",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 668,
"description": "Can be used as value for the method option property in the options objecct passed to the\nrequest() method to invoke the XML/A Execute method on the server.\nInstead of explicitly setting the method yourself, consider using the execute() method.\nThe execute() method automatically sets the method option to METHOD_EXECUTE.",
"itemtype": "property",
"name": "METHOD_EXECUTE",
"static": 1,
"final": 1,
"type": "string",
"default": "Discover",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 685,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_DATASOURCES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this constant as requestType yourself, consider calling the discoverDataSources() method.\nThe discoverDataSources() method passes DISCOVER_DATASOURCES automatically as requestType for Discover requests.",
"itemtype": "property",
"name": "DISCOVER_DATASOURCES",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_DATASOURCES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 699,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_PROPERTIES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverProperties() method.\nThe discoverProperties() method passes DISCOVER_PROPERTIES automatically as requestType for Discover requests.",
"itemtype": "property",
"name": "DISCOVER_PROPERTIES",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_PROPERTIES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 713,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_SCHEMA_ROWSETS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverSchemaRowsets() method.\nThe discoverProperties() method passes DISCOVER_PROPERTIES automatically as requestType for Discover requests.",
"itemtype": "property",
"name": "DISCOVER_SCHEMA_ROWSETS",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_SCHEMA_ROWSETS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 727,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_ENUMERATORS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverEnumerators() method.\nThe discoverSchemaRowsets() method issues a request to invoke the Discover method using DISCOVER_SCHEMA_ROWSETS as requestType.",
"itemtype": "property",
"name": "DISCOVER_ENUMERATORS",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_ENUMERATORS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 741,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_KEYWORDS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverKeywords() method.\nThe discoverKeywords() method issues a request to invoke the Discover method using DISCOVER_KEYWORDS as requestType.",
"itemtype": "property",
"name": "DISCOVER_KEYWORDS",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_KEYWORDS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 755,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DISCOVER_LITERALS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverLiterals() method.\nThe discoverLiterals() method issues a request to invoke the Discover method using DISCOVER_LITERALS as requestType.",
"itemtype": "property",
"name": "DISCOVER_LITERALS",
"static": 1,
"final": 1,
"type": "string",
"default": "DISCOVER_LITERALS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 769,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_CATALOGS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverDBCatalogs() method.\nThe discoverDBCatalogs() method issues a request to invoke the Discover method using DBSCHEMA_CATALOGS as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_CATALOGS",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_CATALOGS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 783,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_COLUMNS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverDBColumns() method.\nThe discoverDBColumns() method issues a request to invoke the Discover method using DBSCHEMA_COLUMNS as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_COLUMNS",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_COLUMNS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 797,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_PROVIDER_TYPES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverDBProviderTypes() method.\nThe discoverDBProviderTypes() method issues a request to invoke the Discover method using DBSCHEMA_PROVIDER_TYPES as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_PROVIDER_TYPES",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_PROVIDER_TYPES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 811,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_SCHEMATA schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverDBSchemata() method.\nThe discoverDBColumns() method issues a request to invoke the Discover method using DBSCHEMA_SCHEMATA as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_SCHEMATA",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_SCHEMATA",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 825,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_TABLES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the discoverDBTables() method.\nThe discoverDBColumns() method issues a request to invoke the Discover method using DBSCHEMA_TABLES as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_TABLES",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_TABLES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 839,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the DBSCHEMA_TABLES_INFO schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverDBTablesInfo() method.\nThe discoverDBTablesInfo() method issues a request to invoke the Discover method using DBSCHEMA_TABLES_INFO as requestType.",
"itemtype": "property",
"name": "DBSCHEMA_TABLES_INFO",
"static": 1,
"final": 1,
"type": "string",
"default": "DBSCHEMA_TABLES_INFO",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 854,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the MDSCHEMA_ACTIONS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDActions() method.\nThe discoverMDActions() method issues a request to invoke the Discover method using MDSCHEMA_ACTIONS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_ACTIONS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_ACTIONS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 869,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_CUBES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDCubes() method.\nThe discoverMDCubes() method issues a request to invoke the Discover method using\nMDSCHEMA_CUBES as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_CUBES",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_CUBES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 886,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_DIMENSIONS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDDimensions() method.\nThe discoverMDDimensions() method issues a request to invoke the Discover method using\nMDSCHEMA_DIMENSIONS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_DIMENSIONS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_DIMENSIONS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 903,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_FUNCTIONS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDFunctions() method.\nThe discoverMDFunctions() method issues a request to invoke the Discover method using\nMDSCHEMA_FUNCTIONS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_FUNCTIONS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_FUNCTIONS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 920,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_HIERARCHIES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDHierarchies() method.\nThe discoverMDHierarchies() method issues a request to invoke the Discover method using\nMDSCHEMA_HIERARCHIES as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_HIERARCHIES",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_HIERARCHIES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 937,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_LEVELS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDLevels() method.\nThe discoverMDLevels() method issues a request to invoke the Discover method using\nMDSCHEMA_LEVELS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_LEVELS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_LEVELS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 954,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_MEASURES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDMeasures() method.\nThe discoverMDMeasures() method issues a request to invoke the Discover method using\nMDSCHEMA_MEASURES as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_MEASURES",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_MEASURES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 971,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_MEMBERS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDMembers() method.\nThe discoverMDMembers() method issues a request to invoke the Discover method using\nMDSCHEMA_MEMBERS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_MEMBERS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_MEMBERS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 988,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_PROPERTIES schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDProperties() method.\nThe discoverMDProperties() method issues a request to invoke the Discover method using\nMDSCHEMA_PROPERTIES as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_PROPERTIES",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_PROPERTIES",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1005,
"description": "Can be used as value for the requestType option in the options object passed to the to\nrequest() method to invoke the XML/A Discover method on the server to return the\nMDSCHEMA_SETS schema rowset.\nThe requestType option applies only to Discover requests.\nInstead of passing this requestType yourself, consider calling the\ndiscoverMDSets() method.\nThe discoverMDSets() method issues a request to invoke the Discover method using\nMDSCHEMA_SETS as requestType.",
"itemtype": "property",
"name": "MDSCHEMA_SETS",
"static": 1,
"final": 1,
"type": "string",
"default": "MDSCHEMA_SETS",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1022,
"description": "Indicates the request event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe request event is the first event that is fired before submitting a request\n(see: request())\nto the server, and before firing the method-specific request events\n(see EVENT_EXECUTE\nand EVENT_DISCOVER).\nThe request event itself is not method-specific, and fires for Execute as well as Discover requests.\nThe EVENT_REQUEST event is cancelable:\nthe handler function specified in the listener object passed to addListener should return a boolen, indicating\nwhether the respective operation should be canceled.",
"itemtype": "property",
"name": "EVENT_REQUEST",
"static": 1,
"final": 1,
"type": "string",
"default": "request",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1042,
"description": "Indicates the success event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe success event is the last event that is fired after receiving and processing a normal response\n(that is, a response that does not contain an XML/A SoapFault),\nafter firing the method-specific success events\n(see EVENT_EXECUTE_SUCCESS\nand EVENT_DISCOVER_SUCCESS).\nThe success event is not method-specific, and fires for Execute as well as Discover responses.\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_SUCCESS",
"static": 1,
"final": 1,
"type": "string",
"default": "success",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1060,
"description": "Indicates the error event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe error is fired when an error occurs while sending a request or receiving a response.\nThe error event is not method-specific, and fires for errors encountered during both Execute as well as Discover method invocations.\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_ERROR",
"static": 1,
"final": 1,
"type": "string",
"default": "error",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1075,
"description": "Indicates the execute event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe execute event is method-specific, and is fired before submitting an Execute request\n(see: execute())\nto the server, but after firing the request event\n(see: EVENT_REQUEST).\nThe EVENT_EXECUTE event is cancelable:\nthe handler function specified in the listener object passed to addListener should return a boolen, indicating\nwhether the respective operation should be canceled.",
"itemtype": "property",
"name": "EVENT_EXECUTE",
"static": 1,
"final": 1,
"type": "string",
"default": "execute",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1093,
"description": "Indicates the executesuccess event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe executesuccess event is method-specific and fired only after receiving and processing a normal response\n(that is, a response that does not contain a SoapFault)\nto an incovation of the XML/A Execute method\n(see: execute()).\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_EXECUTE_SUCCESS",
"static": 1,
"final": 1,
"type": "string",
"default": "executesuccess",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1109,
"description": "Indicates the executeerror event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe executeerror event is method-specific and fired when an error occurs while sending an Execute request, or receiving a response to an Executeexecute()).\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_EXECUTE_ERROR",
"static": 1,
"final": 1,
"type": "string",
"default": "executeerror",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1124,
"description": "Indicates the discover event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe discover event is method-specific, and is fired before submitting a Discover request\n(see: discover())\nto the server, but after firing the request event\n(see: EVENT_DISCOVER).\nThe EVENT_DISCOVER event is cancelable:\nthe handler function specified in the listener object passed to addListener should return a boolen, indicating\nwhether the respective operation should be canceled.",
"itemtype": "property",
"name": "EVENT_DISCOVER",
"static": 1,
"final": 1,
"type": "string",
"default": "discover",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1142,
"description": "Indicates the discoversuccess event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe discoversuccess event is method-specific and fired only after receiving and processing a normal response\n(that is, a response that does not contain a SoapFault)\nto an incovation of the XML/A Discover method\n(see: discover()).\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_DISCOVER_SUCCESS",
"static": 1,
"final": 1,
"type": "string",
"default": "discoversuccess",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1158,
"description": "Indicates the discovererror event.\nThis constant can be used as en entry in the events array argument for the addListener() method.\nThe discovererror is method-specific and fired when an error occurs while sending an Discover request,\nor receiving a response to an Discoverdiscover()).\nThis is event is not cancelable.",
"itemtype": "property",
"name": "EVENT_DISCOVER_ERROR",
"static": 1,
"final": 1,
"type": "string",
"default": "discovererror",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1174,
"description": "Unifies all general events, that is, all events that are not method-specific.\nThis constant can be used as events array argument for the addListener() method,\nor you can use array concatenation to combine it with other arrays of EVENT_XXX constants.\nThis constant is especially intended for asyncronous handling of Schema rowset data.",
"itemtype": "property",
"name": "EVENT_GENERAL",
"static": 1,
"final": 1,
"type": "string[]",
"default": "[EVENT_REQUEST,EVENT_SUCCESS,EVENT_ERROR]",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1192,
"description": "Unifies all events specific for the Discover method.\nThis constant can be used as events array argument for the addListener() method,\nor you can use array concatenation to combine it with other arrays of EVENT_XXX constants.",
"itemtype": "property",
"name": "EVENT_DISCOVER_ALL",
"static": 1,
"final": 1,
"type": "string[]",
"default": "[EVENT_DISCOVER,EVENT_DISCOVER_SUCCESS,EVENT_DISCOVER_ERROR]",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1209,
"description": "Unifies all events specific for the Execute method.\nThis constant can be used as events array argument for the addListener() method,\nor you can use array concatenation to combine it with other arrays of EVENT_XXX constants.",
"itemtype": "property",
"name": "EVENT_EXECUTE_ALL",
"static": 1,
"final": 1,
"type": "string[]",
"default": "[EVENT_EXECUTE,EVENT_EXECUTE_SUCCESS,EVENT_EXECUTE_ERROR]",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1226,
"description": "Unifies all method-specific and non method-specific events.\nThis constant can be used as events array argument for the addListener() method.",
"itemtype": "property",
"name": "EVENT_ALL",
"static": 1,
"final": 1,
"type": "string[]",
"default": "[].concat(Xmla.EVENT_GENERAL, Xmla.EVENT_DISCOVER_ALL, Xmla.EVENT_EXECUTE_ALL)",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1242,
"description": "Can be used as key in the properties member of the options object\npassed to the request() method\nto specify the XML/A DataSourceInfo property.\nThe XML/A DataSourceInfo, together with the XML/A service URL are required to\nconnect to a particular OLAP datasource.\nValid values for the DataSourceInfo as well as the corresponding URL should be obtained\nby querying the DataSourceInfo and URL columns of the DISCOVER_DATASOURCES\nrowset respectively (see discoverDataSources()).",
"itemtype": "property",
"name": "PROP_DATASOURCEINFO",
"static": 1,
"final": 1,
"type": "string",
"default": "DataSourceInfo",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1259,
"description": "Can be used as key in the properties member of the options object\npassed to the execute() method\nto specify the XML/A Catalog property.\nThe XML/A Catalog spefifies where to look for cubes that are referenced in th MDX statment.\nValid values for the Catalog should be obtained\nby querying the CATALOG_NAME of the DBSCHEMA_CATALOGS\nrowset (see discoverCatalogs()).",
"itemtype": "property",
"name": "PROP_Catalog",
"static": 1,
"final": 1,
"type": "string",
"default": "Catalog",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1277,
"description": "Can be used as key in the properties member of the options object\npassed to the execute() method\nto specify the XML/A Format property.\nThis property controls the structure of the resultset.",
"itemtype": "property",
"name": "PROP_FORMAT",
"static": 1,
"final": 1,
"type": "string",
"default": "Format",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1290,
"description": "Can be used as value for the\nPROP_FORMAT key of the\nproperties member of the\noptions object passed to the\nexecute() method.\nWhen used, this specifies that the multidimensional resultset should be returned in a tabular format,\ncauseing the multidimensional resultset to be represented with an instance of the\nXmla.Rowset class.",
"itemtype": "property",
"name": "PROP_FORMAT_TABULAR",
"static": 1,
"final": 1,
"type": "string",
"default": "Tabular",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1307,
"description": "Can be used as value for the\nPROP_FORMAT key of the\nproperties member of the\noptions object passed to the\nexecute() method.\nWhen used, this specifies that the multidimensional resultset should be returned in a multidimensional format.\nCurrently, Xmla4js does not provide a class to represent the resultset in this format.\nHowever, you can access the results as xml through the\nresponseText and\nresponseXML properties.",
"itemtype": "property",
"name": "PROP_FORMAT_MULTIDIMENSIONAL",
"static": 1,
"final": 1,
"type": "string",
"default": "Multidimensional",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1327,
"description": "Can be used as key in the properties member of the options object\npassed to the execute() method\nto specify the XML/A AxisFormat property.\nThe XML/A AxisFormat property specifies how the client wants to receive the multi-dimensional resultset of a MDX query.\nValid values for the AxisFormat property are available as the static final properties\nPROP_AXISFORMAT_TUPLE,\nPROP_AXISFORMAT_CLUSTER,\nPROP_AXISFORMAT_CUSTOM.",
"itemtype": "property",
"name": "PROP_AXISFORMAT",
"static": 1,
"final": 1,
"type": "string",
"default": "AxisFormat",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1344,
"description": "Can be used as value for the AxisFormat XML/A property\n(see: PROP_AXISFORMAT)\nin invocations of the Execute method\n(see: execute()).",
"itemtype": "property",
"name": "PROP_AXISFORMAT_TUPLE",
"static": 1,
"final": 1,
"type": "string",
"default": "TupleFormat",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1357,
"description": "Can be used as value for the AxisFormat XML/A property\n(see: PROP_AXISFORMAT)\nin invocations of the Execute method\n(see: execute()).",
"itemtype": "property",
"name": "PROP_AXISFORMAT_CLUSTER",
"static": 1,
"final": 1,
"type": "string",
"default": "ClusterFormat",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1370,
"description": "Can be used as value for the AxisFormat XML/A property\n(see: PROP_AXISFORMAT)\nin invocations of the Execute method\n(see: execute()).",
"itemtype": "property",
"name": "PROP_AXISFORMAT_CUSTOM",
"static": 1,
"final": 1,
"type": "string",
"default": "CustomFormat",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1384,
"description": "Can be used as key in the properties member of the options object\npassed to the request() method\nto specify the XML/A Content property.\nThe XML/A Content property specifies whether to return data and/or XML Schema metadata by the Discover and Execute invocations.\nValid values for the Content property are available as the static final properties\nPROP_CONTENT_DATA,\nPROP_CONTENT_NONE,\nPROP_CONTENT_SCHEMA,\nPROP_CONTENT_SCHEMADATA.\n\nNote: This key is primarily intended for clients that use the low-level request() method.\nYou should not set this property when calling the discover() method,\nthe execute() method,\nor any of the discoverXXX() methods.",
"itemtype": "property",
"name": "PROP_CONTENT",
"static": 1,
"final": 1,
"type": "string",
"default": "Content",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1407,
"description": "Can be used as value for the XML/A Content property\n(see: PROP_CONTENT).\nThis value specifies that the response should contain only data, but no XML Schema metadata.\n\nAs the Xmla class relies on the XML Schema metadata to construct Rowset and Resultset instances,\nthis option is primarily useful if you know how to process the XML response directly.",
"itemtype": "property",
"name": "PROP_CONTENT_DATA",
"static": 1,
"final": 1,
"type": "string",
"default": "Data",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1422,
"description": "Can be used as value for the XML/A Content property\n(see: PROP_CONTENT).\nThis value specifies that the response should contain neither data nor XML Schema metadata.\nThis is useful to check the validity of the request.",
"itemtype": "property",
"name": "PROP_CONTENT_NONE",
"static": 1,
"final": 1,
"type": "string",
"default": "None",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1435,
"description": "Can be used as value for the XML/A Content property\n(see: PROP_CONTENT).\nThis value specifies that the response should only return XML Schema metadata, but no data.",
"itemtype": "property",
"name": "PROP_CONTENT_SCHEMA",
"static": 1,
"final": 1,
"type": "string",
"default": "Schema",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1447,
"description": "Can be used as value for the XML/A Content property\n(see: PROP_CONTENT).\nThis value specifies that the response should return both data as well as XML Schema metadata.",
"itemtype": "property",
"name": "PROP_CONTENT_SCHEMADATA",
"static": 1,
"final": 1,
"type": "string",
"default": "SchemaData",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1461,
"description": "This object stores listeners.\nEach key is a listener type (see the static final EVENT_XXX constants),\neach value is an array of listener objects that are subscribed to that particular event.",
"itemtype": "property",
"name": "listeners",
"access": "protected",
"tagname": "",
"type": "Object",
"default": "\n{\n \"request\": []\n , \"succss\": []\n , \"error\": []\n , \"discover\": []\n , \"discoversuccss\": []\n , \"discovererror\": []\n , \"execute\": []\n , \"executesuccss\": []\n , \"executeerror\": []\n}",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1483,
"description": "The soap message sent in the last request to the server.",
"itemtype": "property",
"name": "soapMessage",
"type": "{string}",
"default": "null",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1491,
"description": "This property is set to null right before sending an XML/A request.\nWhen a successfull response is received, it is processed and the response object is assigned to this property.\nThe response object is either a\nRowset (after a successful invocation of XML/A Discover method, see: discover()) or a\nResultset (after a successful invocation of the XML/A Execute method, see: execute())\ninstance.\n\nIf you are interested in processing the raw response XML, see\nresponseXML and\nresponseText.\n\nNote that it is not safe to read this property immediately after doing an asynchronous request.\nFor asynchronous requests, you can read this property by the time the XXX_SUCCESS event handlers are notified (until it is set to null again by a subsequent request).",
"itemtype": "property",
"name": "response",
"type": "Xmla.Rowset|Xmla.Dataset",
"default": "null",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1511,
"description": "This property is set to null right before sending an XML/A request.\nWhen a successfull response is received, the XML response is stored to this property as plain text.\n\nIf you are interested in processing a DOM document rather than the raw XML text, see the\nresponseXML property.\n\nIf you are interested in traversing the dataset returned in the XML/A response, see the\nresponse property.\n\nNote that it is not safe to read this property immediately after doing an asynchronous request.\nFor asynchronous requests, you can read this property by the time the XXX_SUCCESS event handlers are notified (until it is set to null again by a subsequent request).",
"itemtype": "property",
"name": "responseText",
"type": "{string}",
"default": "null",
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1529,
"description": "This property is set to null right before sending an XML/A request.\nWhen a successfull response is received, the XML response is stored to this property as a DOM Document.\n\nIf you are interested in processing the raw XML text rather than a DOM document, see the\nresponseText property.\n\nIf you are interested in traversing the dataset returned in the XML/A response, see the\nresponse property.\n\nNote that it is not safe to read this property immediately after doing an asynchronous request.\nFor asynchronous requests, you can read this property by the time the XXX_SUCCESS event handlers are notified (until it is set to null again by a subsequent request).",
"deprecated": true,
"itemtype": "property",
"name": "responseXML",
"type": "{DOMDocument}",
"default": "null",
"see": [
"getRep"
],
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1549,
"itemtype": "method",
"name": "getResponseXML",
"return": {
"description": "",
"type": "DOMDocument"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 1557,
"description": "This method can be used to set a number of default options for the Xmla instance.\nThis is especially useful if you don't want to pass each and every option to each method call all the time.\nWhere appropriate, information that is missing from the parameter objects passed to the methods of the Xmla object\n may be augmented with the values set through this method.\nFor example, if you plan to do a series of requests pertaining to one particular datasource,\nyou can set the mandatory options like url, async, datasource and catalog just once:\n\n xml.setOptions({\n url: \"http://localhost:8080/pentaho/Xmla\",\n async: true,\n properties: {\n DataSourceInfo: \"Pentaho Analysis Services\",\n Catalog: \"Foodmart\"\n }\n });\n\nThen, a subsequent For a single listener, you can pass a listener object literal with the following structure:
{\n events: ...event name or array of event names...,\n handler: ...function or array of functions...,\n scope: object\n}\n\n You can use event as an alias for events.\n Likewise, you can use handlers as an alias for handler.\n
\n Alternatively, you can pass the element as separate arguments instead of as an object literal:\n addListener(name, func, scope)\n where name is a valid event name, func is the function that is to be called when the event occurs.\n The last argument is optional and can be used to specify the scope that will be used as context for executing the function.\n
\n To register multiple listeners, pass an array of listener objects:\n addListener([listener1, ..., listenerN])\n
\n Alternatively, pass multiple listener objects as separate arguments:\n addListener(listener1, ..., listenerN)\n
\n Or, pass a single object literal with event names as keys and listener objects or functions as values:\n
addListener({\n discover: function() {\n ...handle discover event...\n },\n error: {\n handler: function() {\n ...handle error event...\n },\n scope: obj\n },\n scope: defaultscope\n })\n In this case, you can use scope as a key to specify the default scope for the handler functions.\n\nBelow is a more detailed description of the listener object and its components:
\neventsstring|string[] REQUIRED.\n The event or events to listen to.\n You can specify a single event by using one of the EVENT_XXX string constant values.\n You can specify multiple events by using an array of EVENT_XXX string constant values.\n You can also use one of the predefined EVENT_XXX array constant values,\n or use array concatenation and compose a custom list of event names.\n To listen to all events, either use EVENT_ALL,\n or otherwise the string value \"all\".\n Below is the list of constants that may be used for the events or events property: \"all\" may also be used.eventstring|string[] Alias for eventshandlerfunction|function[] REQUIRED.\n This function will be called and notified whenever one of the specified events occurs.\n The function has the following signature: boolean handler(string eventName, object eventData, Xmla xmla)\n You can also pass in an array of functions if you want multiple functions to be called when the event occurs.\n The function is called in scope of the scope property of the listener object.\n If no scope is specified, a global function is assumed.\n The handler function has the following arguments:\n eventNamestring The event for which notification is given.\n This is useful to distinguish between events in case the same handler function is used for multiple events.\n In this case, use the EVENT_XXX constants to check the eventName.eventDataObject An object that conveys event-specific data.xmlaXmla A reference to this Xmla instance that is the source of the event.\n Listeners can obtain the response as well as the original SOAP message sent to the server through this instance.\n This allows one listener to be shared across multiple Xmla instances without managing the context manually.\n boolean.\n If the handler returns false the respective operation will be canceled.\n Otherwise, the operation continues (but may be canceled by another handler).\n Currently, the following events are cancelable:\n EVENT_DISCOVER,\n EVENT_EXECUTE, and\n EVENT_REQUEST.\n handlersfunction|function[] Alias for handlerscopeObject OPTIONAL When specified, this object is used as the this object when calling the handler.\n When not specified, the global window is used.\n method {string} REQUIRED the XML/A method to invoke. This should be one of the following constants:\n METHOD_DISCOVER\n This method is used to obtain metadata from the XML/A service or XML/A provider.\n Metadata is returned in a tabular format called Schema Rowsets, which are represented by an instance of the\n Xmla.Rowset class.\n For these types of requests, you must pass the requestType option to specify which schema rowset you want to obtain.\n In addition, you can specify a restrictions object that is used as filter criteria to restrict which rows will be returned in the rowset.\n
\n Instead of explicitly passing METHOD_DISCOVER as the requestType, you can also call the\n discover() method (which requires you to explictly pass a requestType option).\n Finally, you can also call one of the discoverXXX() methods in order to request a particular schema rowset.\n
METHOD_EXECUTE\n This method is used to send an MDX quey to the XML/A provider.\n Query results are returned in a multidimentsional format which is represented by an instance of the\n Xmla.Dataset class.\n For these types of requests, you must pass the statement option to specify the MDX query.\n
\n Instead of explicitly passing METHOD_EXECUTE as the requestType, you can also call the\n execute() method.\n
url {string} REQUIRED the URL of XML/A service, or of a XML/A datasource.\n Typically, you first use the URL of a XML/A service (like http://your.pentaho.server:8080/pentaho/Xmla?userid=joe&password=password)\n and use that to retrieve the DISCOVER_DATASOURCES rowset.\n Then, you can connect to a XML/A datasource using the value returned by the URL column of the DISCOVER_DATASOURCES rowset\n (typically, you also have to set a DataSourceInfo property using the value found in the DataSourceInfo column of the DISCOVER_DATASOURCES rowset).\n properties {Object} XML/A properties.\n The appropriate types and values of XML/A properties are dependent upon the specific method and requestType.\n The XML/A standard defines a set of pre-defined properties.\n The Xmla class defines a static final property for each of these (see the PROP_XXX constants).\n The list of all valid properties can be obtained from the DISCOVER_PROPERTIES schema rowset\n (see discoverProperties()).\n Each javascript property of the properties object is mapped literally to a XML/A property.\n async {boolean}\n Determines how the request is performed:true: The request is performed asynchronously: the call to request() will not block and return immediately.\n In this case, the return value of the request() method is not defined,\n and the response must be received by registering a listener.\n (see addListener()).\n\n As an alternative to using listeners, you can also pass\n success, error and callback callback functions.\n Callbacks are described in more detail below.\n false: The request is performed synchronously: the call to request() will block until it receives a response from the XML/A server or times out.\n In this case, the request() method returns\n a Rowset (for Discover requests) or\n a Resultset (for Execute requests).\n If you registered any listeners (see addListener()),\n then these will still be notified of any events (such as receiving the response).\n success (function)\n A function that is to be called after the requests is executed and a successful response is receieved.\n Any listeners appropriate for the request are called after this handler is executed.\n error (function)\n A function that is to be called after the requests is executed and an error was encountered.\n Any listeners appropriate for the request are called after this handler is executed.\n callback (function)\n A function that is to be called after the requests is executed and the response is receieved,\n and after calling any listeners that are appropriate for the request.\n This function will be called both in case of success and of error.\n If the options also contain a success and/or error handler, then\n callback will be called after those more specific handlers are called.\n options object are method-specific.\nmethod is METHOD_DISCOVER:\n requestType - {string} Applies to the Discover method and indicates the kind of schema rowset to retrieve.\n You can use one of the DISCOVER_XXX, DBSCHEMA_XXX or MDSCHEMA_XXX constants for this property.\n You can also dymically discover which values for requestType are supported by the XML/A provider using the\n DISCOVER_SCHEMA_ROWSETS rowset (see: discoverMDSchemaRowsets()).\n See the discover() method for more information.\n restrictions {Object} XML/A restrictions are used to filter the requested schema rowset.\n For more information on restrictions, see the discover() method.\n method is METHOD_EXECUTE:\n statement - {string} Applies to the Execute method and specifies the MDX query to send to the server.\n discover() (to obtain a schema rowset),\nexecute() (to issue a MDX query),\nor one of the specialized discoverXXX() methods (to obtain a particular schema rowset).",
"itemtype": "method",
"name": "request",
"params": [
{
"name": "options",
"description": "An object whose properties convey the options for the request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A method. For an asynchronous request, the return value is not defined. For synchronous requests, Discover requests return an instance of a Xmla.Rowset, and Execute results return an instance of a Xmla.Dataset.",
"type": "Xmla.Rowset|Xmla.Dataset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2115,
"description": "Sends an MDX query to a XML/A DataSource to invoke the XML/A Execute method and obtain the multi-dimensional resultset.\nOptions are passed using a generic options object.\nApplicable properties of the options object are:\nurl {string} REQUIRED the URL of a XML/A datasource.\n This should be a value obtained from the URL column of the DISCOVER_DATASOURCES rowset\n (see: discoverDataSources()).\n statement - {string} The MDX query to send to the server.\n properties {Object} XML/A properties.\n The list of all valid properties can be obtained from the DISCOVER_PROPERTIES schema rowset\n (see discoverProperties()).\n Typically, execute() requires these properties:DataSourceInfo propertyPROP_DATASOURCEINFO\n as key in the properties object of the options object passed to the execute() method.\n Valid values for this property should be obtained from the DataSourceInfo column\n of the DISCOVER_DATASOURCES schema rowset (see: discoverDataSources()).\n Note that the values for the DataSourceInfo property and the url must both be taken from the same row of the DISCOVER_DATASOURCES schema rowset.\n Catalog propertyPROP_CATALOG\n as key in the properties object of the options object passed to the execute() method.\n Valid values for this property should be obtained from the CATALOG_NAME column\n of the DBSCHEMA_CATALOGS schema rowset (see: discoverDBCatalogs()).\n async {boolean}\n Determines how the request is performed:true: The request is performed asynchronously: the call to request() will not block and return immediately.\n In this case, the return value of the request() method is not defined,\n and the response must be received by registering a listener\n (see addListener()).\n false: The request is performed synchronously: the call to execute() will block until it receives a response from the XML/A server or times out.\n In this case, a Resultset is returned that represents the multi-dimensional data set.\n If you registered any REQUEST_XXX and/or EXECUTE_XXX listeners (see addListener()),\n then these will still be notified.\n Execute request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Execute method. For an asynchronous request, the return value is not defined. For synchronous requests, an instance of a Xmla.Dataset that represents the multi-dimensional result set of the MDX query. If the Format property in the request was set to Tabular, then an instance of the\nRowset class is returned to represent the Resultset.",
"type": "Xmla.Dataset|Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2184,
"description": "Sends an MDX query to a XML/A DataSource to invoke the execute() method using PROP_FORMAT_TABULAR as value for the PROP_FORMAT property. This has the effect of obtaining the multi-dimensional resultset as a Rowset.",
"itemtype": "method",
"name": "executeTabular",
"params": [
{
"name": "options",
"description": "An object whose properties convey the options for the XML/A Execute request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Execute method. For an asynchronous request, the return value is not defined. For synchronous requests, an instance of a Xmla.Rowset that represents the multi-dimensional result set of the MDX query.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2195,
"description": "Sends an MDX query to a XML/A DataSource to invoke the PROP_FORMAT_MULTIDIMENSIONAL as value for the PROP_FORMAT property. In this case, the result is available only as XML text or XML document in the responseText\nand responseXML properties.",
"itemtype": "method",
"name": "executeMultiDimensional",
"params": [
{
"name": "options",
"description": "An object whose properties convey the options for the XML/A Execute request.",
"type": "Object"
}
],
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2206,
"description": "Sends a request to invoke the XML/A Discover method and returns a schema rowset specified by the requestType option.\nOptions are passed using a generic options object.\nApplicable properties of the options object are:\nrequestType - {string} Indicates the kind of schema rowset to retrieve.\n You can use one of the following predefined XML for Analysis Schema Rowset constants:\n DISCOVER_DATASOURCESDISCOVER_ENUMERATORSDISCOVER_KEYWORDSDISCOVER_LITERALSDISCOVER_PROPERTIESDISCOVER_SCHEMA_ROWSETSDBSCHEMA_CATALOGSDBSCHEMA_COLUMNSDBSCHEMA_PROVIDER_TYPESDBSCHEMA_SCHEMATADBSCHEMA_TABLESDBSCHEMA_TABLES_INFOMDSCHEMA_ACTIONSMDSCHEMA_CUBESMDSCHEMA_DIMENSIONSMDSCHEMA_FUNCTIONSMDSCHEMA_HIERARCHIESMDSCHEMA_MEASURESMDSCHEMA_MEMBERSMDSCHEMA_PROPERTIESMDSCHEMA_SETSrequestType are supported by the XML/A provider.\n To do that, refer to the SchemaName column of the DISCOVER_SCHEMA_ROWSETS rowset\n (see: discoverMDSchemaRowsets()).\n url {string} REQUIRED the url of the XML/A service or XML/A datasource.\n If the value for the requestType option is one of the predefined XML/A DISCOVER_XXX constants,\n then this should be the url of the XML/A service.\n properties {Object} XML/A properties.\n The appropriate types and values of XML/A properties are dependent upon the value passed as requestType.\n The XML/A standard defines a set of pre-defined properties.\n The Xmla class defines a static final property for each of these (see the PROP_XXX constants).\n The list of all valid properties can be obtained from the DISCOVER_PROPERTIES schema rowset\n (see discoverProperties()).\n Each javascript property of the properties object is mapped literally to a XML/A property.\n restrictions {Object} XML/A restrictions.\n These are used to specify a filter that will be applied to the data in the schema rowset.\n Each javascript property of the restrictions object is mapped to a column of the requested schema rowset.\n The value for the restriction is sent with the request, and processed by the XML/A server to only return matching rows from the requested schema dataset.\n The name, types and values of the restrictions are dependent upon which schema rowset is requested.\n The available restrictions are specified by the Restrictions column of the DISCOVER_SCHEMA_ROWSETS schema rowset.\n For a number of schema rowsets, the available restrictions are pre-defined.\n These are documented together with each particular discoverXXX() method.\n async {boolean}\n Determines how the request is performed:true: The request is performed asynchronously: the call to request() will not block and return immediately.\n In this case, the return value of the request() method is not defined,\n and the response must be received by registering a listener\n (see addListener()).\n false: The request is performed synchronously: the call to execute() will block until it receives a response from the XML/A server or times out.\n In this case, a Resultset is returned that represents the multi-dimensional data set.\n If you registered any REQUEST_XXX and/or EXECUTE_XXX listeners (see addListener()),\n then these will still be notified.\n discoverXXX() methods to obtain a particular schema rowset.",
"itemtype": "method",
"name": "discover",
"params": [
{
"name": "options",
"description": "An object whose properties convey the options for the XML/A Discover request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the requested schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2297,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_DATASOURCES schema rowset.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| \n DataSourceName\n | \n\n string\n | \n\n A name that identifies this data source.\n | \n\n Yes\n | \n\n No\n | \n
| \n DataSourceDescription\n | \n\n string\n | \n\n Human readable description of the datasource\n | \n\n No\n | \n\n Yes\n | \n
| \n URL\n | \n\n string\n | \n\n URL to use to submit requests to this provider.\n | \n\n Yes\n | \n\n Yes\n | \n
| \n DataSourceInfo\n | \n\n string\n | \n\n Connectstring\n | \n\n No\n | \n\n Yes\n | \n
| \n ProviderName\n | \n\n string\n | \n\n A name indicating the product providing the XML/A implementation\n | \n\n Yes\n | \n\n Yes\n | \n
| \n ProviderType\n | \n\n string[]\n | \n\n The kind of data sets supported by this provider.\n The following values are defined by the XML/A specification:\n
| \n \n Yes\n | \n\n No\n | \n
| \n AuthenticationMode\n | \n\n string\n | \n\n Type of security offered by the provider\n The following values are defined by the XML/A specification:\n
| \n \n Yes\n | \n\n No\n | \n
DISCOVER_DATASOURCES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_DATASOURCES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2453,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_PROPERTIES schema rowset.\nThis rowset provides information on the properties that are supported by the XML/A provider.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| \n PropertyName\n | \n\n string\n | \n\n The name of the property\n | \n\n Yes (array)\n | \n\n No\n | \n
| \n PropertyDescription\n | \n\n string\n | \n\n Human readable description of the property\n | \n\n No\n | \n\n Yes\n | \n
| \n PropertyType\n | \n\n string\n | \n\n The property's datatype (as an XML Schema data type)\n | \n\n No\n | \n\n Yes\n | \n
| \n PropertyAccessType\n | \n\n string\n | \n\n How the property may be accessed. Values defined by the XML/A spec are:\n
| \n \n No\n | \n\n No\n | \n
| \n IsRequired\n | \n\n boolean\n | \n\n true if the property is required, false if not.\n | \n \n No\n | \n\n Yes\n | \n
| \n Value\n | \n\n string\n | \n\n The property's current value.\n | \n\n No\n | \n\n Yes\n | \n
DISCOVER_DATASOURCES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_DATASOURCES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2585,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_SCHEMA_ROWSETS schema rowset.\nThis rowset lists all possible request types supported by this provider.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| SchemaName | \nstring | \nThe requestType. | \nYes | \nNo | \n
| Restrictions | \narray | \nA list of columns that may be used to filter the schema rowset. | \nNo | \nYes | \n
| Description | \nstring | \nA human readable description of the schema rowset that is returned when using this requestType | \nNo | \nYes | \n
DISCOVER_SCHEMA_ROWSETS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_DATASOURCES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2631,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_ENUMERATORS schema rowset.\nThis rowset lists the names, data types, and enumeration values of enumerators supported by the XMLA Provider for a specific data source.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| EnumName | \nstring | \nName of the enumerator. | \nYes (array) | \nNo | \n
| EnumDescription | \nstring | \nA human readable description of the enumerator | \nNo | \nYes | \n
| EnumType | \nstring | \nThe XML Schema data type of this enumerator | \nNo | \nNo | \n
| ElementName | \nstring | \nThe name of the enumerator entry | \nNo | \nNo | \n
| ElementDescription | \nstring | \nA human readable description of this enumerator entry | \nNo | \nYes | \n
| ElementValue | \nstring | \nThe value of this enumerator entry | \nNo | \nYes | \n
DISCOVER_ENUMERATORS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_ENUMERATORS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2698,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_KEYWORDS schema rowset.\nThis rowset is a list of reserved words for this XML/A provider.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| Keyword | \nstring | \nName of the enumerator. | \nYes (array) | \nNo | \n
DISCOVER_KEYWORDS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_ENUMERATORS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2730,
"description": "Invokes the discover() method using requestType,\nand retrieves the DISCOVER_LITERALS schema rowset.\nThis rowset is a list of reserved words for this XML/A provider.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| LiteralName | \nstring | \nName of the literal. | \nYes (array) | \nNo | \n
| LiteralValue | \nstring | \nThe actual literal value. | \nNo | \nYes | \n
| LiteralInvalidChars | \nstring | \nCharacters that may not appear in the literal | \nNo | \nYes | \n
| LiteralInvalidStartingChars | \nstring | \nCharacters that may not appear as first character in the literal | \nNo | \nYes | \n
| LiteralMaxLength | \nint | \nmaximum number of characters for this literal, or -1 in case there is no maximum, or the maximum is unknown | \nNo | \nYes | \n
DISCOVER_LITERALS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DISCOVER_LITERALS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2790,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_CATALOGS schema rowset.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nName of the catalog | \nYes | \nNo | \n
| DESCRIPTION | \nstring | \nHuman readable description | \nNo | \nYes | \n
| ROLES | \nstring | \nA comma-separatd list of roles available to the current user. | \nNo | \nYes | \n
| DATE_MODIFIED | \nDate | \nThe date this catalog was modified | \nNo | \nYes | \n
DBSCHEMA_CATALOGS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_CATALOGS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 2842,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_COLUMNS schema rowset.\nProvides column information for all columns meeting the provided restriction criteria.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| TABLE_CATALOG | \nstring | \nThe name of the Database. | \nYes | \nNo | \n
| TABLE_SCHEMA | \nstring | \nNot supported. | \nYes | \nNo | \n
| TABLE_NAME | \nstring | \nThe name of the cube. | \nYes | \nNo | \n
| COLUMN_NAME | \nstring | \nThe name of the attribute hierarchy or measure. | \nYes | \nNo | \n
| COLUMN_GUID | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLUMN_PROPID | \nint | \nNot supported. | \nNo | \nNo | \n
| ORDINAL_POSITION | \nint | \nThe position of the column, beginning with 1. | \nNo | \nNo | \n
| COLUMN_HAS_DEFAULT | \nboolean | \nNot supported. | \nNo | \nNo | \n
| COLUMN_DEFAULT | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLUMN_FLAGS | \nint | \nA DBCOLUMNFLAGS bitmask indicating column properties. See 'DBCOLUMNFLAGS Enumerated Type' in IColumnsInfo::GetColumnInfo | \nNo | \nNo | \n
| IS_NULLABLE | \nboolean | \nAlways returns false. | \nNo | \nNo | \n
| DATA_TYPE | \nstring | \nThe data type of the column. Returns a string for dimension columns and a variant for measures. | \nNo | \nNo | \n
| TYPE_GUID\n | srring | \nNot supported. | \nNo | \nNo | \n
| CHARACTER_MAXIMUM_LENGTH | \nint | \nThe maximum possible length of a value within the column. This is retrieved from the DataSize property in the DataItem. | \nNo | \nNo | \n
| CHARACTER_OCTET_LENGTH | \nint | \nThe maximum possible length of a value within the column, in bytes, for character or binary columns. A value of zero (0) indicates the column has no maximum length. NULL will be returned for columns that do not return binary or character data types. | \nNo | \nNo | \n
| NUMERIC_PRECISION | \nint | \nThe maximum precision of the column for numeric data types other than DBTYPE_VARNUMERIC. | \nNo | \nNo | \n
| NUMERIC_SCALE | \nint | \nThe number of digits to the right of the decimal point for DBTYPE_DECIMAL, DBTYPE_NUMERIC, DBTYPE_VARNUMERIC. Otherwise, this is NULL. | \nNo | \nNo | \n
| DATETIME_PRECISION | \nint | \nNot supported. | \nNo | \nNo | \n
| CHARACTER_SET_CATALOG | \nstring | \nNot supported. | \nNo | \nNo | \n
| CHARACTER_SET_SCHEMA | \nstring | \nNot supported. | \nNo | \nNo | \n
| CHARACTER_SET_NAME | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLLATION_CATALOG | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLLATION_SCHEMA | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLLATION_NAME | \nstring | \nNot supported. | \nNo | \nNo | \n
| DOMAIN_CATALOG | \nstring | \nNot supported. | \nNo | \nNo | \n
| DOMAIN_SCHEMA | \nstring | \nNot supported. | \nNo | \nNo | \n
| DOMAIN_NAME | \nstring | \nNot supported. | \nNo | \nNo | \n
| DESCRIPTION | \nstring | \nNot supported. | \nNo | \nNo | \n
| COLUMN_OLAP_TYPE | \nstring | \nThe OLAP type of the object. MEASURE indicates the object is a measure. ATTRIBUTE indicates the object is a dimension attribute. | \nYes | \nNo | \n
DBSCHEMA_COLUMNS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_COLUMNS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3071,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_PROVIDER_TYPES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| TYPE_NAME | \nstring | \nThe provider-specific data type name. | \nfalse | \ntrue | \n
| DATA_TYPE | \nint | \nThe indicator of the data type. | \nfalse | \ntrue | \n
| COLUMN_SIZE | \nint | \nThe length of a non-numeric column or parameter that refers to either the maximum or the length defined for this type by the provider. For character data, this is the maximum or defined length in characters. For DateTime data types, this is the length of the string representation (assuming the maximum allowed precision of the fractional seconds component). If the data type is numeric, this is the upper bound on the maximum precision of the data type. | \nfalse | \ntrue | \n
| LITERAL_PREFIX | \nstring | \nThe character or characters used to prefix a literal of this type in a text command. | \nfalse | \ntrue | \n
| LITERAL_SUFFIX | \nstring | \nThe character or characters used to suffix a literal of this type in a text command. | \nfalse | \ntrue | \n
| CREATE_PARAMS\n | string | \nThe creation parameters specified by the consumer when creating a column of this data type. For example, the SQL data type, DECIMAL, needs a precision and a scale. In this case, the creation parameters might be the string \"precision,scale\". In a text command to create a DECIMAL column with a precision of 10 and a scale of 2, the value of the TYPE_NAME column might be DECIMAL() and the complete type specification would be DECIMAL(10,2). The creation parameters appear as a comma-separated list of values, in the order they are to be supplied and with no surrounding parentheses. If a creation parameter is length, maximum length, precision, scale, seed, or increment, use \"length\", \"max length\", \"precision\", \"scale\", \"seed\", and \"increment\", respectively. If the creation parameter is some other value, the provider determines what text is to be used to describe the creation parameter. If the data type requires creation parameters, \"()\" usually appears in the type name. This indicates the position at which to insert the creation parameters. If the type name does not include \"()\", the creation parameters are enclosed in parentheses and appended to the data type name. | \nfalse | \ntrue | \n
| IS_NULLABLE | \nboolean | \nA Boolean that indicates whether the data type is nullable. VARIANT_TRUE indicates that the data type is nullable. VARIANT_FALSE indicates that the data type is not nullable. NULL indicates that it is not known whether the data type is nullable. | \nfalse | \ntrue | \n
| CASE_SENSITIVE | \nboolean | \nA Boolean that indicates whether the data type is a characters type and case-sensitive. VARIANT_TRUE indicates that the data type is a character type and is case-sensitive. VARIANT_FALSE indicates that the data type is not a character type or is not case-sensitive. | \nfalse | \ntrue | \n
| SEARCHABLE | \nint | \nAn integer indicating how the data type can be used in searches if the provider supports ICommandText; otherwise, NULL. This column can have the following values: DB_UNSEARCHABLE indicates that the data type cannot be used in a WHERE clause. DB_LIKE_ONLY indicates that the data type can be used in a WHERE clause only with the LIKE predicate.DB_ALL_EXCEPT_LIKE indicates that the data type can be used in a WHERE clause with all comparison operators except LIKE. DB_SEARCHABLE indicates that the data type can be used in a WHERE clause with any comparison operator. | \nfalse | \ntrue | \n
| UNSIGNED_ATTRIBUTE | \nboolean | \nA Boolean that indicates whether the data type is unsigned. VARIANT_TRUE indicates that the data type is unsigned. VARIANT_FALSE indicates that the data type is signed.NULL indicates that this is not applicable to the data type. | \nfalse | \ntrue | \n
| FIXED_PREC_SCALE | \nboolean | \nA Boolean that indicates whether the data type has a fixed precision and scale. VARIANT_TRUE indicates that the data type has a fixed precision and scale. VARIANT_FALSE indicates that the data type does not have a fixed precision and scale. | \nfalse | \ntrue | \n
| AUTO_UNIQUE_VALUE | \nboolean | \nA Boolean that indicates whether the data type is autoincrementing. VARIANT_TRUE indicates that values of this type can be autoincrementing. VARIANT_FALSE indicates that values of this type cannot be autoincrementing. If this value is VARIANT_TRUE, whether or not a column of this type is always autoincrementing depends on the provider's DBPROP_COL_AUTOINCREMENT column property. If the DBPROP_COL_AUTOINCREMENT property is read/write, whether or not a column of this type is autoincrementing depends on the setting of the DBPROP_COL_AUTOINCREMENT property. If DBPROP_COL_AUTOINCREMENT is a read-only property, either all or none of the columns of this type are autoincrementing. | \nfalse | \ntrue | \n
| LOCAL_TYPE_NAME | \nstring | \nThe localized version of TYPE_NAME. NULL is returned if a localized name is not supported by the data provider. | \nfalse | \ntrue | \n
| MINIMUM_SCALE | \nint | \nIf the type indicator is DBTYPE_VARNUMERIC, DBTYPE_DECIMAL, or DBTYPE_NUMERIC, the minimum number of digits allowed to the right of the decimal point. Otherwise, NULL. | \nfalse | \ntrue | \n
| MAXIMUM_SCALE | \nint | \nThe maximum number of digits allowed to the right of the decimal point if the type indicator is DBTYPE_VARNUMERIC, DBTYPE_DECIMAL, or DBTYPE_NUMERIC; otherwise, NULL. | \nfalse | \ntrue | \n
| GUID | \nstring | \n(Intended for future use) The GUID of the type, if the type is described in a type library. Otherwise, NULL. | \nfalse | \ntrue | \n
| TYPELIB\n | string | \n(Intended for future use) The type library containing the description of the type, if the type is described in a type library. Otherwise, NULL. | \nfalse | \ntrue | \n
| VERSION | \nstring | \n(Intended for future use) The version of the type definition. Providers might want to version type definitions. Different providers might use different versioning schemes, such as a timestamp or number (integer or float). NULL if not supported. | \nfalse | \ntrue | \n
| IS_LONG | \nboolean | \nA Boolean that indicates whether the data type is a binary large object (BLOB) and has very long data. VARIANT_TRUE indicates that the data type is a BLOB that contains very long data; the definition of very long data is provider-specific. VARIANT_FALSE indicates that the data type is a BLOB that does not contain very long data or is not a BLOB. This value determines the setting of the DBCOLUMNFLAGS_ISLONG flag returned by GetColumnInfo in IColumnsInfo and GetParameterInfo in ICommandWithParameters. | \nfalse | \ntrue | \n
| BEST_MATCH | \nboolean | \nA Boolean that indicates whether the data type is a best match. VARIANT_TRUE indicates that the data type is the best match between all data types in the data store and the OLE DB data type indicated by the value in the DATA_TYPE column. VARIANT_FALSE indicates that the data type is not the best match. For each set of rows in which the value of the DATA_TYPE column is the same, the BEST_MATCH column is set to VARIANT_TRUE in only one row. | \nfalse | \ntrue | \n
| IS_FIXEDLENGTH | \nboolean | \nA Boolean that indicates whether the column is fixed in length. VARIANT_TRUE indicates that columns of this type created by the data definition language (DDL) will be of fixed length. VARIANT_FALSE indicates that columns of this type created by the DDL will be of variable length. If the field is NULL, it is not known whether the provider will map this field with a fixed-length or variable-length column.\n | false | \ntrue | \n
DBSCHEMA_PROVIDER_TYPES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_PROVIDER_TYPES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3243,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_SCHEMATA schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
DBSCHEMA_SCHEMATA request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_SCHEMATA schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3268,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_TABLES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
DBSCHEMA_TABLES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_TABLES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3293,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the DBSCHEMA_TABLES_INFO schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
DBSCHEMA_TABLES_INFO request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the DBSCHEMA_TABLES_INFO schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3322,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_ACTIONS schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
MDSCHEMA_ACTIONS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_ACTIONS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3347,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_CUBES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nName of the catalog | \nYes | \nNo | \n
| SCHEMA_NAME | \nstring | \nNot supported | \nYes | \nYes | \n
| CUBE_NAME | \nstring | \nName of the cube. | \nYes | \nNo | \n
| CUBE_TYPE | \nstring | \nType of the cube. | \nYes | \nNo | \n
| CUBE_GUID | \nstring | \nNot supported | \nYes | \nNo | \n
| CREATED_ON | \nDate | \nNot supported | \nYes | \nNo | \n
| LAST_SCHEMA_UPDATE | \nDate | \nThe time that the cube was last processed. | \nYes | \nNo | \n
| SCHEMA_UPDATED_BY | \nstring | \n\n | Yes | \nNo | \n
| LAST_DATA_UPDATE | \nDate | \nThe time that the cube was last processed. | \nYes | \nNo | \n
| DATA_UPDATED_BY | \nstring | \n\n | Yes | \nNo | \n
| DESCRIPTION | \nstring | \nA Human-readable description of the cube. | \nYes | \nNo | \n
| IS_DRILLTHROUGH_ENABLED | \nboolean | \n\n | Yes | \nNo | \n
| IS_LINKABLE | \nboolean | \n\n | Yes | \nNo | \n
| IS_WRITE_ENABLED | \nboolean | \n\n | Yes | \nNo | \n
| IS_SQL_ENABLED | \nboolean | \n\n | Yes | \nNo | \n
| CUBE_CAPTION | \nstring | \nCaption for this cube. | \nYes | \nNo | \n
| BASE_CUBE_NAME | \nstring | \nName of the source cube (if this cube is a perspective cube). | \nYes | \nNo | \n
| ANNOTATIONS | \nstring | \nNotes in xml format | \nYes | \nNo | \n
MDSCHEMA_CUBES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_CUBES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3498,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_DIMENSIONS schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nName of the catalog | \nYes | \nNo | \n
| SCHEMA_NAME | \nstring | \nNot supported | \nYes | \nYes | \n
| CUBE_NAME | \nstring | \nName of the cube. | \nYes | \nNo | \n
| DIMENSION_NAME | \nstring | \nName of the dimension. | \nYes | \nNo | \n
| DIMENSION_UNIQE_NAME | \nstring | \nUnique name for this dimension. | \nYes | \nNo | \n
| DIMENSION_GUID | \nstring | \n\n | No | \nYes | \n
| DIMENSION_CAPTION | \nstring | \n\n | No | \nYes | \n
| DIMENSION_ORDINAL | \nint | \n\n | No | \nYes | \n
| DIMENSION_TYPE | \nstring | \n\n
| \n No | \nYes | \n
| DIMENSION_CARDINALITY | \nint | \n\n | No | \nYes | \n
| DEFAULT_HIERARCHY | \nstring | \n\n | No | \nYes | \n
| DESCRIPTION | \nstring | \nA Human-readable description of the dimension. | \nYes | \nNo | \n
| IS_VIRTUAL | \nboolean | \n\n | Yes | \nNo | \n
| IS_READWRITE | \nboolean | \n\n | Yes | \nNo | \n
| DIMENSION_UNIQUE_SETTINGS | \n\n | \n | Yes | \nNo | \n
| DIMENSION_MASTER_UNIQUE_NAME | \n\n | \n | Yes | \nNo | \n
| IS_VISIBLE | \nboolean | \n\n | Yes | \nNo | \n
MDSCHEMA_DIMENSIONS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_DIMENSIONS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3662,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_FUNCTIONS schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
MDSCHEMA_FUNCTIONS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_FUNCTIONS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3687,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_HIERARCHIES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nName of the catalog | \nYes | \nNo | \n
| SCHEMA_NAME | \nstring | \nNot supported | \nYes | \nYes | \n
| CUBE_NAME | \nstring | \nName of the cube. | \nYes | \nNo | \n
| DIMENSION_UNIQE_NAME | \nstring | \nUnique name for this dimension. | \nYes | \nNo | \n
| HIERARCHY_NAME | \nstring | \nName of the hierarchy. | \nYes | \nNo | \n
| HIERARCHY_UNIQE_NAME | \nstring | \nUnique name for this hierarchy. | \nYes | \nNo | \n
| HIERARCHY_GUID | \nstring | \n\n | No | \nYes | \n
| HIERARCHY_CAPTION | \nstring | \n\n | No | \nYes | \n
| DIMENSION_TYPE | \nstring | \n\n | No | \nYes | \n
| HIERARCHY_CARDINALITY | \nint | \n\n | No | \nYes | \n
| DEFAULT_MEMBER | \nstring | \n\n | No | \nYes | \n
| ALL_MEMBER | \nstring | \n\n | No | \nYes | \n
| DESCRIPTION | \nstring | \nA Human-readable description of the dimension. | \nYes | \nNo | \n
| STRUCTURE | \nstring | \n\n | No | \nYes | \n
| IS_VIRTUAL | \nboolean | \n\n | No | \nYes | \n
| IS_READWRITE | \nboolean | \n\n | No | \nYes | \n
| DIMENSION_UNIQUE_SETTINGS | \nstring | \n\n | No | \nYes | \n
| DIMENSION_MASTER_UNIQUE_NAME | \nstring | \n\n | No | \nYes | \n
| DIMENSION_IS_VISIBLE | \nboolean | \n\n | No | \nYes | \n
| HIERARCHY_ORDINAL | \nint | \n\n | No | \nYes | \n
| DIMENSION_IS_SHARED | \nboolean | \n\n | No | \nYes | \n
| HIERARCHY_IS_VISIBLE | \nboolean | \n\n | No | \nYes | \n
| HIERARCHY_ORIGIN | \n\n | \n | No | \nYes | \n
| HIERARCHY_DISPLAY_FOLDER | \nstring | \n\n | No | \nYes | \n
| INSTANCE_SELECTION | \nstring | \n\n | No | \nYes | \n
MDSCHEMA_HIERARCHIES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_HIERARCHIES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 3887,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_LEVELS schema rowset.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nThe name of the catalog to which this level belongs. NULL if the provider does not support catalogs. | \nNo | \nYes | \n
| SCHEMA_NAME | \nstring | \nThe name of the schema to which this level belongs. NULL if the provider does not support schemas. | \nNo | \nYes | \n
| CUBE_NAME | \nstring | \nThe name of the cube to which this level belongs. | \nNo | \nYes | \n
| DIMENSION_UNIQUE_NAME | \nstring | \nThe unique name of the dimension to which this level belongs. For providers that generate unique names by qualification, each component of this name is delimited. | \nNo | \nYes | \n
| HIERARCHY_UNIQUE_NAME | \nstring | \nThe unique name of the hierarchy. If the level belongs to more than one hierarchy, there is one row for each hierarchy to which it belongs. For providers that generate unique names by qualification, each component of this name is delimited. | \nNo | \nYes | \n
| LEVEL_NAME | \nstring | \nThe name of the level. | \nNo | \nYes | \n
| LEVEL_UNIQUE_NAME | \nstring | \nThe properly escaped unique name of the level. | \nNo | \nYes | \n
| LEVEL_GUID | \nstring | \nNot supported. | \nNo | \nYes | \n
| LEVEL_CAPTION | \nstring | \nA label or caption associated with the hierarchy. Used primarily for display purposes. If a caption does not exist, LEVEL_NAME is returned. | \nNo | \nYes | \n
| LEVEL_NUMBER | \nint | \nThe distance of the level from the root of the hierarchy. Root level is zero (0). | \nNo | \nYes | \n
| LEVEL_CARDINALITY | \nint | \nThe number of members in the level. | \nNo | \nYes | \n
| LEVEL_TYPE | \nint | \nType of the level:\n
| No | \nYes | \n
| DESCRIPTION | \nstring | \nA human-readable description of the level. NULL if no description exists. | \nNo | \nYes | \n
| CUSTOM_ROLLUP_SETTINGS | \nint | \nA bitmap that specifies the custom rollup options: MDLEVELS_CUSTOM_ROLLUP_EXPRESSION (0x01) indicates an expression exists for this level. (Deprecated) MDLEVELS_CUSTOM_ROLLUP_COLUMN (0x02) indicates that there is a custom rollup column for this level. MDLEVELS_SKIPPED_LEVELS (0x04) indicates that there is a skipped level associated with members of this level.MDLEVELS_CUSTOM_MEMBER_PROPERTIES (0x08) indicates that members of the level have custom member properties. MDLEVELS_UNARY_OPERATOR (0x10) indicates that members on the level have unary operators. | \nNo | \nYes | \n
| LEVEL_UNIQUE_SETTINGS | \nint | \nA bitmap that specifies which columns contain unique values, if the level only has members with unique names or keys. The Msmd.h file defines the following bit value constants for this bitmap: MDDIMENSIONS_MEMBER_KEY_UNIQUE (1) MDDIMENSIONS_MEMBER_NAME_UNIQUE (2)The key is always unique in Microsoft SQL Server 2005 Analysis Services (SSAS). The name will be unique if the setting on the attribute is UniqueInDimension or UniqueInAttribute | \nNo | \nYes | \n
| LEVEL_IS_VISIBLE | \nbool | \nA Boolean that indicates whether the level is visible. Always returns True. If the level is not visible, it will not be included in the schema rowset. | \nNo | \nYes | \n
| LEVEL_ORDERING_PROPERTY | \nstring | \nThe ID of the attribute that the level is sorted on. | \nNo | \nYes | \n
| LEVEL_DBTYPE | \nint | \nThe DBTYPE enumeration of the member key column that is used for the level attribute. Null if concatenated keys are used as the member key column. | \nNo | \nYes | \n
| LEVEL_MASTER_UNIQUE_NAME | \nstring | \nAlways returns NULL. | \nNo | \nYes | \n
| LEVEL_NAME_SQL_COLUMN_NAME | \nstring | \nThe SQL representation of the level member names. | \nNo | \nYes | \n
| LEVEL_KEY_SQL_COLUMN_NAME | \nstring | \nThe SQL representation of the level member key values. | \nNo | \nYes | \n
| LEVEL_UNIQUE_NAME_SQL_COLUMN_NAME | \nstring | \nThe SQL representation of the member unique names. | \nNo | \nYes | \n
| LEVEL_ATTRIBUTE_HIERARCHY_NAME | \nstring | \nThe name of the attribute hierarchy providing the source of the level. | \nNo | \nYes | \n
| LEVEL_KEY_CARDINALITY | \nint | \nThe number of columns in the level key. | \nNo | \nYes | \n
| LEVEL_ORIGIN | \nint | \nA bit map that defines how the level was sourced:MD_ORIGIN_USER_DEFINED identifies levels in a user defined hierarchy.MD_ORIGIN_ATTRIBUTE identifies levels in an attribute hierarchy.MD_ORIGIN_KEY_ATTRIBUTE identifies levels in a key attribute hierarchy.MD_ORIGIN_INTERNAL identifies levels in attribute hierarchies that are not enabled. | \nNo | \nYes | \n
MDSCHEMA_LEVELS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_LEVELS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4113,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_MEASURES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nName of the catalog | \nYes | \nNo | \n
| SCHEMA_NAME | \nstring | \nNot supported | \nYes | \nYes | \n
| CUBE_NAME | \nstring | \nName of the cube. | \nYes | \nNo | \n
| MEASURE_NAME | \nstring | \nThe name of the measure. | \nYes | \nNo | \n
| MEASURE_UNIQUE_NAME | \nstring | \nThe Unique name of the measure. For providers that generate unique names by qualification, each component of this name is delimited. | \nYes | \nNo | \n
| MEASURE_CAPTION | \nstring | \nA label or caption associated with the measure. Used primarily for display purposes. If a caption does not exist, MEASURE_NAME is returned. | \nYes | \nNo | \n
| MEASURE_GUID | \nstring | \nNot supported. | \nYes | \nNo | \n
| MEASURE_AGGREGATOR | \nint | \nAn enumeration that indicates how the measure was derived. See http://msdn.microsoft.com/en-us/library/ms126250.aspx | \nYes | \nNo | \n
| DATA_TYPE | \nint | \nThe data type of the measure. See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms711251(v=vs.85).aspx | \nYes | \nNo | \n
| NUMERIC_PRECISION | \nint | \nThe maximum precision of the property if the measure object's data type is exact numeric. NULL for all other property types. | \nYes | \nNo | \n
| NUMERIC_SCALE | \nint | \nThe number of digits to the right of the decimal point if the measure object's type indicator is DBTYPE_NUMERIC or DBTYPE_DECIMAL. Otherwise, this value is NULL. | \nYes | \nNo | \n
| MEASURE_UNITS | \nint | \nNot supported. | \nYes | \nNo | \n
| DESCRIPTION | \nstring | \nA human-readable description of the measure. NULL if no description exists. | \nYes | \nNo | \n
| EXPRESSION | \nstring | \nAn expression for the member. | \nYes | \nNo | \n
| MEASURE_IS_VISIBLE | \nboolean | \nA Boolean that always returns True. If the measure is not visible, it will not be included in the schema rowset. | \nYes | \nNo | \n
| LEVELS_LIST | \nstring | \nA string that always returns NULL. | \nYes | \nNo | \n
| MEASURE_NAME_SQL_COLUMN_NAME | \nstring | \nThe name of the column in the SQL query that corresponds to the measure's name. | \nYes | \nNo | \n
| MEASURE_UNQUALIFIED_CAPTION | \nstring | \nThe name of the measure, not qualified with the measure group name. | \nYes | \nNo | \n
| MEASUREGROUP_NAME | \nstring | \nThe name of the measure group to which the measure belongs. | \nYes | \nNo | \n
| MEASURE_DISPLAY_FOLDER | \nstring | \nThe path to be used when displaying the measure in the user interface. Folder names will be separated by a semicolon. Nested folders are indicated by a backslash (\\). | \nYes | \nNo | \n
| DEFAULT_FORMAT_STRING | \nstring | \nThe default format string for the measure. | \nYes | \nNo | \n
MDSCHEMA_MEASURES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_MEASURES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4285,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_MEMBERS schema rowset.\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|---|---|---|---|
| CATALOG_NAME | \nstring | \nThe name of the catalog | \nYes | \nNo | \n
| SCHEMA_NAME | \nstring | \nThe name of the schema | \nYes | \nNo | \n
| CUBE_NAME | \nstring | \nThe name of the cube | \nYes | \nNo | \n
| DIMENSION_UNIQUE_NAME | \nstring | \nThe unique name of the dimension | \nYes | \nNo | \n
| HIERARCHY_UNIQUE_NAME | \nstring | \nThe unique name of the hierarchy | \nYes | \nNo | \n
| LEVEL_UNIQUE_NAME | \nstring | \nThe unique name of the level | \nYes | \nNo | \n
| LEVEL_NUMBERr | \nint | \nDistance of this level to the root | \nYes | \nNo | \n
| MEMBER_ORDINAL | \nint | \nDeprecated: always 0 | \nYes | \nNo | \n
| MEMBER_NAME | \nstring | \nThe name of this member | \nYes | \nNo | \n
| MEMBER_UNIQUE_NAME | \nstring | \nThe unique name of this member | \nYes | \nNo | \n
| MEMBER_TYPE | \nint | \nAn integer constant indicating the type of this member. Can take on one of the following values:\n \n | \nYes | \nNo | \n
| MEMBER_GUID | \nstring | \nThe guid of this member | \nYes | \nNo | \n
| MEMBER_CAPTION | \nstring | \nA label or caption associated with the member. Used primarily for display purposes. If a caption does not exist, MEMBER_NAME is returned. | \nYes | \nNo | \n
| CHILDREN_CARDINALITY | \nint | \nThe number of childrend for this member | \nYes | \nNo | \n
| PARENT_LEVEL | \nint | \nThe distance of the member's parent from the root level of the hierarchy. The root level is zero (0). | \nYes | \nNo | \n
| DESCRIPTION | \nstring | \nThis column always returns a NULL value. This column exists for backwards compatibility | \nYes | \nNo | \n
| EXPRESSION | \nstring | \nThe expression for calculations, if the member is of type MDMEMBER_TYPE_FORMULA. | \nYes | \nNo | \n
| MEMBER_KEY | \nstring | \nThe value of the member's key column. Returns NULL if the member has a composite key. | \nYes | \nNo | \n
MDSCHEMA_MEMBERS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_MEMBERS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4444,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_PROPERTIES schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
MDSCHEMA_PROPERTIES request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_PROPERTIES schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4469,
"description": "Invokes the discover() method using\nrequestType,\nand retrieves the MDSCHEMA_SETS schema rowset.\n...todo...\nThe rowset has the following columns:\n| Column Name | \nType | \nDescription | \nRestriction | \nNullable | \n
|---|
MDSCHEMA_SETS request.",
"type": "Object"
}
],
"return": {
"description": "The result of the invoking the XML/A Discover method. For synchronous requests, an instance of a Xmla.Rowset that represents the MDSCHEMA_SETS schema rowset. For an asynchronous request, the return value is not defined: you should add a listener (see: addListener()) and listen for the success (see: EVENT_SUCCESS) or discoversuccess (see: EVENT_DISCOVER_SUCCESS) events.",
"type": "Xmla.Rowset"
},
"class": "Xmla",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4544,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_UNKNOWN",
"static": 1,
"final": 1,
"type": "int",
"default": "0",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4556,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_TIME",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4568,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_MEASURE",
"static": 1,
"final": 1,
"type": "int",
"default": "2",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4580,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_OTHER",
"static": 1,
"final": 1,
"type": "int",
"default": "3",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4592,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_QUANTITATIVE",
"static": 1,
"final": 1,
"type": "int",
"default": "5",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4604,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_ACCOUNTS",
"static": 1,
"final": 1,
"type": "int",
"default": "6",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4616,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_CUSTOMERS",
"static": 1,
"final": 1,
"type": "int",
"default": "7",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4628,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_PRODUCTS",
"static": 1,
"final": 1,
"type": "int",
"default": "8",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4640,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_SCENARIO",
"static": 1,
"final": 1,
"type": "int",
"default": "9",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4652,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_UTILIY",
"static": 1,
"final": 1,
"type": "int",
"default": "10",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4664,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_CURRENCY",
"static": 1,
"final": 1,
"type": "int",
"default": "11",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4676,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_RATES",
"static": 1,
"final": 1,
"type": "int",
"default": "12",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4688,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_CHANNEL",
"static": 1,
"final": 1,
"type": "int",
"default": "13",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4700,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_PROMOTION",
"static": 1,
"final": 1,
"type": "int",
"default": "14",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4712,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_ORGANIZATION",
"static": 1,
"final": 1,
"type": "int",
"default": "15",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4724,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_BILL_OF_MATERIALS",
"static": 1,
"final": 1,
"type": "int",
"default": "16",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4736,
"description": "A possible value for the DIMENSION_TYPE column that appears in the\nMDSCHEMA_DIMENSIONS (See: discoverMDDimensions()) and\nMDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowsets.",
"itemtype": "property",
"name": "MD_DIMTYPE_GEOGRAPHY",
"static": 1,
"final": 1,
"type": "int",
"default": "17",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4749,
"description": "A possible value for the STRUCTURE column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.",
"itemtype": "property",
"name": "MD_STRUCTURE_FULLYBALANCED",
"static": 1,
"final": 1,
"type": "int",
"default": "0",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4759,
"description": "A possible value for the STRUCTURE column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.",
"itemtype": "property",
"name": "MD_STRUCTURE_RAGGEDBALANCED",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4769,
"description": "A possible value for the STRUCTURE column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.",
"itemtype": "property",
"name": "MD_STRUCTURE_UNBALANCED",
"static": 1,
"final": 1,
"type": "int",
"default": "2",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4779,
"description": "A possible value for the STRUCTURE column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.",
"itemtype": "property",
"name": "MD_STRUCTURE_NETWORK",
"static": 1,
"final": 1,
"type": "int",
"default": "3",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4790,
"description": "A bitmap value for the HIERARCHY_ORIGIN column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.\nIdentifies user defined hierarchies.",
"itemtype": "property",
"name": "MD_USER_DEFINED",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4801,
"description": "A bitmap value for the HIERARCHY_ORIGIN column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.\nidentifies attribute hierarchies.",
"itemtype": "property",
"name": "MD_SYSTEM_ENABLED",
"static": 1,
"final": 1,
"type": "int",
"default": "2",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4812,
"description": "A bitmap value for the HIERARCHY_ORIGIN column of the\n MDSCHEMA_HIERARCHIES (See: discoverMDHierarchies())rowset.\nidentifies attributes with no attribute hierarchies.",
"itemtype": "property",
"name": "MD_SYSTEM_INTERNAL",
"static": 1,
"final": 1,
"type": "int",
"default": "4",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4824,
"description": "A possible value for the MEMBER_TYPE column of the\nMDSCHEMA_MEMBERS rowset (see: discoverMDMembers()),\nindicating a regular member.",
"itemtype": "property",
"name": "MDMEMBER_TYPE_REGULAR",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4835,
"description": "A possible value for the MEMBER_TYPE column of the\nMDSCHEMA_MEMBERS rowset (see: discoverMDMembers()),\nindicating an all member.",
"itemtype": "property",
"name": "MDMEMBER_TYPE_ALL",
"static": 1,
"final": 1,
"type": "int",
"default": "2",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4846,
"description": "A possible value for the MEMBER_TYPE column of the\nMDSCHEMA_MEMBERS rowset (see: discoverMDMembers()),\nindicating a formula member.",
"itemtype": "property",
"name": "MDMEMBER_TYPE_FORMULA",
"static": 1,
"final": 1,
"type": "int",
"default": "3",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4857,
"description": "A possible value for the MEMBER_TYPE column of the\nMDSCHEMA_MEMBERS rowset (see: discoverMDMembers()),\nindicating a measure member.",
"itemtype": "property",
"name": "MDMEMBER_TYPE_MEASURE",
"static": 1,
"final": 1,
"type": "int",
"default": "4",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 4868,
"description": "A possible value for the MEMBER_TYPE column of the\nMDSCHEMA_MEMBERS rowset (see: discoverMDMembers()),\nindicating a member of unknown type",
"itemtype": "property",
"name": "MDMEMBER_TYPE_UNKNOWN",
"static": 1,
"final": 1,
"type": "int",
"default": "0",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5119,
"description": "Indicates the type of rowset. In most cases, this will be identical to the requestType value that was used in the\nDiscover request",
"itemtype": "method",
"name": "getType",
"return": {
"description": "int One of the DISCOVER_XXX, DBSCHEMA_XXX or MDSCHEMA_XXX constants"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5129,
"description": "Retrieve an array of fieldDef objects that describes the fields of the rows in this rowset.\nThe position of the fieldDef objects in the array corresponds to the column order of the rowset.\nFor a description of the fieldDef object, see the\nfieldDef() method.",
"itemtype": "method",
"name": "getFields",
"return": {
"description": "An (ordered) array of field definition objects.",
"type": "[fieldDef]"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5146,
"description": "Retrieve an array of field names.\nThe position of the names in the array corresponds to the column order of the rowset.",
"itemtype": "method",
"name": "getFieldNames",
"return": {
"description": "An (ordered) array of field names.",
"type": "[string]"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5158,
"description": "Indicates wheter the rowset can still be traversed.\nYou can use this method together with the\nnextRow() method\nto drive a while loop to traverse all rows in the rowset, like so:\n \n while(rowset.hasMoreRows()){\n ...process row...\n rowsete.nextRow();\n }\n ",
"itemtype": "method",
"name": "hasMoreRows",
"return": {
"description": "true in case there are more rows to traverse. false if all rows have been traversed.",
"type": "Bool"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5175,
"description": "Moves the internal row index to the next row.\nYou can use this method together with the\nhasMoreRows() method\nto drive a while loop to traverse all rows in the rowset.",
"itemtype": "method",
"name": "nextRow",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5188,
"description": "This method is deprecated and may be removed in the future.\nUse nextRow() instead.",
"itemtype": "method",
"name": "next",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5196,
"description": "Walks through all rows, and calls the callback function for each row.
\n\nThe callback function gets passed an object that represents the row.\nThe keys of the row object are the column names, and the values are the respective column values.
\nThe scope for calling the callback can be passed as the second argument to this method.\nIf the scope is not defined (or if it is null), the Rowset's this pointer is used instead.
You can pass additional data to the callback by passing in a third argument. This is then passed as is as second argument to the callback.
\n\nThe eachRow method will iterate untill the callback returns false, or until all rows have been traversed.\nIf the callback returns false, iteration is aborted and eachRow as a whole returns false too.\nIf iteration is not aborted, then eachRow returns true.
hasMoreRows().",
"itemtype": "method",
"name": "curr",
"return": {
"description": "int"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5241,
"description": "Returns the number of rows in the set.",
"itemtype": "method",
"name": "rowCount",
"return": {
"description": "int"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5250,
"description": "Resets the internal row pointer so the resultset can be traversed again.",
"itemtype": "method",
"name": "reset",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5259,
"description": "Retrieves a fieldDef object by name.\nA fieldDef describes a field (column). It has the following properties:\nname argument passed to the fieldDef() method.fieldDef object that matches the argument.",
"type": "FieldDef"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5285,
"description": "Retrieves the index of a field by name.\nField indexes start at 0.",
"itemtype": "method",
"name": "fieldIndex",
"params": [
{
"name": "name",
"description": "The name of the field for which you want to retrieve the index.",
"type": "String"
}
],
"return": {
"description": "The ordinal position (starting at 0) of the field that matches the argument.",
"type": "Int"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5295,
"description": "Retrieves the name of a field by field Index.\nField indexes start at 0.",
"itemtype": "method",
"name": "fieldName",
"params": [
{
"name": "name",
"description": "The name of the field for which you want to retrieve the index.",
"type": "String"
}
],
"return": {
"description": "The ordinal position (starting at 0) of the field that matches the argument.",
"type": "Int"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5312,
"description": "Retrieves a value from the current row for the field having the name specified by the argument.",
"itemtype": "method",
"name": "fieldVal",
"params": [
{
"name": "name",
"description": "The name or the index of the field for which you want to retrieve the value.",
"type": "String | int"
}
],
"return": {
"description": "From the current row, the value of the field that matches the argument.",
"type": "Array|boolean|float|int|string"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5322,
"description": "Returns the number of fields in this rowset.",
"itemtype": "method",
"name": "fieldCount",
"return": {
"description": "The number of fields in this rowset.",
"type": "Int"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5330,
"description": "Releases references to the DomDocument passed to the Rowset constructor.\nThis should facilitate automatic garbage collection by the browser.",
"itemtype": "method",
"name": "close",
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5340,
"description": "Reads the current row and returns the result as a new array.\nThis method does not advance the internal row pointer, and does not check if there is a valid row.\nThis method exists mainly as a convience in case you want to use a custom way to extract data from the resultset using the\nfetchCustom() method.\nIf you just want to obtain the results as arrays, see\nfetchAsArray()\nand\nfetchAllAsArray().",
"itemtype": "method",
"name": "readAsArray",
"return": {
"description": "",
"type": "Array"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5363,
"description": "Fetch all values from all fields from the current row, and return it in an array.\nThe position of the values in the array corresponds to the column order of the rowset.\nThe internal row pointer is also increased so the next call will read the next row.\nThe method returns false when there are no more rows to traverse.\nYou can use this method to drive a loop to travere all rows in the Rowset:\n\nwhile (rowArray = rowset.fetchAsArray()){\n ...process array...\n}\n",
"itemtype": "method",
"name": "fetchAsArray",
"return": {
"description": "",
"type": "Array"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5385,
"description": "Reads the current row and returns the result as a new object.\nThis method does not advance the internal row pointer, and does not check if there is a valid row.\nThis method exists mainly as a convience in case you want to use a custom way to extract data from the resultset using the\nfetchCustom() method.\nIf you just want to obtain the results as objects, see\nfetchAsObject()\nand\nfetchAllAsObject().",
"itemtype": "method",
"name": "readAsObject",
"return": {
"description": "",
"type": "Object"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5408,
"description": "Fetch all values from all fields from the current row, and return it in an Object literal.\nThe property names of the returned object correspond to the fieldName (actually the fieldLabel), and the field value is assigned to its respective property.\nThe internal row pointer is also increased so the next call will read the next row.\nThe method returns false when there are no more rows to traverse.\nYou can use this method to drive a loop to travere all rows in the Rowset:\n\nwhile (rowObject = rowset.fetchAsObject()){\n ...process object...\n}\n",
"itemtype": "method",
"name": "fetchAsObject",
"return": {
"description": "",
"type": "Object|boolean"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5430,
"description": "Fetch the values using a custom callback function.\nIf there are rows to fetch, the custom function is called in scope of the rowset, so you can use this inside the custom function to refer to the rowset object.\nThen, the internal row pointer is increased so the next call will read the next row.\nThe method returns whatever object or value is returned by the custom function, or false when there are no more rows to traverse.",
"itemtype": "method",
"name": "fetchCustom",
"params": [
{
"name": "func",
"description": "a custom function to extract and return the data from the current row of the xml result.",
"type": "Function"
},
{
"name": "args",
"description": "an object that will be passed to the function. Useful to hold any data required in addition to the rowset itself (which can be referred to as this inside the function).",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Mixed|boolean"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5450,
"description": "Fetch all values from all fields from all rows, and return it as an array of arrays.\nSee fetchAsArray().",
"itemtype": "method",
"name": "fetchAllAsArray",
"params": [
{
"name": "rows",
"description": "OPTIONAL. An array to append the rows to. If not specified, a new array is created",
"type": "Array[]"
}
],
"return": {
"description": "",
"type": "Array"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5463,
"description": "Fetch all values from all fields from all rows, and return it as an array of objects.\nSee fetchAsObject().",
"itemtype": "method",
"name": "fetchAllAsObject",
"params": [
{
"name": "rows",
"description": "OPTIONAL. An array to append the rows to. If not specified, a new array is created",
"type": "Array[]"
}
],
"return": {
"description": "",
"type": "Array"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5476,
"description": "Fetch all rows using a custom function, and return the return values as an array.\nSee fetchCustom().",
"itemtype": "method",
"name": "fetchAllCustom",
"params": [
{
"name": "rows",
"description": "OPTIONAL. An array to append the rows to. If not specified, a new array is created",
"type": "Array[]"
},
{
"name": "func",
"description": "a callback function to extract the fields.",
"type": "Function"
},
{
"name": "args",
"description": "an object to pass data to the callback.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Array"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5491,
"description": "Fetch all row as an object, store it in nested objects according to values in the column identified by the key argument.\nThis method should typically not be called directly, rather it is a helper method for mapAllAsObject().",
"itemtype": "method",
"name": "mapAsObject",
"params": [
{
"name": "map",
"description": ""
},
{
"name": "key",
"description": ""
},
{
"name": "row",
"description": ""
}
],
"return": {
"description": "a tree using column values as branch names, and storing a row or an array of rows at the leaves.",
"type": "Object"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5519,
"description": "Fetch all rows as an object, store them as proprties in an object (which acts as map).",
"itemtype": "method",
"name": "mapAllAsObject",
"params": [
{
"name": "key",
"description": "OPTIONAL. A column name or an array of column names that will be used to generate property names for the map. If not specified, the default key is used. If there is no default key, all column names will be used.",
"type": "String|array"
},
{
"name": "map",
"description": "OPTIONAL. The object that is used as map. Rows are added as properties to this map. If not specified, a new object is created",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "Xmla.Rowset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5571,
"description": "Can be used as argument for getAxis() to get the first axis (the column axis).\nAlternatively you can simply call getColumnAxis()",
"itemtype": "property",
"name": "AXIS_COLUMNS",
"static": 1,
"final": 1,
"type": "int",
"default": "0",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5581,
"description": "Can be used as argument for getAxis() to get the second axis (the row axis).\nAlternatively you can simply call getRowAxis()",
"itemtype": "property",
"name": "AXIS_ROWS",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5591,
"description": "Can be used as argument for getAxis() to get the third axis (the page axis).\nAlternatively you can simply call getPageAxis()",
"itemtype": "property",
"name": "AXIS_PAGES",
"static": 1,
"final": 1,
"type": "int",
"default": "2",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5601,
"description": "Can be used as argument for getAxis() to get the fourth axis (the section axis).\nAlternatively you can simply call getSectionAxis()",
"itemtype": "property",
"name": "AXIS_SECTIONS",
"static": 1,
"final": 1,
"type": "int",
"default": "3",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5611,
"description": "Can be used as argument for getAxis() to get the fifth axis (the chapters axis).\nAlternatively you can simply call getChapterAxis()",
"itemtype": "property",
"name": "AXIS_CHAPTERS",
"static": 1,
"final": 1,
"type": "int",
"default": "4",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5621,
"description": "Can be used as argument for getAxis() to get the slicer axis\n(the axis that appears in the WHERE clause of an MDX-SELECT statement).\nAlternatively you can simply call getSlicerAxis()",
"itemtype": "property",
"name": "AXIS_SLICER",
"static": 1,
"final": 1,
"type": "string",
"default": "SlicerAxis",
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5705,
"description": "Get the number of proper axes in this Dataset. This is the number of axes that appears in the SELECT list, and excludes the slicer axis.",
"itemtype": "method",
"name": "axisCount",
"return": {
"description": "",
"type": "Int"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5725,
"description": "Get the axis specified by the argument index or name.\nIf the axis does not exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasAxis() method to determine if the axis exists.\nAlternatively, you can call axisCount(), and use an integer argument between zero (inclusive) and axis count (exclusive).",
"itemtype": "method",
"name": "getAxis",
"params": [
{
"name": "nameOrIndex",
"description": "For int arguments, a value of 0 up to the number of axes. You can also use one of the AXIS_xxx constants. For string arguments, this method will match the name of the axis as it is returned in the XML/A response. These names are of the form AxisN where N is an ordinal that identifies the axis.",
"type": "String | int"
}
],
"return": {
"description": "The Xmla.Dataset.Axis object that corresponds to the argument.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5745,
"description": "Determine if the axis specified by the argument exists.",
"itemtype": "method",
"name": "hasAxis",
"params": [
{
"name": "nameOrIndex",
"description": "For int arguments, a value of 0 up to the number of axes. You can also use one of the AXIS_xxx constants. For string arguments, this method will match the name of the axis as it is returned in the XML/A response. These names are of the form AxisN where N is an ordinal that identifies the axis.",
"type": "String | int"
}
],
"return": {
"description": "true if the specified axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5755,
"description": "Get the Column axis. This is the first axis, and has ordinal 0. If the column axis doesn't exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasColumnAxis() method to determine if the axis exists.",
"itemtype": "method",
"name": "getColumnAxis",
"return": {
"description": "The column Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5764,
"description": "Determine if the column axis exists.",
"itemtype": "method",
"name": "hasColumnAxis",
"return": {
"description": "true if the column axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5772,
"description": "Get the Row axis. This is the second axis, and has ordinal 1. If the row axis doesn't exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasRowAxis() method to determine if the axis exists.",
"itemtype": "method",
"name": "getRowAxis",
"return": {
"description": "The row Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5781,
"description": "Determine if the row axis exists.",
"itemtype": "method",
"name": "hasRowAxis",
"return": {
"description": "true if the row axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5789,
"description": "Get the Page axis. This is the third axis, and has ordinal 2. If the page axis doesn't exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasPageAxis() method to determine if the axis exists.",
"itemtype": "method",
"name": "getPageAxis",
"return": {
"description": "The page Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5798,
"description": "Determine if the page axis exists.",
"itemtype": "method",
"name": "hasPageAxis",
"return": {
"description": "true if the page axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5806,
"description": "Get the Section axis. This is the fourth axis, and has ordinal 3. If the section axis doesn't exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasSectionAxis() method to determine if the axis exists.",
"itemtype": "method",
"name": "getSectionAxis",
"return": {
"description": "The section Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5815,
"description": "Determine if the section axis exists.",
"itemtype": "method",
"name": "hasSectionAxis",
"return": {
"description": "true if the section axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5823,
"description": "Get the Chapter axis. This is the fifth axis, and has ordinal 4. If the chapter axis doesn't exist, an INVALID_AXIS exception is thrown.\nTo prevent an exception from being thrown, you should call the hasChapterAxis() method to determine if the axis exists.",
"itemtype": "method",
"name": "getChapterAxis",
"return": {
"description": "The chapter Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5832,
"description": "Determine if the chapter axis exists.",
"itemtype": "method",
"name": "hasChapterAxis",
"return": {
"description": "true if the chapter axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5840,
"description": "Get the Slicer axis. This is the axis that appears in the WHERE clause of the MDX statement.",
"itemtype": "method",
"name": "getSlicerAxis",
"return": {
"description": "The slicer Xmla.Dataset.Axis object.",
"type": "Xmla.Dataset.Axis"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5848,
"description": "Determine if the slicer axis exists.",
"itemtype": "method",
"name": "hasSlicerAxis",
"return": {
"description": "true if the slicer axis exists, false if it doesn't exist.",
"type": "Boolean"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5856,
"description": "Get the Cellset object.",
"itemtype": "method",
"name": "getCellset",
"return": {
"description": "The Xmla.Dataset.Cellset object.",
"type": "Xmla.Dataset.Cellset"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5864,
"description": "Calculate the cellset ordinal for the argument tuple indexes.
\nThis method accepts a variable number of tuple indexes. One integer argument must be passed for each proper axis (excluding the slicer axis).\nEach integer arguments represent the index of a tuple on the respective axis.
\nThe arguments must be specified by descending axis order. So if the data set has two axes (a row and a column axis),\nthis method expects the tuple index of a tuple on the row axis first, and after that, the tuple index on the column axis.
\nThe method returns an integer that represents the ordinal of the cell identified by the tuples specified by the tuple index arguments.\nOne could use this ordinal as argument to the getByOrdinal() method of this Dataset's Cellset.
Instead of calling this method and passing the result into the Cellsets getByOrdinal() method,\nyou can call the getByTupleIndexes() method of this Dataset's Cellset.
Xmla.Dataset.Cellset that belongs to the tuples identified by the arguments.",
"type": "Int"
},
"class": "Xmla.Dataset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 5881,
"description": "Gets all of the XML data into one JS object. The object consists of the following members:\naxes: An array of objects that represent the query axes (but not the slicer axis).\n Each axis has a positions member which is an array of tuples, and a hierarchies member, which is an array of hierarchies.slicerAxis: An object that represents the slicer axis, or null if there is no slicer axis.cells: An array of cell objects, representing the cellset.DisplayInfo property.\nBitwise AND-ing this mask to the member's DisplayInfo property returns an estimate of the number of children of this member.",
"itemtype": "property",
"name": "MDDISPINFO_CHILDREN_CARDINALITY",
"static": 1,
"final": 1,
"type": "int",
"default": "65535",
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6020,
"description": "A constant that can be used as a bitmask for a member's DisplayInfo property.\nIf this bit is set, it means the member is drilled down.\nThis is the case whenever at least one child of this member appears on the axis immediately following this member.",
"itemtype": "property",
"name": "MDDISPINFO_DRILLED_DOWN",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6031,
"description": "A constant that can be used as a bitmask for a member's DisplayInfo property.\nIf this bit is set, it means this member has the same parent as the member immediately preceding this member.",
"itemtype": "property",
"name": "MDDISPINFO_SAME_PARENT_AS_PREV",
"static": 1,
"final": 1,
"type": "int",
"default": "1",
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6146,
"description": "Resets this axis object.\nThis resets internal counters for iterating through the hierarchies and tuples of this Axis object.\nWhen using hierarchy and tuple iterators to traverse the entire axis, you typically won't need to call this method yourself.",
"itemtype": "method",
"name": "reset",
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6157,
"description": "Checks if there are more hierarchies to iterate through.\nYou can use this method along with the nextHierarchy() method to drive a loop\nto iterate through the hierarchies contained in this axis object.",
"itemtype": "method",
"name": "hasMoreHierarchies",
"return": {
"description": "Returns true if there are more hierarchies to vist, false if all hierarchies are traversed.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6167,
"description": "Moves the internal hierarchy pointer forward.\nYou can use this method along with the hasMoreHierarchies() method to drive a loop\nto iterate through the hierarchies contained in this axis object.",
"itemtype": "method",
"name": "nextHierarchy",
"return": {
"description": "Returns the index of current hierarchy.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6177,
"description": "Calls a callback function for each hierarchy in this Axis object.
\nThe callback function is passed an object that represents the current hierarchy. This object has the following structure:
index int The ordinal identifying this hierarchyname string The name of this hierarchyThe callback may return false to abort iteration. If the callback does not return false, iteration will resume until all hierarchies are traversed.
null, the Axis' this pointer will be used.",
"type": "Object"
},
{
"name": "args",
"description": "Additional data to be passed to the callback function..",
"type": "Object"
}
],
"itemtype": "method",
"name": "eachHierarchy",
"return": {
"description": "Returns true if all hierarchies were visited and the callback did not return false. Returns false if the callback returned false and further iteration was aborted.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6205,
"description": "Checks if there are more tuples to iterate through.\nYou can use this method along with the nextTuple() method to drive a loop\nto iterate through the tuples contained in this axis object.",
"itemtype": "method",
"name": "hasMoreTuples",
"return": {
"description": "Returns true if there are more tuples to vist, false if all tuples are traversed.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6215,
"description": "Moves the internal tuple pointer forward.\nYou can use this method along with the nextTuple() method to drive a loop\nto iterate through the tuples contained in this axis object.",
"itemtype": "method",
"name": "nextTuple",
"return": {
"description": "Returns the index of current tuple.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6227,
"description": "Gets the number of tuples in this axis object.",
"itemtype": "method",
"name": "tupleCount",
"return": {
"description": "Returns the number of tuples in this Axis object.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6235,
"description": "Returns the current value of the tuple pointer.",
"itemtype": "method",
"name": "tupleIndex",
"return": {
"description": "Returns the current value of the tuple pointer.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6243,
"description": "Get the current tuple as an object. The tuple object has the following structure: index int: the ordinal of this tuple within its axishierarchies object: A map of members using hierarchy names as keys, and member objects as valuesmembers array: An array of members in order of hierarchy order.Calls a callback function for each tuple in this Axis object.
\nThe callback function is passed an object that represents the current tuple. (see getTuple() for a description of the tuple format.)
The callback may return false to abort iteration. If the callback does not return false, iteration will resume until all tuples are traversed.
null, the Axis' this pointer will be used.",
"type": "Object"
},
{
"name": "args",
"description": "Additional data to be passed as the second argument to the callback function.",
"type": "Object"
}
],
"itemtype": "method",
"name": "eachTuple",
"return": {
"description": "Returns true if all tuples were visited and the callback did not return false. Returns false if the callback returned false and further iteration was aborted.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6290,
"description": "Returns the hierarchies of this Axis object.",
"itemtype": "method",
"name": "getHierarchies",
"return": {
"description": "An array of hierarchies contained in this Axis.",
"type": "Array"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6298,
"description": "Returns the names of the hierarchies of this Axis object.",
"itemtype": "method",
"name": "getHierarchyNames",
"return": {
"description": "An array of names of the hierarchies contained in this Axis.",
"type": "Array"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6308,
"description": "Gets the number of hierarchies in this axis object.",
"itemtype": "method",
"name": "hierarchyCount",
"return": {
"description": "Returns the number of hierarchies in this Axis object.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6316,
"description": "Gets the index of the hierarchy identified by the specified name, or the index of the current hierarchy (in case the name argument is omitted).",
"itemtype": "method",
"name": "hierarchyIndex",
"params": [
{
"name": "hierarchyName",
"description": "The name of the hierarchy for which the index is to be retrieved. When omitted, the index of the current hierarchy is returned.",
"type": "String"
}
],
"return": {
"description": "The index of the hierarchy specified by the name passed as argument, or the index of the current hierarchy if the name argument is omitted.",
"type": "Int"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6333,
"description": "Gets the name of the hierarchy identified by the specified index, or the name of the current hierarchy (in case the index argument is omitted).",
"itemtype": "method",
"name": "hierarchyName",
"params": [
{
"name": "hierarchyIndex",
"description": "The ordinal of the hierarchy for which the name is to be retrieved. When omitted, the name of the current hierarchy is returned.",
"type": "Int"
}
],
"return": {
"description": "The name of the hierarchy specified by the argument index, or the name of the current hierarchy if the index argument is omitted.",
"type": "String"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6351,
"description": "Gets the hierarchy identified by the specified index or hierarchyName, or the current hierarchy (in case the argument is omitted).\nThe hierarchy is returned as an object with the following properties:index - inthierarchy - string. Name of the hiearchy to which this member belongs.UName - string. Unique name of this member.Caption - string. Human friendly name for this member.LName - string. Name of the level to which this member belongs.LNum - int. Number of the level to which this member belongs. Typically, the top-level is level 0, its children are level 1 and so on.DisplayInfo - int. A 4 byte value. The 2 least significant bytes form a 16 bit integer that conveys the number of children of this member.\n The remaining two most significant bytes form a 16 bit bitfield.\n \nThe index and hierarchy properties are non standard and always added by Xmla4js.\nThe properties UName, Caption, LName and LNum are defined by the XML/A standard, and should always be present.\nThe property DisplayInfo is non-standard, but often available.\nOther properties may be present depending on the specific XML/A provider.\n
UNameCaptionLNameLNumDisplayInfotrue if the current member has the specified property, false if it doesn't.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6474,
"description": "Gets the current tuple as an array of members.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "readAsArray",
"params": [
{
"name": "array",
"description": "An existing array to store the members in. If omitted, a new array is returned.",
"type": "Array"
}
],
"return": {
"description": "An array of members that represents the current tuple.",
"type": "Array"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6487,
"description": "Gets the current tuple as an object.\nThe object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "readAsObject",
"params": [
{
"name": "object",
"description": "An existing object to store the tuple data in. If omitted, a new object is returned.",
"type": "Object"
}
],
"return": {
"description": "An object that represents the current tuple.",
"type": "Object"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6501,
"description": "Gets the current tuple as an array of members and advances the internal tuple pointer.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "fetchAsArray",
"params": [
{
"name": "array",
"description": "An existing array to store the members in. If omitted, a new array is returned.",
"type": "Array"
}
],
"return": {
"description": "An array of members that represents the current tuple, or false if there are no more tuples.",
"type": "Array|false"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6516,
"description": "Gets the current tuple as an object and advances the current tuple pointer.\nThe object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "fetchAsObject",
"params": [
{
"name": "object",
"description": "An existing object to store the tuple data in. If omitted, a new object is returned.",
"type": "Object"
}
],
"return": {
"description": "An object that represents the current tuple.",
"type": "Object"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6532,
"description": "Fetches all tuples and returns them as an array of arrays.\nEach element of the returned array is an array of member objects.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "fetchAllAsArray",
"params": [
{
"name": "rows",
"description": "An existing array to store the tuples in. If omitted, a new array is returned.",
"type": "Array"
}
],
"return": {
"description": "An array of arrays representing all tuples that belong to this axis.",
"type": "[[array]]"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6547,
"description": "Fetches all tuples and returns them as an array of objects.\nEach element of the returned array is a tuple object.\nThe object's keys are the hierarchy names, and the members of the current tuple are used as values for the keys.\nFor a description of the structure of the member elements, see member().",
"itemtype": "method",
"name": "fetchAllAsObject",
"params": [
{
"name": "rows",
"description": "An existing array to store the tuples in. If omitted, a new array is returned.",
"type": "Array"
}
],
"return": {
"description": "An array of arrays representing all tuples that belong to this axis.",
"type": "[[object]]"
},
"class": "Xmla.Dataset.Axis",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6662,
"description": "Returns the number of cells contained in this cellset.\nThis is the number of cells that is actually present in the cellset - not the number of logical cells.\nThe nuber of logical cells can be be calculated by multiplying the tuple counts of all axes of the data set.\nThe XML/A provider will typically not return empty cells, hence, the cellCount may be less than the logical cell count.",
"itemtype": "method",
"name": "cellCount",
"return": {
"description": "The number of cells in this cellset.",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6673,
"description": "Resets the internal cell pointer to the argument, or to 0 if the argument is omitted.\nNormally, you shouldn't have to call this method yourself.",
"itemtype": "method",
"name": "reset",
"params": [
{
"name": "idx",
"description": "",
"type": "Int"
}
],
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6683,
"description": "Check if there are cells to iterate through.",
"itemtype": "method",
"name": "hasMoreCells",
"return": {
"description": "true if there are more cells to iterate, false if there are no more cells to iterate.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6691,
"description": "Advance to the next (physical) cell.\nNote that this method may appear to be skipping cells. This happens when the XML/A provider omits empty cells in the response.",
"itemtype": "method",
"name": "nextCell",
"return": {
"description": "returns the ordinal of the next cell, or -1 if there was no next cell.",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6708,
"description": "Returns the internal cell pointer. This is the fysical cell pointer.\nTo get the logical cell pointer, see cellOrdinal()",
"itemtype": "method",
"name": "curr",
"return": {
"description": "returns the internal cell pointer.",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6717,
"description": "Check if the cell has the specified property.\nXML/A defines these standard properties:ValueFmtValueForeColorBackColortrue if the current cell has the specified property, false if it doesn't.",
"type": "Boolean"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6734,
"description": "Return the value of the current property of the current cell.\nXML/A defines these standard properties:ValueFmtValueForeColorBackColorcurr()",
"itemtype": "method",
"name": "cellOrdinal",
"return": {
"description": "returns the logical cell pointer.",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6827,
"description": "Reads the current cell into the specified object.",
"itemtype": "method",
"name": "readCell",
"params": [
{
"name": "object",
"description": "An existing object to use for the current cell. If omitted, a new object will be created.",
"type": "Object"
}
],
"return": {
"description": "An object that represents the current cell.",
"type": "Object"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6837,
"description": "Iterate through each cell.",
"itemtype": "method",
"name": "eachCell",
"params": [
{
"name": "callback",
"description": "",
"type": "Function()"
},
{
"name": "scope",
"description": "",
"type": "Object"
},
{
"name": "args",
"description": "",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6860,
"description": "Get a cell by its physical index.\nThis method should typically not be called by clients.\nInstead, they should use getByOrdinal()",
"itemtype": "method",
"name": "getByIndex",
"params": [
{
"name": "index",
"description": "- the physical index of the cell within the cellset.",
"type": "Int"
},
{
"name": "object",
"description": "- optional. An object to copy the properties of the specified cell to. If omitted, a new object will be returned instead.",
"type": "Object"
}
],
"return": {
"description": "An object that represents the cell.",
"type": "Object"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6873,
"description": "Get a cell by its logical index.",
"itemtype": "method",
"name": "getByOrdinal",
"params": [
{
"name": "ordinal",
"description": "- the ordinal number of the cell to retrieve.",
"type": "Int"
},
{
"name": "object",
"description": "- optional. An object to copy the properties of the specified cell to. If omitted, a new object will be returned instead.",
"type": "Object"
}
],
"return": {
"description": "An object that represents the cell.",
"type": "Object"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6892,
"description": "Get the physical cell index for the specified ordinal number.\nThis method is useful to calculate boundaries to retrieve a range of cells.",
"itemtype": "method",
"name": "indexForOrdinal",
"params": [
{
"name": "ordinal",
"description": "- the ordinal number for which the index shoul dbe returned",
"type": "Int"
}
],
"return": {
"description": "The physical index.",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6912,
"description": "Get a range of cells withing the range that fits the specified ordinals.\nThis method is useful to grab a slice of cells for a subset of the axes.\n(You can use cellOrdinalForTupleIndexes to calculate ordinals in terms of tuple indexes.)\nThe returned range only contains cells that actually exist so the ordinal of adjacent cells may have gaps,",
"itemtype": "method",
"name": "fetchRangeAsArray",
"params": [
{
"name": "from",
"description": "- the ordinal number indicating the start of the range",
"type": "Int"
},
{
"name": "to",
"description": "- the ordinal number indicating the end of the range",
"type": "Int"
}
],
"return": {
"description": "- An array of cells that fit the specified range.",
"type": "[object]"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6934,
"description": "Calculate the ordinal based on the specified tuple indexes.",
"itemtype": "method",
"name": "cellOrdinalForTupleIndexes",
"params": [
{
"name": "tuple",
"description": "index - a variable list of integer arguments. Arguments represent the index of a tuple on the query axes. Tuple indexes should be specified by descending order of axes. For example, if you have a DataSet with 2 Axes, pass the row tuple index as the first argument, and the column tuple index as the last argument.",
"type": "int..."
}
],
"return": {
"description": "The ordinal number for this combination of tuple indexes. This return value can be used as argument for getByOrdinal()",
"type": "Int"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6943,
"description": "Get the cell corresponding to the specified tuple indexes.",
"itemtype": "method",
"name": "getByTupleIndexes",
"params": [
{
"name": "ordinal",
"description": "",
"type": "int..."
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 6952,
"description": "Close this cellset.",
"itemtype": "method",
"name": "close",
"class": "Xmla.Dataset.Cellset",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7002,
"description": "Can appear as value for the type property of instances of the Xmla.Exception class,\nand indicates that this Xmla.Exception signals a warning.",
"itemtype": "property",
"name": "TYPE_WARNING",
"static": 1,
"final": 1,
"type": "string",
"default": "warning",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7013,
"description": "Can appear as value for the type property of instances of the Xmla.Exception class,\nand indicates that this Xmla.Exception signals an error.",
"itemtype": "property",
"name": "TYPE_ERROR",
"static": 1,
"final": 1,
"type": "string",
"default": "error",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7027,
"description": "Exception code indicating a requestType option was expected but ommitted.",
"itemtype": "property",
"name": "MISSING_REQUEST_TYPE_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-1",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7041,
"description": "Exception code indicating a statement option was expected but ommitted.",
"itemtype": "property",
"name": "MISSING_STATEMENT_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-2",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7056,
"description": "Exception code indicating a url option was expected but ommitted.",
"itemtype": "property",
"name": "MISSING_URL_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-3",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7071,
"description": "Exception code indicating a events were expected but ommitted.",
"itemtype": "property",
"name": "NO_EVENTS_SPECIFIED_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-4",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7086,
"description": "Exception code indicating a events were specifeid in the wrong format.",
"itemtype": "property",
"name": "WRONG_EVENTS_FORMAT_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-5",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7101,
"description": "Exception code indicating that the event name was unrecognized.",
"itemtype": "property",
"name": "UNKNOWN_EVENT_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-6",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7115,
"description": "Exception code indicating that no proper handler was passed for the events.",
"itemtype": "property",
"name": "INVALID_EVENT_HANDLER_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-7",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7129,
"description": "Exception code indicating that the rrepsonse could not be parsed",
"itemtype": "property",
"name": "ERROR_PARSING_RESPONSE_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-8",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7143,
"description": "Exception code indicating the field name is not valid.",
"itemtype": "property",
"name": "INVALID_FIELD_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-9",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7158,
"description": "Exception code indicating a general XMLHttpRequest error.\nIf this error occurs, the data object of the exception will have these members:\n-10",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7178,
"description": "Exception code indicating the hierarchy name is not valid.",
"itemtype": "property",
"name": "INVALID_HIERARCHY_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-11",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7193,
"description": "Exception code indicating a problem reading a member property",
"itemtype": "property",
"name": "UNEXPECTED_ERROR_READING_MEMBER_CDE",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-12",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7208,
"description": "Exception code indicating the requested axis does not exist",
"itemtype": "property",
"name": "INVALID_AXIS",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-13",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7223,
"description": "Exception code indicating illegal number of axis arguments",
"itemtype": "property",
"name": "ILLEGAL_ARGUMENT",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-14",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7238,
"description": "Exception code indicating that we couldn't instantiate a xml http request object",
"itemtype": "property",
"name": "ERROR_INSTANTIATING_XMLHTTPREQUEST",
"static": 1,
"final": 1,
"type": "{int}",
"default": "-15",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7265,
"description": "This propery indicates what kind of exception occurred. It can have one of the following values: TYPE_WARNINGTYPE_ERRORarguments array of the function that is throwing the exception\nThis can be used to get a \"stack trace\"",
"itemtype": "property",
"name": "args",
"type": "{array}",
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7321,
"description": "Returns a string representing this exception",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representing this exception"
},
"class": "Xmla.Exception",
"module": "xmla"
},
{
"file": "../src/Xmla.js",
"line": 7329,
"description": "Get a stack trace.",
"itemtype": "method",
"name": "getStackTrace",
"return": {
"description": "an array of objects describing the function on the stack"
},
"class": "Xmla.Exception",
"module": "xmla"
}
],
"warnings": [
{
"message": "unknown tag: reset",
"line": " ../src/Xmla.js:5953"
},
{
"message": "Missing item type\nReset this object so it can be used again.",
"line": " ../src/Xmla.js:5953"
}
]
}