Constructors
-
new KnowledgeGraphLayer(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
Extent | The full extent of the layer. more details | Layer | |
String | The unique ID assigned to the layer. more details | Layer | |
InclusionModeDefinition | Defines a set of named types and/or entities and relationships to be included in the layer. more details | KnowledgeGraphLayer | |
KnowledgeGraph | The data model, service definition and url of the knowledge graph service that contains the data for the KnowledgeGraphLayer. more details | KnowledgeGraphLayer | |
Collection<KnowledgeGraphSublayer> | A collection of operational KnowledgeGraphSublayer. more details | KnowledgeGraphLayer | |
String | Indicates how the layer should display in the LayerList widget. more details | Layer | |
Boolean | Indicates whether the layer's resources have loaded. more details | Layer | |
Error | The Error object returned if an error occurred while loading. more details | Layer | |
String | Represents the status of a load operation. more details | Layer | |
Object[] | A list of warnings which occurred while loading. more details | Layer | |
EntityType[] | The entity types included in the KnowledgeGraphLayer. more details | KnowledgeGraphLayer | |
RelationshipType[] | The relationship types included in the KnowledgeGraphLayer. more details | KnowledgeGraphLayer | |
Number | The opacity of the layer. more details | Layer | |
Map|Basemap|Ground|GroupLayer | The parent to which the layer belongs. more details | Layer | |
Collection<KnowledgeGraphSublayer> | All non-spatial entity type and relationship type sublayers. more details | KnowledgeGraphLayer | |
String | An optional title for the KnowledgeGraphLayer. more details | KnowledgeGraphLayer | |
String | The layer type. more details | KnowledgeGraphLayer | |
String | The url of the knowledge graph service. more details | KnowledgeGraphLayer | |
Boolean | Indicates if the layer is visible in the View. more details | Layer |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.
Example// Once the layer loads, set the view's extent to the layer's fullextent layer.when(function(){ view.extent = layer.fullExtent; });
-
The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.
-
inclusionModeDefinition InclusionModeDefinition
-
Defines a set of named types and/or entities and relationships to be included in the layer. If only a named type is specified, all instances of that type will be included in the layer. Sublayers can be created for all named types in the graph even if they have no instances specified in the member definition. The inclusion definition is not permanently dynamic. It captures the data at the time of creation. For example, if
generateAllSublayers
istrue
and a new entity type is added to the knowledge graph, that new entity type will not be added to the inclusion list. Similarly, ifuseAllData
istrue
for a type, and a new record is added to that type, the newly added record will not be automatically added to the inclusionList.Examples// constructing an inclusion list: // The exact record ids of each of the records of a specific named type (entity type or relationship type) // to include in the layer. In this case the layer will contain one record const layerInclusionMemberDefinition = new Map(); layerInclusionMemberDefinition.set("{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}",{id:"{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}"}) //The layerInclusionDefinition specifies whether to use all of the data in a named type or only the records // specified in the 'members' list. In this case we only want the records specified. const layerInclusionDefinition = { useAllData: false, //only include instances in the member list members: layerInclusionMemberDefinition }; // The namedTypeDefinition is a map of the typeName of each type to be included. // In this case we are only including the "Observation" entity type. // The layerInclusionDefinition specifies exactly which "Observation" entities to include in the layer. const namedTypeDefinition = new Map(); namedTypeDefinition.set("Observation", layerInclusionDefinition); // Specify if a sublayer should be generated for all named types. // If true, a sublayer will be created for all named types regardless of // whether they have a list of instances to include or not. // If there are no instances the sublayer will be empty. In this case we have set 'generateAllSubLayers' to false so the // layer will only contain sublayers for the named types (entity types or relationship types) that are specified // in the namedTypeDefinitions. // Also defines the collection of named types to include in the layer. const inclusionListDefinition = { generateAllSublayers: false, //only create sublayers for the named types in the namedTypeDefintion namedTypeDefinitions: namedTypeDefinition }
//examples of the inclusionModeDefinition structure inside the KnowledgeGraphLayer //the layer will only contain one sublayer (for 'supplier') and that sublayer will consist of one entity. { generateAllSublayers: false, namedTypeDefinition:[{ key: "supplier", value:{ useAllData: false, members: [{ key: "{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}", value: { id: "{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}", } }] } }] } // this layer will contain a sublayer for all named types in the graph // ('Observation', 'User', 'Species', "Observed", "Reviewed", "ObservedIn") // but only the 'Observation' sublayer will contain data. // The Observation sublayer will contain exactly one entity. { generateAllSublayers: true, namedTypeDefinition:[{ key: "Observation", value:{ useAllData: false, members: [{ key: "{32CBD5CB-EE31-4714-B14F-57BFE36AE094}", value: { id: "{32CBD5CB-EE31-4714-B14F-57BFE36AE094}", } }] } }] } // this layer will contain a sublayer for all named types in the graph // ('Observation', 'User', 'Species', "Observed", "Reviewed", "ObservedIn") // but only the 'Observation' sublayer will contain data. // the 'Observation' sublayer will contain all instance of the Observation entity type { generateAllSublayers: true, namedTypeDefinition:[{ key: "Observation", value:{ useAllData: true } }] } // A more complex example: { //sublayers will only be created for the types listed generateAllSublayers: false, namedTypeDefinitions: { //include all `Species` entities that exist at the time the layer is created Species: { useAllData: true }, //include all `User` entities that exist at the time the layer is created User: { useAllData: true }, //include all only the specified `Observation` entities Observation: { useAllData:false, members: { "{941A7425-C45D-4940-A2E8-F3611973EC8A}": { id: "{941A7425-C45D-4940-A2E8-F3611973EC8A}" }, "{94DC1D53-4043-4D0B-8CF7-18B690414118}": { id: "{94DC1D53-4043-4D0B-8CF7-18B690414118}" }, //This entity has a fixed location so will remain in the same place regardless of the layout applied. //the other entities will move around it "{4E1D1ACE-6252-4BA4-B76E-CDEDFE9B0AB1}": { id: "{4E1D1ACE-6252-4BA4-B76E-CDEDFE9B0AB1}", linkChartLocation: new Point({x: 55.26841, y: 10.2884}) }, "{559312DF-893C-44E2-AD86-BAA73CD49719}": { id: "{559312DF-893C-44E2-AD86-BAA73CD49719}" }, "{158A2D46-3EFF-4479-BC57-E6981FCB80B6}": { id: "{158A2D46-3EFF-4479-BC57-E6981FCB80B6}" }, "{40AD70FC-CD7D-4928-B555-38EA49675944}": { id: "{40AD70FC-CD7D-4928-B555-38EA49675944}" }, "{3A5B8F11-5971-4A46-99AC-F509CA59B517}": { id: "{3A5B8F11-5971-4A46-99AC-F509CA59B517}" } } }, //include all `Observed` relationships that exist at the time the layer is created Observed: { useAllData: true }, //include all `ObservedIn` relationships that exist at the time the layer is created ObservedIn: { useAllData: true } } }
-
knowledgeGraph KnowledgeGraphreadonly
-
The data model, service definition and url of the knowledge graph service that contains the data for the KnowledgeGraphLayer.
-
layers Collection<KnowledgeGraphSublayer>readonly
-
A collection of operational KnowledgeGraphSublayer. Each layer represents an entity type or relationship type sublayer. Each feature contained in each sublayer has a geometry that allows it to be rendered as a graphic with spatial context on the view. Features within the layer may also contain data attributes that provide additional information that may be viewed in popup. These layers can also be queried and analyzed.
Example//to access individual sublayers to add or modify properties such as the renderer, popups and labels KnowledgeGraphLayer.layers.items.forEach((sublayer)=>{ sublayer.popupTemplate = new PopupTemplate({ title: "{common_name}", content: [{ type: "text", text: "Scientific Name: {name}" }] }); })
-
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
Value Description show The layer is visible in the table of contents. hide The layer is hidden in the table of contents. hide-children If the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents. Possible Values:"show"|"hide"|"hide-children"
- Default Value:"show"
-
Indicates whether the layer's resources have loaded. When
true
, all the properties of the object can be accessed.- Default Value:false
-
The Error object returned if an error occurred while loading.
- Default Value:null
-
Represents the status of a load operation.
Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details. Possible Values:"not-loaded"|"loading"|"failed"|"loaded"
- Default Value:not-loaded
-
A list of warnings which occurred while loading.
-
memberEntityTypes EntityType[]readonly
-
The entity types included in the KnowledgeGraphLayer.
-
memberRelationshipTypes RelationshipType[]readonly
-
The relationship types included in the KnowledgeGraphLayer.
-
The opacity of the layer. This value can range between
1
and0
, where0
is 100 percent transparent and1
is completely opaque.- Default Value:1
Example// Makes the layer 50% transparent layer.opacity = 0.5;
-
Since: ArcGIS Maps SDK for JavaScript 4.27
-
The parent to which the layer belongs.
-
tables Collection<KnowledgeGraphSublayer>readonly
-
All non-spatial entity type and relationship type sublayers. They have the same structure as the spatial sublayers but the
geometryType
is null. These layers can also be queried and analyzed.
-
title String
-
An optional title for the KnowledgeGraphLayer.
-
type Stringreadonly
-
The layer type.
For KnowledgeGraphLayer the type is always "knowledge-graph".
-
url String
-
The url of the knowledge graph service.
-
Indicates if the layer is visible in the View. When
false
, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.- Default Value:true
Example// The layer is no longer visible in the view layer.visible = false;
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Cancels a load() operation if it is already in progress. more details | Layer | ||
Promise<LayerView> | Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. more details | Layer | |
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). more details | Layer | ||
Boolean | Emits an event on the instance. more details | Layer | |
Promise<object> | Fetches custom attribution data for the layer when it becomes available. more details | Layer | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Layer | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Layer | |
Boolean |
| Layer | |
Boolean |
| Layer | |
Promise | Loads the resources referenced by this class. more details | Layer | |
Assumes that data for all of the members defined in the inclusionModeDefinition is already loaded into local storage. more details | KnowledgeGraphLayer | ||
Object | Registers an event handler on the instance. more details | Layer | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise |
| Layer |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.
Parametersview *The parent view.
options ObjectoptionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Specificationsignal AbortSignaloptionalA signal to abort the creation of the layerview.
ReturnsType Description Promise<LayerView> Resolves with a LayerView instance. - See also
-
destroy()inherited
-
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.
The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Fetches custom attribution data for the layer when it becomes available.
ReturnsType Description Promise<object> Resolves to an object containing custom attribution data for the layer.
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The
load()
method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.It's possible to provide a
signal
to stop being interested into aLoadable
instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.Parametersignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise Resolves when the resources have loaded.
-
loadLayerAssumingLocalCache()static
-
Assumes that data for all of the members defined in the inclusionModeDefinition is already loaded into local storage. This will optimize layer load times.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
removeHandles(groupKey)inherited
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.Example// Although this example uses MapView, any class instance that is a promise may use when() in the same way let view = new MapView(); view.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
InclusionModeDefinition Object
-
Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer
- Properties
-
generateAllSublayers Boolean
Specifies whether to create sublayers for each named type regardless of whether or not they are included in the
namedTypeDefinition
. Iftrue
all named types (EntityType and RelationshipType) will be added as an empty sublayer.namedTypeDefinitions Map<String, LayerInclusionDefinition>A map of named types and the specific instances of those types to include in the layer.
-
LayerInclusionDefinition Object
-
Defines the contents of each specified named type in the
inclusionModeDefinition
and whether all instance of the named type will be used or a specified subset.- Properties
-
useAllData Boolean
If
true
all of the instances of the named type will be included regardless of if there is a defined list of members. Iffalse
only the instances specified in themembers
property will be included.members Map<String, LayerInclusionMemberDefinition>A map of the specific members of the named type to be included. The key is the global ID of the instance.
-
LayerInclusionMemberDefinition Object
-
Defines the list of
members
for a named type in theinclusionModeDefinition
.- Property
-
id String
The global ID of the specific instance of the named type to be included in the layer.
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
{view: View,layerView: LayerView} |
Fires after the layer's LayerView is created and rendered in a view. more details |
Layer | |
{view: View,error: Error} |
Fires when an error emits during the creation of a LayerView after a layer has been added to the map. more details |
Layer | |
{view: View,layerView: LayerView} |
Fires after the layer's LayerView is destroyed and no longer renders in a view. more details |
Layer |
Event Details
-
layerview-createinherited
-
Fires after the layer's LayerView is created and rendered in a view.
- Properties
-
view View
The view in which the
layerView
was created.layerView LayerViewThe LayerView rendered in the view representing the layer in
layer
. - See also
Example// This function will fire each time a layer view is created for this // particular view. layer.on("layerview-create", function(event){ // The LayerView for the layer that emitted this event event.layerView; });
-
layerview-create-errorinherited
-
Fires when an error emits during the creation of a LayerView after a layer has been added to the map.
- Properties
-
view View
The view that failed to create a layerview for the layer emitting this event.
error ErrorAn error object describing why the layer view failed to create.
- See also
Example// This function fires when an error occurs during the creation of the layer's layerview layer.on("layerview-create-error", function(event) { console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view); });