Schema

Schema class contains the list of fields with their options for MapSVG database or regions tables

Hierarchy

• Schema
  • Filters

Index

Constructors

• constructor

Properties

• apiBaseUrl
• apiEndpoints
• authorization
• events
• fields
• id
• lastChangeTime
• model
• name
• objectNamePlural
• objectNameSingular
• remote
• strict
• title
• type

Methods

• addField
• build
• getColumns
• getData
• getField
• getFieldByType
• getFieldNames
• getFields
• loaded
• setApiBaseUrl
• setApiEndpoints
• setAuthorization
• setFields
• setId
• setName
• setObjectNamePlural
• setObjectNameSingular
• setRemote
• setStrict
• setTitle
• setType
• update

Constructors

constructor

• new Schema(options: SchemaOptions): Schema

• Parameters

  • options: SchemaOptions

  Returns Schema

Properties

apiBaseUrl

apiBaseUrl: string

optionalapiEndpoints

apiEndpoints?: ApiEndpoints

optionalauthorization

authorization?: AuthorizationCredentials

events

events: Events

optionalfields

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

optionaltitle

title?: string

type

type: SchemaType

Methods

addField

• addField(field: Record<string, unknown> | SchemaField): void

• Parameters

  • field: Record<string, unknown> | SchemaField

  Returns void

build

• build(options: any): void

• Parameters

  • options: any

  Returns void

getColumns

• getColumns(filters: any): any[]

• Parameters

  • filters: any

  Returns any[]

getData

• getData(): { apiBaseUrl: string; apiEndpoints: ApiEndpoints; authorization: AuthorizationCredentials; fields: ArrayIndexed<SchemaField>; id: number; name: string; objectNamePlural: string; objectNameSingular: string; remote: boolean; title: string; type: SchemaType }

• Returns { apiBaseUrl: string; apiEndpoints: ApiEndpoints; authorization: AuthorizationCredentials; fields: ArrayIndexed<SchemaField>; id: number; name: string; objectNamePlural: string; objectNameSingular: string; remote: boolean; title: string; type: SchemaType }

  • apiBaseUrl: string

  • apiEndpoints: ApiEndpoints

  • authorization: AuthorizationCredentials

  • fields: ArrayIndexed<SchemaField>

  • id: number

  • name: string

  • objectNamePlural: string

  • objectNameSingular: string

  • remote: boolean

  • title: string

  • type: SchemaType

getField

• getField(field: any): SchemaField

• Parameters

  • field: any

  Returns SchemaField

getFieldByType

• getFieldByType(type: any): any

• Parameters

  • type: any

  Returns any

getFieldNames

• getFieldNames(): string[]

• Returns string[]

getFields

• getFields(): ArrayIndexed<SchemaField>

• Returns ArrayIndexed<SchemaField>

loaded

• loaded(): boolean

• Returns boolean

setApiBaseUrl

• setApiBaseUrl(url: string): void

• Parameters

  • url: string

  Returns void

setApiEndpoints

• setApiEndpoints(endpoints: ApiEndpoint[]): ApiEndpoints

• Parameters

  • endpoints: ApiEndpoint[]

  Returns ApiEndpoints

setAuthorization

• setAuthorization(credentials: AuthorizationCredentials): void

• Parameters

  • credentials: AuthorizationCredentials

  Returns void

setFields

• setFields(fields: any[]): void

• Parameters

  • fields: any[]

  Returns void

setId

• setId(id: number): void

• Parameters

  • id: number

  Returns void

setName

• setName(name: string): void

• Parameters

  • name: string

  Returns void

setObjectNamePlural

• setObjectNamePlural(namePlural: string): void

• Parameters

  • namePlural: string

  Returns void

setObjectNameSingular

• setObjectNameSingular(nameSingular: string): void

• Parameters

  • nameSingular: string

  Returns void

setRemote

• setRemote(value: boolean): void

• Parameters

  • value: boolean

  Returns void

setStrict

• setStrict(value: boolean): void

• Parameters

  • value: boolean

  Returns void

setTitle

• setTitle(title: string): void

• Parameters

  • title: string

  Returns void

setType

• setType(val: SchemaType): void

• Parameters

  • val: SchemaType

  Returns void

update

• update(options: any): void

• Parameters

  • options: any

  Returns void