# Variable fieldviews

fieldviews: {
above_input: {
blockDisplay: boolean;
configFields: { label: string; name: string; type: string }[];
isEdit: boolean;
isFilter: boolean;
run: (
nm: any,
v: any,
attrs?: {},
cls: any,
required: any,
field: any,
state?: {},
) => string;
};
below_input: {
blockDisplay: boolean;
configFields: { label: string; name: string; type: string }[];
isEdit: boolean;
isFilter: boolean;
run: (
nm: any,
v: any,
attrs?: {},
cls: any,
required: any,
field: any,
state?: {},
) => string;
};
edit: {
blockDisplay: boolean;
configFields: { label: string; name: string; type: string }[];
description: string;
isEdit: boolean;
run: (
nm: any,
v: any,
attrs: any,
cls: any,
required: any,
field: any,
) => string;
};
edit_star_rating: {
blockDisplay: boolean;
configFields: (
field: any,
) => (
| {
default: number;
label?: undefined;
name: string;
required: boolean;
sublabel?: undefined;
type: string;
}
| {
default?: undefined;
label: string;
name: string;
required?: undefined;
sublabel: string;
type: string;
}
)[];
description: string;
isEdit: boolean;
run: (
nm: any,
v: any,
attrs?: {},
cls: any,
required: any,
field: any,
state?: {},
) => string;
};
heat_cell: {
configFields: (
field: any,
) => (
| {
attributes?: undefined;
class?: undefined;
default?: undefined;
label: string;
name: string;
required?: undefined;
showIf?: undefined;
type: string;
}
| {
attributes?: undefined;
class?: undefined;
default?: undefined;
label: string;
name: string;
required: boolean;
showIf: { max_min_formula: boolean };
type: any;
}
| {
attributes?: undefined;
class: string;
default?: undefined;
label: string;
name: string;
required?: undefined;
showIf: { max_min_formula: boolean };
type: string;
}
| {
attributes: { options: string[] };
class?: undefined;
default?: undefined;
label: string;
name: string;
required: boolean;
showIf?: undefined;
type: string;
}
| {
attributes?: undefined;
class?: undefined;
default: number;
label: string;
name: string;
required?: undefined;
showIf?: undefined;
type: string;
}
)[];
description: string;
isEdit: boolean;
run: (v: any, req: any, attrs?: {}) => string;
};
number_slider: {
blockDisplay: boolean;
configFields: (
field: any,
) => { name: string; required: boolean; type: any }[];
description: string;
isEdit: boolean;
run: (
nm: any,
v: any,
attrs?: {},
cls: any,
required: any,
field: any,
) => string;
};
progress_bar: {
configFields: (
field: any,
) => (
| {
class?: undefined;
label: string;
name: string;
required?: undefined;
showIf?: undefined;
type: string;
}
| {
class?: undefined;
label: string;
name: string;
required: boolean;
showIf: { max_min_formula: boolean; radial?: undefined };
type: any;
}
| {
class: string;
label: string;
name: string;
required?: undefined;
showIf: { max_min_formula: boolean; radial?: undefined };
type: string;
}
| {
class?: undefined;
label: string;
name: string;
required?: undefined;
showIf: { max_min_formula?: undefined; radial: boolean };
type: string;
}
)[];
description: string;
isEdit: boolean;
run: (v: any, req: any, attrs?: {}) => string;
};
range_interval: {
blockDisplay: boolean;
configFields: (
field: any,
) => { name: string; required: boolean; type: any }[];
description: string;
isEdit: boolean;
isFilter: boolean;
run: (
nm: any,
v: any,
attrs?: {},
cls: any,
required: any,
field: any,
state?: {},
) => string;
};
role_select: {
blockDisplay: boolean;
description: string;
fill_options: (field: any) => Promise<void>;
isEdit: boolean;
run: (
nm: any,
v: any,
attrs: any,
cls: any,
required: any,
field: any,
) => string;
};
select_by_code: {
blockDisplay: boolean;
configFields: object[];
description: string;
isEdit: boolean;
run: (
nm: any,
v: any,
attrs: any,
cls: any,
reqd: any,
field: any,
) => object;
type: undefined;
fill_options(
field: any,
force_allow_none: any,
where0: any,
extraCtx: any,
optionsQuery: any,
formFieldNames: any,
user: any,
): Promise<void>;
};
show: { description: string; isEdit: boolean; run: (s: any) => string };
show_star_rating: {
blockDisplay: boolean;
configFields: (
field: any,
) => { default: number; name: string; required: boolean; type: string }[];
description: string;
isEdit: boolean;
run: (v: any, req: any, attrs?: {}) => string;
};
show_with_html: {
configFields: {
attributes: { mode: string };
default: string;
input_type: string;
label: string;
name: string;
sublabel: string;
}[];
description: string;
isEdit: boolean;
run: (v: any, req: any, attrs?: {}) => string;
};
to_locale_string: {
configFields: (
field: any,
) => (
| {
attributes?: undefined;
label: string;
name: string;
required?: undefined;
showIf?: undefined;
sublabel: string;
type: string;
}
| {
attributes: { min?: undefined; options: string[] };
label: string;
name: string;
required: boolean;
showIf?: undefined;
sublabel?: undefined;
type: string;
}
| {
attributes: { min: number; options?: undefined };
label: string;
name: string;
required?: undefined;
showIf?: undefined;
sublabel?: undefined;
type: string;
}
| {
attributes?: undefined;
label: string;
name: string;
required: boolean;
showIf: { style: string };
sublabel: string;
type: string;
}
| {
attributes: { min?: undefined; options: string[] };
label: string;
name: string;
required: boolean;
showIf: { style: string };
sublabel?: undefined;
type: string;
}
)[];
description: string;
isEdit: boolean;
run: (v: any, req: any, attrs?: {}) => string;
};
} = ...

#### Type Declaration

- ##### above_input: {
  blockDisplay: boolean;
  configFields: { label: string; name: string; type: string }[];
  isEdit: boolean;
  isFilter: boolean;
  run: (
  nm: any,
  v: any,
  attrs?: {},
  cls: any,
  required: any,
  field: any,
  state?: {},
  ) => string;
  }

- ##### below_input: {
  blockDisplay: boolean;
  configFields: { label: string; name: string; type: string }[];
  isEdit: boolean;
  isFilter: boolean;
  run: (
  nm: any,
  v: any,
  attrs?: {},
  cls: any,
  required: any,
  field: any,
  state?: {},
  ) => string;
  }

- ##### `Namespace` edit: {
  blockDisplay: boolean;
  configFields: { label: string; name: string; type: string }[];
  description: string;
  isEdit: boolean;
  run: (
  nm: any,
  v: any,
  attrs: any,
  cls: any,
  required: any,
  field: any,
  ) => string;
  }

  #### Subcategory

  types / int

- ##### edit_star_rating: {
  blockDisplay: boolean;
  configFields: (
  field: any,
  ) => (
  | {
  default: number;
  label?: undefined;
  name: string;
  required: boolean;
  sublabel?: undefined;
  type: string;
  }
  | {
  default?: undefined;
  label: string;
  name: string;
  required?: undefined;
  sublabel: string;
  type: string;
  }
  )[];
  description: string;
  isEdit: boolean;
  run: (
  nm: any,
  v: any,
  attrs?: {},
  cls: any,
  required: any,
  field: any,
  state?: {},
  ) => string;
  }

- ##### heat_cell: {
  configFields: (
  field: any,
  ) => (
  | {
  attributes?: undefined;
  class?: undefined;
  default?: undefined;
  label: string;
  name: string;
  required?: undefined;
  showIf?: undefined;
  type: string;
  }
  | {
  attributes?: undefined;
  class?: undefined;
  default?: undefined;
  label: string;
  name: string;
  required: boolean;
  showIf: { max_min_formula: boolean };
  type: any;
  }
  | {
  attributes?: undefined;
  class: string;
  default?: undefined;
  label: string;
  name: string;
  required?: undefined;
  showIf: { max_min_formula: boolean };
  type: string;
  }
  | {
  attributes: { options: string[] };
  class?: undefined;
  default?: undefined;
  label: string;
  name: string;
  required: boolean;
  showIf?: undefined;
  type: string;
  }
  | {
  attributes?: undefined;
  class?: undefined;
  default: number;
  label: string;
  name: string;
  required?: undefined;
  showIf?: undefined;
  type: string;
  }
  )[];
  description: string;
  isEdit: boolean;
  run: (v: any, req: any, attrs?: {}) => string;
  }

- ##### number_slider: {
  blockDisplay: boolean;
  configFields: (
  field: any,
  ) => { name: string; required: boolean; type: any }[];
  description: string;
  isEdit: boolean;
  run: (
  nm: any,
  v: any,
  attrs?: {},
  cls: any,
  required: any,
  field: any,
  ) => string;
  }

- ##### progress_bar: {
  configFields: (
  field: any,
  ) => (
  | {
  class?: undefined;
  label: string;
  name: string;
  required?: undefined;
  showIf?: undefined;
  type: string;
  }
  | {
  class?: undefined;
  label: string;
  name: string;
  required: boolean;
  showIf: { max_min_formula: boolean; radial?: undefined };
  type: any;
  }
  | {
  class: string;
  label: string;
  name: string;
  required?: undefined;
  showIf: { max_min_formula: boolean; radial?: undefined };
  type: string;
  }
  | {
  class?: undefined;
  label: string;
  name: string;
  required?: undefined;
  showIf: { max_min_formula?: undefined; radial: boolean };
  type: string;
  }
  )[];
  description: string;
  isEdit: boolean;
  run: (v: any, req: any, attrs?: {}) => string;
  }

- ##### range_interval: {
  blockDisplay: boolean;
  configFields: (
  field: any,
  ) => { name: string; required: boolean; type: any }[];
  description: string;
  isEdit: boolean;
  isFilter: boolean;
  run: (
  nm: any,
  v: any,
  attrs?: {},
  cls: any,
  required: any,
  field: any,
  state?: {},
  ) => string;
  }

- ##### role_select: {
  blockDisplay: boolean;
  description: string;
  fill_options: (field: any) => Promise<void>;
  isEdit: boolean;
  run: (
  nm: any,
  v: any,
  attrs: any,
  cls: any,
  required: any,
  field: any,
  ) => string;
  }

- ##### select_by_code: {
  blockDisplay: boolean;
  configFields: object[];
  description: string;
  isEdit: boolean;
  run: (
  nm: any,
  v: any,
  attrs: any,
  cls: any,
  reqd: any,
  field: any,
  ) => object;
  type: undefined;
  fill_options(
  field: any,
  force_allow_none: any,
  where0: any,
  extraCtx: any,
  optionsQuery: any,
  formFieldNames: any,
  user: any,
  ): Promise<void>;
  }

  - ##### blockDisplay: boolean

  - ##### configFields: object[]

  - ##### description: string

  - ##### isEdit: boolean

  - ##### run: (nm: any, v: any, attrs: any, cls: any, reqd: any, field: any) => object

  - ##### type: undefined

  - ##### fill_options: function

    - fill_options(
      field: any,
      force_allow_none: any,
      where0: any,
      extraCtx: any,
      optionsQuery: any,
      formFieldNames: any,
      user: any,
      ): Promise<void>

      #### Parameters

      - field: any
      - force_allow_none: any
      - where0: any
      - extraCtx: any
      - optionsQuery: any
      - formFieldNames: any
      - user: any

      #### Returns Promise<void>

      - Defined in packages/saltcorn-data/base-plugin/fieldviews.js:467

- ##### `Namespace` show: { description: string; isEdit: boolean; run: (s: any) => string }

  #### Subcategory

  types / int

- ##### show_star_rating: {
  blockDisplay: boolean;
  configFields: (
  field: any,
  ) => { default: number; name: string; required: boolean; type: string }[];
  description: string;
  isEdit: boolean;
  run: (v: any, req: any, attrs?: {}) => string;
  }

- ##### show_with_html: {
  configFields: {
  attributes: { mode: string };
  default: string;
  input_type: string;
  label: string;
  name: string;
  sublabel: string;
  }[];
  description: string;
  isEdit: boolean;
  run: (v: any, req: any, attrs?: {}) => string;
  }

- ##### to_locale_string: {
  configFields: (
  field: any,
  ) => (
  | {
  attributes?: undefined;
  label: string;
  name: string;
  required?: undefined;
  showIf?: undefined;
  sublabel: string;
  type: string;
  }
  | {
  attributes: { min?: undefined; options: string[] };
  label: string;
  name: string;
  required: boolean;
  showIf?: undefined;
  sublabel?: undefined;
  type: string;
  }
  | {
  attributes: { min: number; options?: undefined };
  label: string;
  name: string;
  required?: undefined;
  showIf?: undefined;
  sublabel?: undefined;
  type: string;
  }
  | {
  attributes?: undefined;
  label: string;
  name: string;
  required: boolean;
  showIf: { style: string };
  sublabel: string;
  type: string;
  }
  | {
  attributes: { min?: undefined; options: string[] };
  label: string;
  name: string;
  required: boolean;
  showIf: { style: string };
  sublabel?: undefined;
  type: string;
  }
  )[];
  description: string;
  isEdit: boolean;
  run: (v: any, req: any, attrs?: {}) => string;
  }

- Defined in packages/saltcorn-data/base-plugin/types.js:1633