Flo.w

# Class: FlowCoreDataJoin

Core functionality for Flo.w map data joins. Wrapped by the <flow-map-data-join> web component.

# Hierarchy

  • FlowCoreDataJoin

# Constructors

# constructor

+ new FlowCoreDataJoin(options: FlowCoreMapDataJoinOptions): FlowCoreDataJoin

Constructs a new FlowCoreDataJoin instance.

# Parameters:

Name Type Description
options FlowCoreMapDataJoinOptions Map data join options.

Returns: FlowCoreDataJoin

# Properties

# id

• id: string

Map data join ID.

# Accessors

# dataSrc

• get dataSrc(): string | any[] | null

Return the data source for the map data join.

If src is a Flo.w reactive expression, the expression will be expanded to return an array of data objects.

Reactive

Returns: string | any[] | null

array of data, dataset ID or external URL.

# parameters

• get parameters(): ParameterDef[]

Return the parameters associated with the map data join.

Reactive

Returns: ParameterDef[]

# src

• get src(): string | any[]

Get the src property.

  • array of data objects.
  • Flo.w reactive expression.
  • dataset ID.
  • external URL.

Returns: string | any[]

• set src(src: string | any[]): void

Set the src property. One of

  • array of data objects.
  • Flo.w reactive expression.
  • dataset ID.
  • external URL.

# Parameters:

Name Type
src string | any[]

Returns: void

# Methods

# setParameters

▸ setParameters(parameters: FlowCoreParameter[]): void

Set parameters associated with this data join.

Called internally by the flow-map-data-join web component. If set programmatically, it will be overwritten by the flow-map-data-join web component.

# Parameters:

Name Type Description
parameters FlowCoreParameter[] Data join parameters.

Returns: void

# start

▸ start(): void

Start the reactive map data join.

Returns: void

# stop

▸ stop(): void

Stop the reactive map data join.

Returns: void

# Object literals

# defaultOptions

▪ Static defaultOptions: object

# Properties:

Name Type Value
foreignKey string "id"

← FlowCoreDataSource →