Class export=

constructor

• new "export="(o: export= | ViewCfg): export=

  View constructor

  Parameters

  • o: export= | ViewCfg

  Returns export=

Optionalattributes

Optionalconfiguration

Optionaldefault_render_page

Optionaldescription

Optionalexttable_name

Optionalid

min_role

name

Optionalsingleton

Optionalslug

Optionaltable

Optionaltable_id

Optionaltable_name

viewtemplate

OptionalviewtemplateObj

menu_label

• get menu_label(): undefined | string

  Get menu label

  Returns undefined | string

select_option

• get select_option(): any

  Returns any

authorise_get

• authorise_get(
      arg: { query: any; req: any; table_id: number },
      remote?: boolean,
  ): Promise<boolean>

  Parameters

  • arg: { query: any; req: any; table_id: number }
  • remote: boolean = false

  Returns Promise<boolean>

authorise_post

• authorise_post(
      arg: { body: any; req: any; table_id: number },
      remote?: boolean,
  ): Promise<boolean>

  Parameters

  • arg: { body: any; req: any; table_id: number }
  • remote: boolean = false

  Returns Promise<boolean>

check_viewtemplate

• check_viewtemplate(): void

  Returns void

  Throws

clone

• clone(): Promise<export=>

  Clone View

  Returns Promise<export=>

combine_state_and_default_state

• combine_state_and_default_state(req_query: any): any

  Parameters

  • req_query: any

  Returns any

connected_objects

• connected_objects(): Promise<ConnectedObjects>

  Returns Promise<ConnectedObjects>

delete

• delete(): Promise<void>

  Delete current view from db

  Returns Promise<void>

emitRealTimeEvent

• emitRealTimeEvent(eventType: string, data: any): void

  emit a Real-time collaboration event for this view.

  Parameters

  • eventType: string

    event without view name (e.g. "DROP_EVENT")
  • data: any

    object you want to get in the event handler

  Returns void

get_config_flow

• get_config_flow(req: any): Promise<export=>

  Parameters

  • req: any

  Returns Promise<export=>

get_state_fields

• get_state_fields(): Promise<FieldLike[]>

  Returns Promise<FieldLike[]>

getRealTimeEventName

• getRealTimeEventName(eventType: string): string

  get event name with view name in it (e.g. DROP_EVENT_my_kanban_view).

  Parameters

  • eventType: string

    event without view name (e.g. "DROP_EVENT")

  Returns string

  the full event name

getStringsForI18n

• getStringsForI18n(): string[]

  Returns string[]

getTags

• getTags(): Promise<AbstractTag[]>

  get all tags associated with this view

  Returns Promise<AbstractTag[]>

  a promise with the tags

inbound_connected_objects

• inbound_connected_objects(): Promise<ConnectedObjects>

  Returns Promise<ConnectedObjects>

interpolate_title_string

• interpolate_title_string(title: string, query: any): Promise<string>

  Parameters

  • title: string
  • query: any

  Returns Promise<string>

isRemoteTable

• isRemoteTable(): boolean

  saltcorn-mobile-app helper. Check if the table of a view is local or server-side

  Returns boolean

  true if server-side table

openDataStream

• openDataStream(
      id: undefined | number,
      fieldName: string,
      fieldView: string,
      user: any,
      targetOpts: any,
  ): Promise<any>

  Parameters

  • id: undefined | number
  • fieldName: string
  • fieldView: string
  • user: any
  • targetOpts: any

  Returns Promise<any>

queries

• queries(remote?: boolean, req?: Req, res?: any): any

  Parameters

  • Optionalremote: boolean
  • Optionalreq: Req
  • Optionalres: any

  Returns any

renderLocally

• renderLocally(): boolean

  Should we render on the local machine or get it from a server? In the normal web mode it's always the server but on mobile, we can render on the device as well

  Returns boolean

rewrite_query_from_slug

• rewrite_query_from_slug(query: any, params: any): void

  Parameters

  • query: any
  • params: any

  Returns void

run

• run(query: any, extraArgs: RunExtra, remote?: boolean): Promise<any>

  Run (Execute) View

  Parameters

  • query: any
  • extraArgs: RunExtra
  • remote: boolean = ...

  Returns Promise<any>

run_possibly_on_page

• run_possibly_on_page(
      query: any,
      req: Req,
      res: Res,
      remote?: boolean,
      extra?: any,
  ): Promise<string | { goto?: string }>

  Parameters

  • query: any
  • req: Req
  • res: Res
  • remote: boolean = false
  • extra: any = {}

  Returns Promise<string | { goto?: string }>

runMany

• runMany(
      query: GenObj,
      extraArgs: RunExtra,
      remote?: boolean,
  ): Promise<string[] | { html: string; row: any }[]>

  Run many views with content filtered by query. Used in Search for example

  Parameters

  • query: GenObj

    this is query string
  • extraArgs: RunExtra
  • Optionalremote: boolean

  Returns Promise<string[] | { html: string; row: any }[]>

  Throws

runPost

• runPost(
      query: GenObj,
      body: GenObj,
      extraArgs: RunExtra,
      remote?: boolean,
  ): Promise<any>

  Parameters

  • query: GenObj
  • body: GenObj
  • extraArgs: RunExtra
  • remote: boolean = ...

  Returns Promise<any>

runRoute

• runRoute(
      route: string,
      body: any,
      res: Res,
      extraArgs: RunExtra,
      remote?: boolean,
  ): Promise<any>

  Parameters

  • route: string
  • body: any
  • res: Res
  • extraArgs: RunExtra
  • remote: boolean = false

  Returns Promise<any>

runServerSide

• runServerSide(query: any): Promise<string>

  Parameters

  • query: any

  Returns Promise<string>

Staticcreate

• create(v: ViewCfg): Promise<export=>

  Create view in database

  Parameters

  • v: ViewCfg

  Returns Promise<export=>

Staticdelete

• delete(where: Where): Promise<void>

  Delete list of views

  Parameters

  • where: Where

    condition

  Returns Promise<void>

Staticfind

• find(where?: Where, selectopts?: SelectOptions): Promise<export=[]>

  Parameters

  • Optionalwhere: Where
  • selectopts: SelectOptions = ...

  Returns Promise<export=[]>

Staticfind_all_views_where

• find_all_views_where(pred: FindViewsPred): Promise<export=[]>

  Parameters

  • pred: FindViewsPred

  Returns Promise<export=[]>

Staticfind_possible_links_to_table

• find_possible_links_to_table(
      table: string | number | Tablely,
  ): Promise<export=[]>

  Parameters

  • table: string | number | Tablely

  Returns Promise<export=[]>

Staticfind_table_views_where

• find_table_views_where(
      table: string | number | Tablely,
      pred: FindViewsPred,
  ): Promise<export=[]>

  Parameters

  • table: string | number | Tablely
  • pred: FindViewsPred

  Returns Promise<export=[]>

StaticfindOne

• findOne(where: Where): undefined | export=

  Parameters

  • where: Where

  Returns undefined | export=

Staticstate_refresh

• state_refresh(): Promise<void>

  Returns Promise<void>

Staticupdate

• update(v: any, id: number): Promise<void>

  Update View description

  Parameters

  • v: any

    view name
  • id: number

    id

  Returns Promise<void>