Class View

View Class

Implements

AbstractView

Constructors

constructor

new View(o: View | ViewCfg): View
View constructor
Parameters
- o: View | ViewCfg
Returns View
- Defined in packages/saltcorn-data/models/view.ts:87

Properties

`Optional`attributes

attributes?: any

`Optional`configuration

configuration?: any

`Optional`default_render_page

default_render_page?: string

`Optional`description

description?: string

`Optional`exttable_name

exttable_name?: string

`Optional`id

id?: number

min_role

min_role: number

name

name: string

`Optional`singleton

singleton?: boolean

`Optional`slug

slug?: any

`Optional`table

table?: AbstractTable

`Optional`table_id

table_id?: number

`Optional`table_name

table_name?: string

`Optional`updated_at

updated_at?: Date

viewtemplate

viewtemplate: string

`Optional`viewtemplateObj

viewtemplateObj?: ViewTemplate

Accessors

menu_label

get menu_label(): string | undefined
Get menu label

Returns string | undefined
- Defined in packages/saltcorn-data/models/view.ts:208

select_option

get select_option(): any
Returns any
- Defined in packages/saltcorn-data/models/view.ts:256

Methods

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>
Deprecated
use authorize(user, { action: "get", ... }) instead. remote defaults to false here, not isRemoteTable().
- Defined in packages/saltcorn-data/models/view.ts:487

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>
Deprecated
use authorize(user, { action: "post", ... }) instead. remote defaults to false here, not isRemoteTable().
- Defined in packages/saltcorn-data/models/view.ts:464

authorize

authorize(
    user: any,
    opts: {
        action: "get" | "post";
        body?: GenObj;
        remote?: boolean;
        req: any;
        route?: string;
        state?: GenObj;
    },
): Promise<boolean>
Checks plugin authorize_view hooks, proxied to the server on mobile for remote tables, so hooks never need to handle remote/local.
Parameters
- user: any
  the acting user (or undefined/public)
- opts: {
      action: "get" | "post";
      body?: GenObj;
      remote?: boolean;
      req: any;
      route?: string;
      state?: GenObj;
  }
  - action: "get" | "post"
    "get" or "post"
  - Optionalbody?: GenObj
    POST body, for action "post"
  - Optionalremote?: boolean
    defaults to this.isRemoteTable()
  - req: any
    the request object, forwarded to hooks
  - Optionalroute?: string
    name of a specific viewtemplate custom route being invoked (ViewTemplate.routes key), if any
  - Optionalstate?: GenObj
    query/state, for action "get"
Returns Promise<boolean>
- Defined in packages/saltcorn-data/models/view.ts:432

check_viewtemplate

check_viewtemplate(): void
Returns void
Throws
- Defined in packages/saltcorn-data/models/view.ts:653

clone

clone(): Promise<View>
Clone View

Returns Promise<View>
- Defined in packages/saltcorn-data/models/view.ts:335

combine_state_and_default_state

combine_state_and_default_state(req_query: any): any
Parameters
- req_query: any
Returns any
- Defined in packages/saltcorn-data/models/view.ts:897

connected_objects

connected_objects(): Promise<ConnectedObjects>
Returns Promise<ConnectedObjects>
Implementation of AbstractView.connected_objects
- Defined in packages/saltcorn-data/models/view.ts:999

delete

delete(): Promise<void>
Delete current view from db

Returns Promise<void>
- Defined in packages/saltcorn-data/models/view.ts:358

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
- Defined in packages/saltcorn-data/models/view.ts:1045

get_config_flow

get_config_flow(req: Req): Promise<Workflow>
Parameters
- req: Req
Returns Promise<Workflow>
- Defined in packages/saltcorn-data/models/view.ts:920

get_state_fields

get_state_fields(): Promise<FieldLike[]>
Returns Promise<FieldLike[]>
- Defined in packages/saltcorn-data/models/view.ts:185

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
- Defined in packages/saltcorn-data/models/view.ts:1061

getStringsForI18n

getStringsForI18n(): string[]
Returns string[]
- Defined in packages/saltcorn-data/models/view.ts:506

getTags

getTags(): Promise<AbstractTag[]>
get all tags associated with this view

Returns Promise<AbstractTag[]>
a promise with the tags
Implementation of AbstractView.getTags
- Defined in packages/saltcorn-data/models/view.ts:1035

inbound_connected_objects

inbound_connected_objects(): Promise<ConnectedObjects>
Returns Promise<ConnectedObjects>
- Defined in packages/saltcorn-data/models/view.ts:980

interpolate_title_string

interpolate_title_string(title: string, query: any): Promise<string>
Parameters
- title: string
- query: any
Returns Promise<string>
- Defined in packages/saltcorn-data/models/view.ts:410

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
- Defined in packages/saltcorn-data/models/view.ts:1024

openDataStream

openDataStream(
    id: number | undefined,
    fieldName: string,
    fieldView: string,
    user: any,
    targetOpts: any,
): Promise<any>
Parameters
- id: number | undefined
- fieldName: string
- fieldView: string
- user: any
- targetOpts: any
Returns Promise<any>
- Defined in packages/saltcorn-data/models/view.ts:870

queries

queries(remote?: boolean, req?: Req, res?: any): any
Parameters
- Optionalremote: boolean
- Optionalreq: Req
- Optionalres: any
Returns any
- Defined in packages/saltcorn-data/models/view.ts:567

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
- Defined in packages/saltcorn-data/models/view.ts:1069

rewrite_query_from_slug

rewrite_query_from_slug(query: any, params: any): void
Parameters
- query: any
- params: any
Returns void
- Defined in packages/saltcorn-data/models/view.ts:963

run

run(query: any, extraArgs: RunExtra, remote?: boolean): Promise<any>
Run (Execute) View
Parameters
- query: any
- extraArgs: RunExtra
- remote: boolean = ...
Returns Promise<any>
- Defined in packages/saltcorn-data/models/view.ts:535

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 }>
- Defined in packages/saltcorn-data/models/view.ts:667

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
- Defined in packages/saltcorn-data/models/view.ts:709

runPost

runPost(
    query: GenObj,
    body: GenObj,
    extraArgs: RunExtra,
    remote?: boolean,
): Promise<any>
Parameters
- query: GenObj
- body: GenObj
- extraArgs: RunExtra
- remote: boolean = ...
Returns Promise<any>
- Defined in packages/saltcorn-data/models/view.ts:783

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>
- Defined in packages/saltcorn-data/models/view.ts:831

runServerSide

runServerSide(query: any): Promise<string>
Parameters
- query: any
Returns Promise<string>
- Defined in packages/saltcorn-data/models/view.ts:520

`Static`create

create(v: ViewCfg): Promise<View>
Create view in database
Parameters
- v: ViewCfg
Returns Promise<View>
- Defined in packages/saltcorn-data/models/view.ts:315

`Static`delete

delete(where: Where): Promise<void>
Delete list of views
Parameters
- where: Where
  condition
Returns Promise<void>
- Defined in packages/saltcorn-data/models/view.ts:386

`Static`find

find(where?: Where, selectopts?: SelectOptions): Promise<View[]>
Parameters
- Optionalwhere: Where
- selectopts: SelectOptions = ...
Returns Promise<View[]>
- Defined in packages/saltcorn-data/models/view.ts:143

`Static`find_all_views_where

find_all_views_where(pred: FindViewsPred): Promise<View[]>
Parameters
- pred: FindViewsPred
Returns Promise<View[]>
- Defined in packages/saltcorn-data/models/view.ts:275

`Static`find_possible_links_to_table

find_possible_links_to_table(table: string | number | Tablely): Promise<View[]>
Parameters
- table: string | number | Tablely
Returns Promise<View[]>
- Defined in packages/saltcorn-data/models/view.ts:299

`Static`find_table_views_where

find_table_views_where(
table: string | number | Tablely,
pred: FindViewsPred,
): Promise<View[]>
Parameters
- table: string | number | Tablely
- pred: FindViewsPred
Returns Promise<View[]>
- Defined in packages/saltcorn-data/models/view.ts:219

`Static`findOne

findOne(where: Where): View | undefined
Parameters
- where: Where
Returns View | undefined
- Defined in packages/saltcorn-data/models/view.ts:125

`Static`state_refresh

state_refresh(): Promise<void>
Returns Promise<void>
- Defined in packages/saltcorn-data/models/view.ts:200

`Static`update

update(v: any, id: number): Promise<void>
Update View description
Parameters
- v: any
  view name
- id: number
  id
Returns Promise<void>
- Defined in packages/saltcorn-data/models/view.ts:397

Class View

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns View

Properties

Optionalattributes

Optionalconfiguration

Optionaldefault_render_page

Optionaldescription

Optionalexttable_name

Optionalid

min_role

name

Optionalsingleton

Optionalslug

Optionaltable

Optionaltable_id

Optionaltable_name

Optionalupdated_at

viewtemplate

OptionalviewtemplateObj

Accessors

menu_label

Returns string | undefined

select_option

Returns any

Methods

authorise_get

Parameters

Returns Promise<boolean>

Deprecated

authorise_post

Parameters

Returns Promise<boolean>

Deprecated

authorize

Parameters

action: "get" | "post"

Optionalbody?: GenObj

Optionalremote?: boolean

req: any

Optionalroute?: string

Optionalstate?: GenObj

Returns Promise<boolean>

check_viewtemplate

Returns void

Throws

clone

Returns Promise<View>

combine_state_and_default_state

Parameters

Returns any

connected_objects

Returns Promise<ConnectedObjects>

delete

Returns Promise<void>

emitRealTimeEvent

Parameters

Returns void

get_config_flow

Parameters

Returns Promise<Workflow>

get_state_fields

Returns Promise<FieldLike[]>

getRealTimeEventName

Parameters

Returns string

getStringsForI18n

Returns string[]

getTags

Returns Promise<AbstractTag[]>

inbound_connected_objects

Returns Promise<ConnectedObjects>

`Optional`attributes

`Optional`configuration

`Optional`default_render_page

`Optional`description

`Optional`exttable_name

`Optional`id

`Optional`singleton

`Optional`slug

`Optional`table

`Optional`table_id

`Optional`table_name

`Optional`updated_at

`Optional`viewtemplateObj

`Optional`body?: GenObj

`Optional`remote?: boolean

`Optional`route?: string

`Optional`state?: GenObj

`Static`create

`Static`delete

`Static`find

`Static`find_all_views_where

`Static`find_possible_links_to_table

`Static`find_table_views_where

`Static`findOne

`Static`state_refresh

`Static`update