Class StepExpr

A node representing a step expression.

internal

Hierarchy

Expr
- StepExpr

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StepExpr(input: Expr, defaultValue: Expr, stops: Array<[]>): StepExpr

- Defined in @here/harp-datasource-protocol/lib/Expr.ts:743
Parameters
- input: Expr
- defaultValue: Expr
- stops: Array<[]>
Returns StepExpr

Properties

Readonly defaultValue

defaultValue: Expr

Readonly input

input: Expr

Readonly stops

stops: Array<[]>

Methods

accept

accept<Result, Context>(visitor: ExprVisitor<Result, Context>, context: Context): Result

Overrides Expr.accept
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:753
override

Type parameters
- Result
- Context
Parameters
- visitor: ExprVisitor<Result, Context>
- context: Context
Returns Result

dependencies

dependencies(): ExprDependencies

Inherited from Expr.dependencies
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:327
Gets the dependencies of this Expr.

Returns ExprDependencies

evaluate

evaluate(env: Env, scope?: ExprScope, cache?: Map<Expr, Value>): Value | never

Inherited from Expr.evaluate
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:301
Evaluate an expression returning a Value object.

Parameters
- env: Env
  
  The Env used to lookup symbols.
- Default value scope: ExprScope = ExprScope.Value
  
  The evaluation scope. Defaults to ExprScope.Value.
- Optional cache: Map<Expr, Value>
  
  A cache of previously computed results.
Returns Value | never

Protected exprIsDynamic

exprIsDynamic(): boolean

Overrides Expr.exprIsDynamic
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:758
override

Returns boolean

instantiate

instantiate(context: InstantiationContext): Expr

Inherited from Expr.instantiate
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:320
Instantiates this Expr.

remarks

references to the get and has operator using the given instantiation context.

Parameters
- context: InstantiationContext
  
  The [[InstantationContext]] used to resolve names.
Returns Expr

intern

intern(pool: ExprPool): Expr

Inherited from Expr.intern
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:340
Create a unique object that is structurally equivalent to this Expr.

Parameters
- pool: ExprPool
  
  The [[ExprPool]] used to create a unique equivalent object of this Expr.
Returns Expr

isDynamic

isDynamic(): boolean

Inherited from Expr.isDynamic
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:351
Returns true if a dynamic execution context is required to evaluate this Expr.

Returns boolean

toJSON

toJSON(): JsonValue

Inherited from Expr.toJSON
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:344
Returns JsonValue

Static fromJSON

fromJSON(json: JsonValue, definitions?: Definitions, definitionExprCache?: Map<string, Expr>): Expr

Inherited from Expr.fromJSON
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:274
Creates a style expression from JSON.
remarks

The optional set of definitions is used to resolve the ref expressions.

example
```
const expr = Expr.fromJSON(["all",
    ["==", ["geometry-type"], "LineString"],
    ["has", "text"]
]);
```
Parameters
- json: JsonValue
  
  JSON object representing the expression to parse.
- Optional definitions: Definitions
  
  Optional set of definitions used to expand references.
- Optional definitionExprCache: Map<string, Expr>
  
  Optional cache of Expr instances
Returns Expr

Static isExpr

isExpr(value: any): value is Expr

Inherited from Expr.isExpr
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:238
Tests of given value is an Expr.

Parameters
- value: any
  
  The object to test.
Returns value is Expr

Static parse

parse(code: string): Expr | never

Inherited from Expr.parse
- Defined in @here/harp-datasource-protocol/lib/Expr.ts:249
Creates an expression from the given code.

deprecated

string encoded expression are deprecated. Use Expr.fromJSON instead.

Parameters
- code: string
  
  The code to parse.
Returns Expr | never

The parsed Expr.

Generated using TypeDoc