Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddColumnsFromUriRequest

Data provided to Publisher.addColumnsFromJsonUri used to add columns and data a data table using data stored in a JSON file served at a URI. The JSON file should be of the form:

{
  columns: Array<{
    name: string,
    dataType: 'int'
      | 'long'
      | 'float'
      |  'double'
      | 'decimal'
      | 'binary'
      | 'bool'
      | 'string'
      | 'date'
      | 'datetime'
      | 'timespan',
  }>,
  data: any[][],
  format: 'dataTable',
  version: '1.0',
}

Hierarchy

  • AddColumnsFromUriRequest

Index

Properties

Properties

joinType

joinType: "InnerJoin" | "LeftOuterJoin" | "RightOuterJoin" | "FullOuterJoin" | "LeftSingleMatchJoin" | "RightSingleMatchJoin"

The way in which the data is joined with the target table.

table

table: { id?: string; name?: string }

The target table to which columns will be added defined by the table id or name - one of these must be provided. If both fields are provided, the id is used preferentially to find the table in the document.

Type declaration

  • Optional id?: string
  • Optional name?: string

uri

uri: string

The location of the JSON containing the data to add to the target data table.

Generated using TypeDoc