getSchema

[ Function ]

public static getSchema(): TcHmi.JsonSchema | null;

Returns the schema object to a type definition or null in case of error.

getSchema 1:

The schema to a symbol can be obtained via its API resolveSchema() and to a symbol expression via TcHmi.Symbol.resolveSchema().

Parameter

Name

Type

Description

-

-

-

Return value

Type

Description

TcHmi.JsonSchema, null

The schema object.

getSchema 2:

Available from version 1.10

Sample - JavaScript

var schema = TcHmi.Type.getSchema('tchmi:general#/definitions/String');
if (schema) {
    console.log(schema); // {default: "", id: "tchmi:general#/definitions/String", type: "string"}
}