Occurs when initialization of this object fails.
Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.
Whether the Layer is currently visible or not.
Whether or not this layer should allow the end user to configure custom symbolization
An array of arcade expressions associated with this layer
Whether or not the layer supports toggling labels.
The catalog id
Array of charts associated with this layer
The layer's initial visibility, defined in the site. This will be true if the layer was configured to be visible by default, false otherwise.
The name of the underlying data provider for the layer, e.g. "SqlServer" or "Oracle".
The default format string used for formatting date values originating from this layer.
The default format string used for formatting numeric values originating from this layer.
A default renderer for this layer. Will override the esri default if set.
Whether or not the layer is visible by default in the service.
The description to use for the layer in client applications.
The field to use as the primary representative of the layer in reports.
The alias to use for the layer in client applications.
The layer's draw index that determines its drawing order (only applies to dynamic map services).
The dynamic definition of the Layer.
The extensions of the Layer, as defined by an administrator.
The border color used when highlighting a feature from this layer.
The width of the border for a feature from this layer.
The format for a description of a feature from this layer.
The fill color used when highlighting a feature from this layer, represented as an array of RGB values in the range of 0-255.
Array of feature hyperlinks associated with this layer
The format for a label of a feature.
The format for a long description of a feature.
Shape type of the layer. One of:
Zoom factor to use to expand the extent by when zooming to a feature. For example, if this value is set to 3, then the extent will be expanded by a factor of 3 when zooming to that feature. This property is not applicable to point layers since points do not have an extent to expand.
Scale to which the map should zoom when a standard viewer "zoom to feature" concept is invoked, from a list of results or otherwise. This value should be respected by implementing clients and viewers. If no value has been configured in the Essentials site for this, it will remain null.
Array of fields associated with this layer.
The full extent of the layer.
Whether the Layer has attachments associated with it.
URI to an icon representing this layer in the client application.
The ID of the Layer.
Whether or not this layer can be identified in the client application.
Whether or not this layer can be identified in the client application at scales it's not visible at.
An observable indicating whether this layer is participating in the currently configured layer theme or not
Whether or not to include this layer in the a layer list.
Whether or not to include this layer in the legend.
The exception that occurred if the object could not be initialized.
Whether the Layer is dynamic.
Whether or not the layer will be expanded by default when shown in a layer list. Only applies to group layers.
Whether or not the object was successfully initialized.
Indicates whether or not a layer was created by a user at runtime
An array of hyperlinks associated with this layer.
A collection containing the layer theme settings for this layer.
The URL of the image for the layer legend.
The map service that the Layer belongs to.
The layer's maximum scale.
The layer's minimum scale.
The name of the Layer.
Gets the ID of the parent Layer.
Field to use as the layer's primary key.
The properties of the Layer, as defined by the administrator on the server.
A list of administrator defined queries that can be used with the Query Builder or Filter Builder
A flag indicating whether the layer is queryable or not.
Array of relationships associated with this layer.
Indicates if the layer is searchable.
The display preference for feature hyperlinks. One of:
Whether this layer should show its labels.
Whether the client application is to show map tips for this layer.
The {@link geocortex.essentials.Site} that this resource belongs to.
Whether the layer can be snapped.
Whether the layer is enabled for snapping by default.
The style name, for WMS requests.
A list of predefined renderers that can be applied to this layer
Indicates whether or not this layer supports the Identify task/endpoint. This is not the same as identifiable which is affected by user preference.
Indicates whether or not this layer supports the Query task/endpoint. This is not the same as queryable which is affected by user preference.
The IANA ID of the time zone in which the data in this layer's fields are current.
The type of the layer, such as feature layer, raster layer, group layer, etc. Represented as a numerical value, defined by LayerType.
The URL that this resource was initialized from.
The type of user created layer. One of:
Only applies to layers created at runtime.
A flag used when changing map services and preserving user visibility settings.
The name of the WFS layer. This is the actual layer name from the capabilities, unlike the name property of this Layer which is actually the title in the capabilities.
The name of the WMS layer. This is the actual layer name from the capabilities, unlike the name property of this Layer which is actually the title in the capabilities.
Not pretty but we are working around a deficiency in Essentials here
Accessor method for the LayerVisibilityEventManager class in MapService.ts to sync layer visibility with programmatic layer visibility changed made using esri's setLayerVisibility method.
Gets a value representing whether or not all of this layer's ancestors are currently visible in the map.
Populates the Layer from a dynamic object which represents a layer.
An object which represents the Layer.
Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.
The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.
The callback function to execute when this instance has been initialized.
Find the Report matching the specified report ID.
The Id of the Report to find.
Returns a string representing the layers definition expression. Uses a service layer if passed in to find the most up to date definition expression. If no service layer, get the definition expression for the layers dynamic definition json. A service layer would be useless here if you were initializing these layers for the first time. (ie. it is not added yet.)
Service layer.
The definition expression.
Gets the feature layer associated with this layer. Not supported for all layers types, in which case the value will be null.
Given a field name, returns the field object by that name.
of the field to return
Gets the layers drawing options from the dynamicDefinition.
The LayerDrawingOptions for the layer or null.
Retrieves the layer theme settings for this layer by specified layer theme or layer theme id
Retrieve the layer time info if available. This method needs to be called after the service layers have loaded.
Gets the URL to the actual Esri layer (or Essentials endpoint if appropriate).
Determine what the Esri OBJECTID field name is for the feature in the layer.
Returns a Feature Layer for a given relationship ID.
The id of the relationship.
A callback to invoke upon success.
A callback to invoke if an error is encountered.
Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.
Returns whether or not the layer is currently visible in the map.
Sets the inActiveTheme property of the Layer. Raises the "LayerInActiveThemeChangedEvent" event.
The value to set.
Sets the visibility of the Layer. If the Layer is part of a tiled (or image) service, then the whole MapService visibility is set.
Exports the state of the layer as a JSON object. This can be used to recreate the layer again via createFromDefinition().
Determines if the specified scale is within this layer's min and max scale. If a value is not provided for this parameter, then the map's current scale value will be used.
The scale value to test if it is between this layer's min and max scale.
Represents a layer configured in a MapService. A Geocortex layer should not be confused with an ArcGISDynamicMapServiceLayer or an ArcGISTiledMapServiceLayer. It is more akin to the esri.layers.LayerInfo class. The layer provides additional configuration beyond what is defined in an ArcGIS server map service sub layer. For example, the layer might have reports and datalinks defined. Also, the layer's configuration overrides the default visibility of the layer. In order for sub-layers to appear on the map, they must be explicitly defined in the layer collection of the MapService.