JsonDataSource Class
A data source that retrieves data stored in JSON format.
Declaration
export class JsonDataSource extends DataSourceRemarks
The DashboardJsonDataSource allows you to extract JSON data from a Web-service endpoint URI, text file, or a string in JSON format.
Important
The JsonDataSource object requires the open source Newtonsoft.Json library. Install the Newtonsoft.Json NuGet package in Visual Studio.
Inherited Members
constructor
Initializes a new instance of the JsonDataSource class.
Declaration
constructor(
dataSourceJSON?: any,
serializer?: ModelSerializer
)Parameters
| Name | Type | Description |
|---|---|---|
| dataSourceJSON | any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
| serializer | ModelSerializer | An object used for dashboard deserialization. Do not pass this parameter directly. |
Properties
rootElement Property
Specifies a root JSON node.
Declaration
rootElement: ko.Observable<string>Property Value
| Type | Description |
|---|---|
| Observable<string> | A string that is the root node’s name. |
schema Property
Gets a JSON data source schema.
Declaration
schema: ko.Observable<JsonSchemaRootNode>Property Value
| Type | Description |
|---|---|
| Observable<JsonSchemaRootNode> | A JSON data source schema. |
Methods
getDisplayNamePrefix Method
Gets the display name of the current data source.
Declaration
getDisplayNamePrefix(): stringReturns
| Type | Description |
|---|---|
| string | A string that is the display name of the current data source. |
getInfo Method
For internal use.
Declaration
getInfo(): ISerializationInfoArrayReturns
| Type | Description |
|---|---|
| ISerializationInfoArray | An array of objects that provide serialization info. |