Skip to content

data-renderer

data-renderer

Interfaces

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:13

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:12

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

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

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

records?
optional records?: CollectionRecordOperations;

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

relationQuery?
optional relationQuery?: CollectionQuery<CollectionRecord>;

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

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:4

Methods

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

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

Parameters
Parameter Type
query string
Returns

Promise<TGeolocationPickerValue[]>

createFileUploadClient()
createFileUploadClient(): IFileUploadClient;

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

Returns

IFileUploadClient

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

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

Parameters
Parameter Type
input StaticMapRequest
Returns

Promise<StaticMapImage>

Type Aliases

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:9

Returns

| DataRendererRuntime | undefined


setDataRendererRuntimeContext()

function setDataRendererRuntimeContext(runtime): void;

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

Parameters

Parameter Type
runtime DataRendererRuntime

Returns

void