VS.DataTable()

An instance of a VS.DataTable() is created by adding one to a VS.Document() object:

myDataTable=myDocument.AddDataTable(ID,Name)

Both Name and ID are optional and if not supplied default unique values will be applied. The Name variable is only relevant when building a SmartDraw Extension. It is the human readable name of the table shown in the SmartDraw Shape Data UI.

A DataTable consists of a list of fields (columns) and rows of values for each of these fields. A row of values can be assigned to a VS.Shape() object. This is called Shape Data.

Data table

In resulting visual, a shape with Shape Data shows an information icon which displays a tooltip showing the data:

Data table

Visuals built with Shape Data can be rich with information without cluttering the design.

VS.DataTable() Methods

  • AddDataRow() - Adds a VS.DataRow() object to a DataTable
  • SetColumns() - Sets names and types of columns of a DataTable.

AddDataRow()

Example

myDataRow=myDataTable.AddDataRow(1);

Syntax

myDataRow=myDataTable.AddDataRow(ID);

Usage

This method adds a VS.DataRow() object to a DataTable. The ID is optional. If omitted, the new row will be assigned a unique ID. If the ID of an existing row is passed, AddDataRow() returns the existing row and does not allocate a new one.

SetColumns()

Example

myDataTable=myDataTable.SetColumns([{Name:"Name",Type:VS.DataColumnTypes.Text},{Name:"Hire Date",Type:VS.DataColumnTypes.Date}]);

Syntax

myDataTable=myDataTable.SetColumns(columnarray); //where columnarray is an array of {Name:"",Type:""}

Usage

This method adds columns to a DataTable. Upon creation a DataArray has no columns. SetColumns adds columns to the table. A second call to AddColumns() will add additional unique columns to the DataTable.

The columnarray passed is an array of column objects:

(Name:"myName",Type:VS.DataColumnTypes}

The following types are supported:

VS.DataColumnTypes =

{
Text: "string",
Int: "int",
Float: "float",
Bool: "bool",
Date:"date",
};

In most cases using Text for a column type is sufficient.

VS.DataRow()

An instance of a VS.DataRow() is created in two ways:

  • by adding one directly to a VS.DataTable() object
  • by adding one to a VS.Shape()

The two methods support two different strategies for assigning data to shapes. The first (adding directly to the data table) works best when the data and its association with a shape is well-known up front. The second method (adding data via the shape) works best when data is known at the time that the shape is created.

Adding a DataRow() Directly to a DataTable()

myDataRow=myDataTable.AddDataRow(ID)

The VS.DataTable.AddDataRow() method adds a new data row to an existing DataTable. The ID is the unique ID of the row and is optional. If omitted, the row is automatically assigned a unique ID.

The new added row has empty values for each column in the table. Data values are added using the VS.DataRow.SetValues() method.

Adding a DataRow() to a VS.Shape()

myDataRow=myShape.AddShapeDataRow(myDocument,TableID);

The VS.Shape.AddShapeDataRow() method takes the VS.Document object, and the TableID of an already defined DataTable, adds a new empty row and assigns to the Shape. Both parameters are required.

Data values are added using the VS.DataRow.SetValues() method.

VS.DataRow() Methods

  • SetValues() - Sets the values for each column of a DataRow.

SetValues()

Example

myDataRow=myDataRow.SetValues([{Name:"Name","Value":"James Smith"},{Name:"Title","Value":"HR Manager"}]);

Syntax

myDataRow=myDataRow.SetValues(valuearray); //array of {Name:"myColumnName",Value:"myValue"} - where Name is a column names and Value is the value for this row.

Usage

This method adds values for a row for the columns of a DataTable. Calling the method multiple times just appends the list of values. Specifying a column name that does not exists causes the value to be ignored.