- All Implemented Interfaces:
RemoteResource
,Loadable
- Direct Known Subclasses:
DictionarySymbolStyle
SymbolStyle
is created either from a style file on disk (a 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 getSymbolAsync(List)
to return a new Symbol
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
searchSymbolsAsync(SymbolStyleSearchParameters)
. 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.
- Since:
- 100.0.0
- See Also:
-
Property Summary
TypePropertyDescriptionThe load error.The load status. -
Constructor Summary
ConstructorDescriptionSymbolStyle
(PortalItem portalItem) Creates a new symbol style object from a portal item.SymbolStyle
(String stylePath) Creates a new symbol style instance from a *.stylx file located at the given path.SymbolStyle
(String styleName, Portal portal) Creates a new symbol style object using the registered style name of the Esri web style on the portal. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable listener) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.static SymbolStyle
createSymbolStyleFromUrl
(String webStyleUrl) Creates a new symbol style object using a web style item's URL.Gets theCredential
that is set on the network-enabled resource.Gets aSymbolStyleSearchParameters
object providing all available search parameters from the database.Gets the value of theloadError
property.Gets the value of theloadStatus
property.Gets the portal that hosts the web style identified withSymbolStyle.getStyleName()
.Gets the portal item representing the web style.Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.Gets the location of the .stylx file on disk.Gets the name of the web style.getSymbolAsync
(List<String> keys) Finds a Symbol, as defined by the input keys.getUri()
The URI of the web style.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable listener) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.searchSymbolsAsync
(SymbolStyleSearchParameters styleSymbolSearchParameters) Searches for symbol primitives using searchParameters.void
setCredential
(Credential credential) Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge.void
setRequestConfiguration
(RequestConfiguration requestConfiguration) Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.
-
Property Details
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
-
Constructor Details
-
SymbolStyle
Creates a new symbol style instance from a *.stylx file located at the given path. This constructor is intended for use with mobile style files. To use a dictionary style file (e.g. for military symbols) useDictionarySymbolStyle
instead.- Parameters:
stylePath
- the full path to a *.stylx file- Since:
- 100.5.0
-
SymbolStyle
Creates a new symbol style object using the registered style name of the Esri web style on the portal.Esri provides a set of web symbol styles "out of the box" for localized with ArcGIS Online and Enterprise. You can use this constructor only if you are creating a symbol style using the Esri web style's unique name on your portal or arcgis.com. If null is passed, ArcGIS online is used as the default portal. An overview of styles and symbols currently in production is available for 3D and 2D. (Tip: Click on a symbol icon to find its associated style name.)
Esri registered style names can also be found in the json of a symbol web style. See this example of json for the EsriThematicShapesStyle portal item hosted on ArcGIS Online.
- Parameters:
styleName
- the registered Esri symbol style name. ThestyleName
cannot be a custom web style name.portal
- a Portal hosting the Esri web style. If null is passed, ArcGIS online is used as the default portal.- Throws:
IllegalArgumentException
- if styleName is null or empty- Since:
- 100.10.0
-
SymbolStyle
Creates a new symbol style object from a portal item. The portal item must contain a style.If you have the item ID of a style file, you can search the portal to find the item using its item ID. Use this constructor if you have a reference to a portal item.
- Parameters:
portalItem
- a PortalItem that contains a web style- Throws:
IllegalArgumentException
- if portalItem is null- Since:
- 100.10.0
-
-
Method Details
-
createSymbolStyleFromUrl
Creates a new symbol style object using a web style item's URL.A symbol style using style item's URL.
For examplehttps://www.arcgis.com/home/item.html?id=bf27400d167d4c2e8e12c8a46f87afe4
is the URL of the "Basic Shapes" style on ArcGIS Online.- Parameters:
webStyleUrl
- the URL of the web style item- Throws:
IllegalArgumentException
- if webStyleUrl is null or empty- Since:
- 100.10.0
-
getPortal
Gets the portal that hosts the web style identified withSymbolStyle.getStyleName()
.- Returns:
- the portal that hosts the web style identified with
SymbolStyle.getStyleName()
. This will be null if the style was identified with a PortalItem or Uri or a local .stylx file on disk. - Since:
- 100.10.0
-
getPortalItem
Gets the portal item representing the web style.- Returns:
- The PortalItem will be set when SymbolStyle is created using
SymbolStyle(com.esri.arcgisruntime.portal.PortalItem)
orcreateSymbolStyleFromUrl(String)
. This will be null if the style was created usingSymbolStyle(java.lang.String,com.esri.arcgisruntime.portal.Portal)
or is identified with a local .stylx file on disk. - Since:
- 100.10.0
-
getStyleLocation
Gets the location of the .stylx file on disk.- Returns:
- 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).
- Since:
- 100.10.0
-
getStyleName
Gets the name of the web style.- Returns:
- 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.
- Since:
- 100.10.0
-
getSymbolAsync
Finds a Symbol, as defined by the input keys.Obtains a single, multilayer symbol using a list of one or more keys and provides a convenient way to create symbols and graphics on-the-fly. Each symbol in a mobile style file (.stylx) has a unique key. If you need one symbol from the file, you can provide a list with just the single key. If you want to combine several symbols from the file into one multilayer symbol, however, you can provide a list with all keys for symbols to be combined.
For example, assume XYZ style has a symbol with key "abc" which is the central symbol and another symbol with key "pqr", which could be the modifier/echelon placed at some offset from the central geometry. If you provide these two keys as attributes, then the symbol style will find and assemble a symbol accordingly. Once you have that symbol, you can apply it to a
Graphic
orRenderer
, obtain its swatch image, or serialize it to JSON.If the mobile style is not loaded, making this call will start the load cycle.
- Parameters:
keys
- symbol keys. It is the list of keys required to obtain a symbol from the style.- Returns:
- a Future that represents a symbol based on keys
- Throws:
IllegalArgumentException
- if keys is null- Since:
- 100.0.0
-
searchSymbolsAsync
public ListenableFuture<List<SymbolStyleSearchResult>> searchSymbolsAsync(SymbolStyleSearchParameters styleSymbolSearchParameters) Searches for symbol primitives using searchParameters.This asynchronous task searches for symbol primitives in the symbol dictionary. The input searchParameters define what is searched for. For example, you could search for all symbols that have the tag "airspace". You can also set the match to be strict or not, which will determine if the search uses "=" or "LIKE" for each parameter.
- Parameters:
styleSymbolSearchParameters
- search parameters for the symbol style- Returns:
- a list of the
SymbolStyleSearchResult
objects that match the search parameters - Throws:
IllegalArgumentException
- if styleSymbolSearchParameters is null- Since:
- 100.0.0
-
getDefaultSearchParametersAsync
Gets aSymbolStyleSearchParameters
object providing all available search parameters from the database.These default parameters are configured to retrieve all the valid input search parameters for a style. A task run with these will get all of the possible input values for categories, keys, names, symbol classes, and tags. This is an expensive task that should be used sparingly.
- Returns:
- a listenable future containing the resulting search parameters
- Since:
- 100.0.0
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadStatus
property - See Also:
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
loadAsync
public void loadAsync()Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
. -
retryLoadAsync
public void retryLoadAsync()Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
cancelLoad
public void cancelLoad()Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
addDoneLoadingListener
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, add a listener to the
Loadable.loadStatusProperty()
instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
getCredential
Description copied from interface:RemoteResource
Gets theCredential
that is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the Credential, or null if there is none
-
setCredential
Description copied from interface:RemoteResource
Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.Only applicable if the resource is secured.
- Specified by:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the Credential to be used for authentication
-
getRequestConfiguration
Description copied from interface:RemoteResource
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the
RequestConfiguration
used to modify network requests
-
setRequestConfiguration
Description copied from interface:RemoteResource
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
. If not set, the globalRequestConfiguration
will be used (seeRequestConfiguration.getGlobalRequestConfiguration()
).- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- the RequestConfiguration used to modify network requests
-
getUri
The URI of the web style.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI 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.
- Since:
- 100.10.0
-