# Class: FlowCoreParameter

Core functionality for Flo.w map parameters. This class is wrapped by the <flow-map-parameter> web component.

Map parameters are used to specify additional options for FlowCoreMapDataSource and FlowCoreMapDataJoin instances.

# Hierarchy

  • FlowCoreParameter

# Constructors

# constructor

+ new FlowCoreParameter(name: string, flowMap: FlowCoreMap, required?: boolean): FlowCoreParameter

Constructs a new FlowCoreParameter instance.

# Parameters:

Name Type Default value Description
name string - Parameter name.
flowMap FlowCoreMap - Parent Flo.w map.
required boolean false Parameter is required.

Returns: FlowCoreParameter

# Properties

# flowMap

Readonly flowMap: FlowCoreMap

Parent Flo.w map.


# name

Readonly name: string

Parameter name.


# required

Readonly required: boolean

Parameter is required.

# Accessors

# parameterDef

• get parameterDef(): ParameterDef

Return the parameter definition.

Parameters whose value is defined by a Flo.w reactive expression are evaluated and expanded.

Reactive

Returns: ParameterDef

# Methods

# setValue

setValue(value: string): void

Set the parameter value.

Values are specified using Flo.w reactive expressions.

# Parameters:

Name Type Description
value string Parameter value.

Returns: void