Skip to content

data-renderer

data-renderer

Interfaces

CollectionField

Defined in: packages/platform-utils/build/collection/types.d.ts:40

Type Parameters

Type Parameter Default type
TName extends string string

Properties

array?
readonly optional array?: boolean;

Defined in: packages/platform-utils/build/collection/types.d.ts:45

currencies?
readonly optional currencies?: readonly string[];

Defined in: packages/platform-utils/build/collection/types.d.ts:49

kind
readonly kind: string;

Defined in: packages/platform-utils/build/collection/types.d.ts:42

label?
readonly optional label?: string;

Defined in: packages/platform-utils/build/collection/types.d.ts:44

mimeTypes?
readonly optional mimeTypes?: readonly string[];

Defined in: packages/platform-utils/build/collection/types.d.ts:50

name
readonly name: TName;

Defined in: packages/platform-utils/build/collection/types.d.ts:41

nullable
readonly nullable: boolean;

Defined in: packages/platform-utils/build/collection/types.d.ts:43

options?
readonly optional options?: Readonly<Record<string, unknown>>;

Defined in: packages/platform-utils/build/collection/types.d.ts:48

readOnly?
readonly optional readOnly?: boolean;

Defined in: packages/platform-utils/build/collection/types.d.ts:46

relation?
readonly optional relation?: object;

Defined in: packages/platform-utils/build/collection/types.d.ts:52

name
readonly name: string;
recordLabel
readonly recordLabel: string | null;
target
readonly target: string;

values?
readonly optional values?: readonly string[];

Defined in: packages/platform-utils/build/collection/types.d.ts:47

variant?
readonly optional variant?: NumericRendererVariant;

Defined in: packages/platform-utils/build/collection/types.d.ts:51

DataRendererProps

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:2

Properties

class?
optional class?: string;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:15

disabled?
optional disabled?: boolean;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:7

field
field: CollectionField;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:3

id?
optional id?: string;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:5

locale?
optional locale?: string;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:14

mode?
optional mode?: "display" | "edit";

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:6

onRowChange?
optional onRowChange?: (patch) => void;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:12

Parameters
Parameter Type
patch Record<string, unknown>
Returns

void

onValueChange?
optional onValueChange?: (value) => void;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:9

Parameters
Parameter Type
value unknown
Returns

void

placeholder?
optional placeholder?: string;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:8

relationQuery?
optional relationQuery?: CollectionQuery<CollectionRecord>;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:13

row?
optional row?: Record<string, unknown>;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:11

Full matrix/form row when the renderer needs sibling fields.

value
value: unknown;

Defined in: packages/ui/build/data-renderer/data-renderer.types.d.ts:4

DataRendererRuntime

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:7

Properties

customTypeRenderers
readonly customTypeRenderers: CustomTypeRendererMap;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:11

Methods

autocompleteGeolocation()
autocompleteGeolocation(query): Promise<TGeolocationPickerValue[]>;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:8

Parameters
Parameter Type
query string
Returns

Promise<TGeolocationPickerValue[]>

createFileUploadClient()
createFileUploadClient(): IFileUploadClient;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:9

Returns

IFileUploadClient

renderStaticMap()
renderStaticMap(input): Promise<StaticMapImage>;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:10

Parameters
Parameter Type
input StaticMapRequest
Returns

Promise<StaticMapImage>

Type Aliases

CustomTypeRendererMap

type CustomTypeRendererMap = Readonly<Record<string, Component<DataRendererProps>>>;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:6

DataRenderer

type DataRenderer = ReturnType<typeof DataRenderer>;

Defined in: packages/ui/build/data-renderer/data-renderer.svelte.d.ts:2

Variables

DataRenderer

const DataRenderer: Component;

Defined in: packages/ui/build/data-renderer/data-renderer.svelte.d.ts:2

Functions

formatDataValue()

function formatDataValue(
   field, 
   value, 
   locale?): string;

Defined in: packages/ui/build/data-renderer/data-renderer.utils.d.ts:3

Parameters

Parameter Type
field CollectionField
value unknown
locale? string

Returns

string

getDataRendererRuntimeContext()

function getDataRendererRuntimeContext(): 
  | DataRendererRuntime
  | undefined;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:13

Returns

| DataRendererRuntime | undefined

setDataRendererRuntimeContext()

function setDataRendererRuntimeContext(runtime): void;

Defined in: packages/ui/build/data-renderer/data-renderer-runtime.d.ts:14

Parameters

Parameter Type
runtime DataRendererRuntime

Returns

void