SymbolStyle class final
A symbol style object.
A SymbolStyle is created either from a style file on disk (an SQLite database with a .stylx extension, created with ArcGIS Pro) or from a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style).
When used by itself, the symbol style supports two key workflows. One is to return a symbol based on a provided set of key values. Since each symbol in the style has a key that uniquely identifies it, you can pass an array of keys into SymbolStyle.getSymbol to return a new ArcGISSymbol built from the individual symbols represented by those keys. You might use this symbol to create a new Graphic.
The other common workflow is to use a standalone symbol style to search for symbol primitives. Symbol primitives are the individual symbols that compose more complex symbols. This is achieved using SymbolStyle.searchSymbols. You could create a symbol picker app, for example, that searches for all symbols in the style that have the tag "maritime" in it. The search results contain symbols that you could use directly. You could also extract their individual symbol components to create a new multilayer symbol.
- Implemented types
- Mixed-in types
- Implementers
Constructors
- SymbolStyle.withFileUri(Uri fileUri)
-
Creates a new Symbol style object.
factory
- SymbolStyle.withPortalItem(PortalItem portalItem)
-
Creates a new symbol style object from a portal item. The portal item must
contain a style.
factory
- SymbolStyle.withStyleName(String styleName, {Portal? portal})
-
Creates a new symbol style object using the registered style name of the
Esri web style on the portal.
factory
Properties
- fileUri → Uri
-
The location of the .stylx file on disk. This will be empty if the style
was hosted on a portal (also referred to as a web style).
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the LoadStatus.
no setterinherited
- portal → Portal?
-
The portal that hosts the web style identified with
SymbolStyle.styleName. This will be null if the style was identified
with a PortalItem or Uri or a local .stylx file on disk.
no setter
- portalItem → PortalItem?
-
The portal item representing the web style.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- styleName → String
-
The name of the web style. This will be empty if the style was identified
with a URL or a PortalItem or a local .stylx file on disk.
no setter
- uri → Uri?
-
The URL of the web style. This will be empty if the style was identified
with a PortalItem or style name or a local .stylx file on disk.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
getDefaultSearchParameters(
) → Future< SymbolStyleSearchParameters> - Returns a Symbol Style Search Parameters object providing all available search parameters from the database.
-
getSymbol(
List< String> keys) → Future<ArcGISSymbol> - Asynchronously returns a symbol based on the provided list of keys.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
searchSymbols(
SymbolStyleSearchParameters searchParameters) → Future< List< SymbolStyleSearchResult> > - Returns a collection of Symbol Style Search Result object.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
createWithUri(
Uri webStyleUri) → SymbolStyle - Creates a new symbol style object using web style item Url.