AbstractStatic ReadonlyALLOWED_Static ReadonlyDEFAULT_The default filter expression when no features should be included
Static ReadonlyDEFAULT_The default filter expression when all features should be included
StaticFillTable used to define line symbology to use when drawing polygon fill
Static ReadonlyLEGEND_Default value of the legend canvas height when the settings do not provide one.
Static ReadonlyLEGEND_Default value of the legend canvas width when the settings do not provide one.
StaticlineTable used to define line symbology to use when drawing lineString and polygon perimeters
StaticprocessTable of function to process the style settings based on the feature geometry and the kind of style settings.
StaticanalyzeAnalyse the filter and split it in syntactic nodes.
Node array to analyse
The new node array with all nodes classified
Staticbase64Decodes a base64-encoded SVG string and replaces parameterized placeholders.
Placeholders like param(fill) or param(outline) are replaced with actual values
provided as query parameters appended to the base64 string.
This is particularly useful for decoding and normalizing SVG symbols
exported from QGIS, which may include dynamic styling parameters such as
fill, stroke, or outline values.
The method also applies various cleanup steps to improve SVG compatibility:
"stroke=" issues)<title>, <desc>, <defs> tagsThe base64-encoded SVG string, optionally including
query parameters (e.g. "base64:...?...fill=%23ff0000&outline=%23000000")
The decoded, cleaned, and parameter-substituted SVG XML string
StaticclassifyClassify the remaining nodes to complete the classification.
The plus and minus can be a unary or a binary operator. It is only at the end that we can determine their node type. Nodes that start with a number are numbers, otherwise they are variables. If a problem is detected, an error object is thrown with an explanatory message.
Array of keywords to process
The new keywords array with all nodes classified
StaticcreateCreate a default style to use with a vector feature that has no style configuration.
Type of geometry (Point, LineString, Polygon)
Label for the style
The Style configuration created, or undefined if unable to create it
StaticcreateCreates a filter equation from a filter string.
The filter string to convert
The filter equation as an array of FilterNodeType
StaticcreateCreates a canvas with the GeometryCollection settings defined in the style.
OptionalgeometryCollectionStyle: StyleOptional style associated to the GeometryCollection
The created canvas
StaticcreateCreates a canvas with the image of an icon that is defined in the point style.
OptionalpointStyle: StyleOptional style associated to the point symbol
A promise that resolves with the created canvas, or null if creation fails
StaticcreateCreates a canvas with the lineString settings that are defined in the style.
OptionallineStringStyle: StyleOptional style associated to the lineString
The created canvas
StaticcreateCreates a canvas with the vector point settings that are defined in the point style.
OptionalpointStyle: StyleOptional style associated to the point symbol
The created canvas
StaticcreateCreates a canvas with the polygon settings that are defined in the style.
OptionalpolygonStyle: StyleOptional style associated to the polygon
The created canvas
StaticcreateCreate the stroke options using the specified settings.
Settings to use for the stroke options creation
The stroke options created
StaticevaluateEvaluate an Arcade expression using feature data.
Supports field references, conditional logic (if/else, ternary), comparison operators, logical operators, and basic string functions (upper, lower).
Arcade expression string (e.g., "if($feature.STATUS == 'Active') return 'A' else return 'B'")
Feature containing field data
The evaluated result (string, number, or boolean) or null if evaluation fails
StaticevaluateEvaluate a simple value expression using feature data.
Supports basic arithmetic operations and field references.
Expression string (e.g., "$feature["FIELD_NAME"] + 90")
Feature containing field data
The evaluated result or null if evaluation fails
StaticexecuteExecute an operator using the nodes on the data stack.
The filter equation is evaluated using a postfix notation. The result is pushed back on the data stack. If a problem is detected, an error object is thrown with an explanatory message.
Operator to execute
Data stack to use for the operator execution
StaticextractExtract the specified keyword and associate a node type to their nodes.
In some cases, the extraction uses an optional regular expression.
Array of keywords to process
Keyword to extract
OptionalregExp: RegExpOptional regular expression to use for the extraction
The new keywords array
StaticextractExtract the string nodes from the keyword array.
This operation is done at the beginning of the classification. This allows to consider keywords in a string as a normal word. If a problem is detected, an error object is thrown with an explanatory message.
Array of keywords to process
The new keywords array with all string nodes classified
StaticfeatureEvaluates whether a feature satisfies a parsed filter equation.
The filter equation is expected to be in infix order and is evaluated using a stack-based (shunting-yard–style) algorithm that respects operator precedence and grouping.
The feature whose attributes are used to resolve variable nodes
OptionalfilterEquation: FilterNodeType[]Optional parsed filter expression tokens
True if the feature satisfies the filter, false otherwise
StaticgetGets the style of the feature using the layer entry config.
If the style does not exist for the geometryType, create it using the default style strategy.
Feature that need its style to be defined
The style to use
The style label when one has to be created
OptionalfilterEquation: FilterNodeType[]Optional filter equation associated to the layer
OptionalcallbackWhenCreatingStyle: (Optional callback to execute when a new style had to be created
The style applied to the feature, or undefined if not found
StaticgetGet the default color using the default color index.
Alpha value to associate to the color
Optional true, if we want to skip to next color
The current default color string
StaticgetGets the image source from the style of the feature using the layer entry config.
The style to use
The type of geometry
The layer style settings
The icon source associated to the feature, or undefined
StaticgetBuilds a filter string (SQL-like or OGC-compliant) for a given layer and style configuration.
This method supports:
(1=1) condition.The outfields information
The style configuration (optional)
The layer style settings
The filter expression, or undefined if not applicable
StaticgetGets the legend styles used by the layer as specified by the style configuration.
The style configuration
A promise that resolves with the layer styles
StaticinterpolateInterpolate a color between two hex colors.
The data value to interpolate for
The lower data value
The upper data value
The hex color at the lower value
The hex color at the upper value
The interpolated color in rgba format
StaticinterpolateInterpolate a value between two stops linearly.
The data value to interpolate for
The lower data value
The upper data value
The output at the lower value
The output at the upper value
The interpolated output value
StaticloadLoads the image of an icon that compose the legend.
Source information (base64 image) of the image to load
A promise that resolves with the loaded image, or null if loading fails
StaticprocessProcesses the array of point styles as described in the pointStyleConfig.
Object that will receive the created canvas
Array of point style configuration
A promise that resolves with the vector layer style
StaticprocessProcess a backward diagonal fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a circle symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess the class break settings using a lineString feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess the class break settings using a Point feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess the class break settings using a Polygon feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess a cross fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a diagonal cross fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a Diamond symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess a dot fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a forward diagonal fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a horizontal fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess an icon symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess a null fill (polygon with fill opacity = 0) using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a pattern fill using the settings.
Settings to use for the Style creation
Fill pattern lines needed to create the fill
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a + symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess a regular shape using the settings, the number of points, the angle and the scale.
Settings to use for the Style creation
Number of points needed to create the symbol
Angle to use for the symbol creation
Scale to use for the symbol creation
The Style created, or undefined if unable to create it
StaticprocessProcess a simple lineString using the settings.
Settings to use for the Style creation
Optionalfeature: Feature<Geometry>Optional feature. This method does not use it, it is there to have a homogeneous signature
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess a simple point symbol using the settings.
Simple point symbol may be an icon or a vector symbol.
Settings to use for the Style creation
Optionalfeature: Feature<Geometry>Optional feature. This method does not use it, it is there to have a homogeneous signature
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess a simple polygon using the settings.
Settings to use for the Style creation
Optionalfeature: Feature<Geometry>Optional feature. This method does not use it, it is there to have a homogeneous signature
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess a simple solid fill (polygon) using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a square symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess a star shape symbol using the settings.
Settings to use for the Style creation
Number of points needed to create the symbol
Angle to use for the symbol creation
The Style created, or undefined if unable to create it
StaticprocessProcess a star symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess a triangle symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticprocessProcess the unique value settings using a lineString feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess the unique value settings using a polygon feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess the unique value settings using a point feature to get its Style.
Style settings to use
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
Optionaloptions: TypeStyleProcessorOptionsOptional processing options
The Style created, or undefined if unable to create it
StaticprocessProcess a vertical fill using the settings.
Settings to use for the Style creation
Optionalgeometry: GeometryOptional geometry to associate with the style
The Style created, or undefined if unable to create it
StaticprocessProcess a X symbol using the settings.
Settings to use for the Style creation
The Style created, or undefined if unable to create it
StaticreadReturns the type of geometry.
It removes the Multi prefix because for the geoviewRenderer, a MultiPoint has the same behaviour than a Point.
The geometry type to check
The type of geometry (Point, LineString, Polygon)
StaticreadReturns the type of geometry.
It removes the Multi prefix because for the geoviewRenderer, a MultiPoint has the same behaviour than a Point.
The feature to check
The default layer style config to use when the feature has no geometry
The type of geometry (Point, LineString, Polygon)
StaticsearchSearch the class break entry using the field value stored in the feature.
Optional field involved in the class break definition
Class break configuration
Feature used to test the class break conditions
OptionalaliasLookup: TypeAliasLookupOptional lookup table to handle field name aliases
OptionalvalueExpression: stringOptional Arcade expression to evaluate instead of using field
The matching entry, or undefined if unable to find it
StaticsearchCheck whether a numeric value falls within a class-break interval using provided boundary conditions.
The conditions parameter is expected to be a two-element array where:
The numeric value to test
The lower bound of the interval
The upper bound of the interval
Two-element array describing the boundary operators
True if the value satisfies the interval according to the conditions, false otherwise
StaticsearchSearch the unique value entry using the field values stored in the feature.
Fields involved in the unique value definition
Unique value configuration
Optionalfeature: Feature<Geometry>Optional feature used to test the unique value conditions
OptionaldomainsLookup: TypeLayerMetadataFields[]Optional lookup table to handle coded value domains
OptionalaliasLookup: TypeAliasLookupOptional lookup table to handle field name aliases
OptionalvalueExpression: stringOptional Arcade expression to evaluate instead of using fields
The Style created, or undefined if unable to create it
StaticSVGEncodes an SVG XML string into a base64-encoded string.
This is the inverse of base64ToSVGString, allowing you to safely embed or transmit SVG data in formats where raw XML is not permitted.
The raw SVG XML string to encode
A base64-encoded representation of the SVG string
Arcade keywords and functions allowed in expression evaluation