Class: Schema
Schema class contains the list of fields with their options for MapSVG database or regions tables
Extended by
Constructors
Constructor
new Schema(options): Schema;
Parameters
| Parameter | Type |
|---|---|
options | SchemaOptions |
Returns
Schema
Methods
addField()
addField(field): void;
Parameters
| Parameter | Type |
|---|---|
field | | Record<string, unknown> | SchemaField |
Returns
void
build()
build(options): void;
Parameters
| Parameter | Type |
|---|---|
options | any |
Returns
void
getColumns()
getColumns(filters): any[];
Parameters
| Parameter | Type |
|---|---|
filters | any |
Returns
any[]
getData()
getData(): object;
Returns
object
apiBaseUrl
apiBaseUrl: string;
apiEndpoints
apiEndpoints: ApiEndpoints;
authorization
authorization: AuthorizationCredentials;
fields
fields: ArrayIndexed<SchemaField>;
id
id: number;
name
name: string;
objectNamePlural
objectNamePlural: string;
objectNameSingular
objectNameSingular: string;
remote
remote: boolean;
title
title: string;
type
type: SchemaType;
getField()
getField(field): SchemaField;
Parameters
| Parameter | Type |
|---|---|
field | any |
Returns
getFieldByType()
getFieldByType(type): any;
Parameters
| Parameter | Type |
|---|---|
type | any |
Returns
any
getFieldNames()
getFieldNames(): string[];
Returns
string[]
getFields()
getFields(): ArrayIndexed<SchemaField>;
Returns
loaded()
loaded(): boolean;
Returns
boolean
setApiBaseUrl()
setApiBaseUrl(url): void;
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
void
setApiEndpoints()
setApiEndpoints(endpoints): ApiEndpoints;
Parameters
| Parameter | Type |
|---|---|
endpoints | ApiEndpoint[] |
Returns
setAuthorization()
setAuthorization(credentials): void;
Parameters
| Parameter | Type |
|---|---|
credentials | AuthorizationCredentials |
Returns
void
setFields()
setFields(fields): void;
Parameters
| Parameter | Type |
|---|---|
fields | any[] |
Returns
void
setId()
setId(id): void;
Parameters
| Parameter | Type |
|---|---|
id | number |
Returns
void
setName()
setName(name): void;
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
void
setObjectNamePlural()
setObjectNamePlural(namePlural): void;
Parameters
| Parameter | Type |
|---|---|
namePlural | string |
Returns
void
setObjectNameSingular()
setObjectNameSingular(nameSingular): void;
Parameters
| Parameter | Type |
|---|---|
nameSingular | string |
Returns
void
setRemote()
setRemote(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
setStrict()
setStrict(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
setTitle()
setTitle(title): void;
Parameters
| Parameter | Type |
|---|---|
title | string |
Returns
void
setType()
setType(val): void;
Parameters
| Parameter | Type |
|---|---|
val | SchemaType |
Returns
void
update()
update(options): void;
Parameters
| Parameter | Type |
|---|---|
options | any |
Returns
void
Properties
apiBaseUrl
apiBaseUrl: string;
apiEndpoints?
optional apiEndpoints: ApiEndpoints;
authorization?
optional authorization: AuthorizationCredentials;
events
events: Events;
fields?
optional fields: ArrayIndexed<SchemaField>;
id
id: number;
lastChangeTime
lastChangeTime: number;
model
model: SchemaModel;
name
name: string;
objectNamePlural
objectNamePlural: string;
objectNameSingular
objectNameSingular: string;
remote
remote: boolean;
strict
strict: boolean;
title?
optional title: string;
type
type: SchemaType;