Filters

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 Filters(options: SchemaOptions): Filters

• Inherited from Schema.constructor

  Parameters

  • options: SchemaOptions

  Returns Filters

Properties

apiBaseUrl

apiBaseUrl: string

Inherited from Schema.apiBaseUrl

optionalapiEndpoints

apiEndpoints?: ApiEndpoints

Inherited from Schema.apiEndpoints

optionalauthorization

authorization?: AuthorizationCredentials

Inherited from Schema.authorization

events

events: Events

Inherited from Schema.events

optionalfields

fields?: ArrayIndexed<SchemaField>

Inherited from Schema.fields

id

id: number

Inherited from Schema.id

lastChangeTime

lastChangeTime: number

Inherited from Schema.lastChangeTime

model

model: SchemaModel

Inherited from Schema.model

name

name: string

Inherited from Schema.name

objectNamePlural

objectNamePlural: string

Inherited from Schema.objectNamePlural

objectNameSingular

objectNameSingular: string

Inherited from Schema.objectNameSingular

remote

remote: boolean

Inherited from Schema.remote

strict

strict: boolean

Inherited from Schema.strict

optionaltitle

title?: string

Inherited from Schema.title

type

type: SchemaType

Inherited from Schema.type

Methods

addField

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

• Inherited from Schema.addField

  Parameters

  • field: Record<string, unknown> | SchemaField

  Returns void

build

• build(options: any): void

• Inherited from Schema.build

  Parameters

  • options: any

  Returns void

getColumns

• getColumns(filters: any): any[]

• Inherited from Schema.getColumns

  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 }

• Inherited from Schema.getData

  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

• Inherited from Schema.getField

  Parameters

  • field: any

  Returns SchemaField

getFieldByType

• getFieldByType(type: any): any

• Inherited from Schema.getFieldByType

  Parameters

  • type: any

  Returns any

getFieldNames

• getFieldNames(): string[]

• Inherited from Schema.getFieldNames

  Returns string[]

getFields

• getFields(): ArrayIndexed<SchemaField>

• Inherited from Schema.getFields

  Returns ArrayIndexed<SchemaField>

loaded

• loaded(): boolean

• Inherited from Schema.loaded

  Returns boolean

setApiBaseUrl

• setApiBaseUrl(url: string): void

• Inherited from Schema.setApiBaseUrl

  Parameters

  • url: string

  Returns void

setApiEndpoints

• setApiEndpoints(endpoints: ApiEndpoint[]): ApiEndpoints

• Inherited from Schema.setApiEndpoints

  Parameters

  • endpoints: ApiEndpoint[]

  Returns ApiEndpoints

setAuthorization

• setAuthorization(credentials: AuthorizationCredentials): void

• Inherited from Schema.setAuthorization

  Parameters

  • credentials: AuthorizationCredentials

  Returns void

setFields

• setFields(fields: any[]): void

• Inherited from Schema.setFields

  Parameters

  • fields: any[]

  Returns void

setId

• setId(id: number): void

• Inherited from Schema.setId

  Parameters

  • id: number

  Returns void

setName

• setName(name: string): void

• Inherited from Schema.setName

  Parameters

  • name: string

  Returns void

setObjectNamePlural

• setObjectNamePlural(namePlural: string): void

• Inherited from Schema.setObjectNamePlural

  Parameters

  • namePlural: string

  Returns void

setObjectNameSingular

• setObjectNameSingular(nameSingular: string): void

• Inherited from Schema.setObjectNameSingular

  Parameters

  • nameSingular: string

  Returns void

setRemote

• setRemote(value: boolean): void

• Inherited from Schema.setRemote

  Parameters

  • value: boolean

  Returns void

setStrict

• setStrict(value: boolean): void

• Inherited from Schema.setStrict

  Parameters

  • value: boolean

  Returns void

setTitle

• setTitle(title: string): void

• Inherited from Schema.setTitle

  Parameters

  • title: string

  Returns void

setType

• setType(val: SchemaType): void

• Inherited from Schema.setType

  Parameters

  • val: SchemaType

  Returns void

update

• update(options: any): void

• Inherited from Schema.update

  Parameters

  • options: any

  Returns void