# flow-rdf
# Index
# Classes
- ChartSpecRegistry
- ContextRegistry
- Debugger
- FlowCoreChart
- FlowCoreChartData
- FlowCoreChartSignal
- FlowCoreContext
- FlowCoreDataJoin
- FlowCoreDataSource
- FlowCoreMap
- FlowCoreMapLayer
- FlowCoreMapPopup
- FlowCoreParameter
- FlowQuery
- ImageLoader
- ImageRegistry
- MapRegistry
- Palette
- PaletteRegistry
- StateStore
# Interfaces
- ContextConfiguration
- FeatureStateProperties
- FlowComputed
- FlowCoreChartDataOptions
- FlowCoreChartOptions
- FlowCoreChartSignalOptions
- FlowCoreMapDataJoinOptions
- FlowCoreMapDataSourceOptions
- FlowCoreMapLayerOptions
- FlowCoreMapOptions
- FlowCoreMapPopupOptions
- FlowMapExportOptions
- FlowQueryDefinition
- FlowQueryExtraParams
- FlowQuerySampleOptions
- FlowQueryWhereClauses
- MapLayerStyleProperties
- ParameterDef
- QueryParams
- ReactiveOptions
# Type aliases
- AsyncComputeFn
- ChartSpec
- ComputeFn
- DeserializeFn
- DrawOverlayCallback
- DrawOverlayFn
- ExtractQueryResultType
- FlowQueryAttribute
- FlowQueryDefinitionFn
- FlowQueryOrderClause
- FlowQueryResultFormat
- FlowQueryResultTransformFn
- SelectionPopupFn
- SerializeFn
# Variables
# Functions
# Type aliases
# AsyncComputeFn
Ƭ AsyncComputeFn<TState, TResult>: (state: DeepReadonly<TState>) => TResult | PromiseLike<TResult>
Compute function for asynchronous computed properties.
# Type parameters:
| Name | Default | Description |
|---|---|---|
TState | any | Type of application state. |
TResult | any | Type of asynchronous computed property. |
# ChartSpec
Ƭ ChartSpec: object
Vega/Vega-lite chart specification.
# ComputeFn
Ƭ ComputeFn<TState, TResult>: (state: DeepReadonly<TState>) => TResult
Compute function for computed properties.
# Type parameters:
| Name | Default | Description |
|---|---|---|
TState | any | Type of application state. |
TResult | any | Type of computed property. |
# DeserializeFn
Ƭ DeserializeFn<T>: (queryParams: QueryParams) => DeepPartial<T>
Application state deserialization function.
# Type parameters:
| Name | Description |
|---|---|
T | Type of application state. |
# DrawOverlayCallback
Ƭ DrawOverlayCallback: (error: Error) => void
Callback function to indicate map export overlay drawing has finished.
# DrawOverlayFn
Ƭ DrawOverlayFn: (ctx: CanvasRenderingContext2D, width: number, height: number, dpmm: number, callback: DrawOverlayCallback) => void
Function to draw an overlay on an exported map.
# ExtractQueryResultType
Ƭ ExtractQueryResultType<T>: T extends FlowQuery<infer TResults, any> ? TResults : never
# Type parameters:
| Name |
|---|
T |
# FlowQueryAttribute
Ƭ FlowQueryAttribute: string | [any, string]
FlowQueryDefinition 'attributes' entry.
# FlowQueryDefinitionFn
Ƭ FlowQueryDefinitionFn<TState>: (state: DeepReadonly<TState>) => FlowQueryDefinition | Promise<FlowQueryDefinition> | null
FlowQuery query definition function.
# Type parameters:
| Name | Description |
|---|---|
TState | Type of application state. |
# FlowQueryOrderClause
Ƭ FlowQueryOrderClause: string | number | [string | number, "asc" | "desc"]
FlowQueryDefinition 'order' clause.
A field name or [field, asc/desc] tuple.
# FlowQueryResultFormat
Ƭ FlowQueryResultFormat: "json" | "geojson" | "csv"
Result format of a FlowQuery.
# FlowQueryResultTransformFn
Ƭ FlowQueryResultTransformFn<T>: (results: any) => T
FlowQuery result transform function.
# Type parameters:
| Name | Default | Description |
|---|---|---|
T | any | Type of transformed query results. |
# SelectionPopupFn
Ƭ SelectionPopupFn: (feature: maplibregl.MapboxGeoJSONFeature) => FlowCoreMapPopupOptions | string
User-provided function to provide a popup definition for display when a feature is selected.
# SerializeFn
Ƭ SerializeFn<T>: (state: DeepReadonly<T>) => QueryParams
Application state serialization function.
# Type parameters:
| Name | Description |
|---|---|
T | Type of application state. |
# Variables
# flow
• Const flow: ContextRegistry = globalContextRegistry
A global instance of [ContextRegistry].
This should be client code as the entry point to the Flo.w RDF JavaScript API.
# Functions
# installGlobalDebugger
▸ installGlobalDebugger(dbg: Debugger): void
Install the specified Debugger instance as window.FDBG.
# Parameters:
| Name | Type | Description |
|---|---|---|
dbg | Debugger | Debugger instance |
Returns: void