Appearance

@graphty/graphty-element / index / SourceParamDescriptor

Interface: SourceParamDescriptor ​

Defined in: graph-io/dist/src/sources/types.d.ts:259

One parameter a form asks for. Experimental.

Properties ​

advanced? ​

readonly optional advanced?: boolean

Defined in: graph-io/dist/src/sources/types.d.ts:284

Whether a form may hide it by default.

default? ​

readonly optional default?: unknown

Defined in: graph-io/dist/src/sources/types.d.ts:269

The value used when it is not given.

description? ​

readonly optional description?: string

Defined in: graph-io/dist/src/sources/types.d.ts:288

What it means; catalog data.

language? ​

readonly optional language?: QueryLanguage

Defined in: graph-io/dist/src/sources/types.d.ts:282

The language of a "query".

max? ​

readonly optional max?: number

Defined in: graph-io/dist/src/sources/types.d.ts:273

The largest number allowed.

min? ​

readonly optional min?: number

Defined in: graph-io/dist/src/sources/types.d.ts:271

The smallest number allowed.

name ​

readonly name: string

Defined in: graph-io/dist/src/sources/types.d.ts:261

The key in the params object.

plainName ​

readonly plainName: string

Defined in: graph-io/dist/src/sources/types.d.ts:263

Its default name; catalog data an application may replace.

required? ​

readonly optional required?: boolean

Defined in: graph-io/dist/src/sources/types.d.ts:267

Whether it must be given.

role? ​

readonly optional role?: "filter"

Defined in: graph-io/dist/src/sources/types.d.ts:286

"filter": compiled into the query, so filtering happens at the source.

type ​

readonly type: SourceParamType

Defined in: graph-io/dist/src/sources/types.d.ts:265

Its type.

values? ​

readonly optional values?: readonly object[]

Defined in: graph-io/dist/src/sources/types.d.ts:275

The allowed values of an "enum".