ESM: import LinkChartLayer from "@arcgis/core/layers/LinkChartLayer.js";
CDN: const LinkChartLayer = await $arcgis.import("@arcgis/core/layers/LinkChartLayer.js");
Class: @arcgis/core/layers/LinkChartLayer
Since: ArcGIS Maps SDK for JavaScript 4.31
A LinkChartLayer is a composite layer that can be created from a knowledge graph service. The layer contains sublayers for each entity type and relationship type contained in the LinkChartLayer.
Entity and relationship types have geometries that allows them to be rendered in a LinkChartView or as a graphic with spatial context. They also contain data attributes that provide additional information about the real-world feature it represents; Attributes may be viewed in popups and used for rendering the layer. Sublayers may be queried, analyzed, and rendered to visualize data in a spatial context.
Implementation Note
Link chart layers are not dynamic. If no inclusion definition is specified, the inclusion definition will be defined as all records in the graph at the time of layer creation. If a named type is specified with no explicit members, then all records of that named type will be defined as the inclusion definition. Any data added to the graph or named type after this point will not be included in the link chart.
Create Link Chart LayerTo create a LinkChartLayer from knowledgeGraphService, you must set the url property to the REST endpoint of the service. For a layer to be visible in a view, it must be added to the WebLinkChart referenced by the view. See WebLinkChart for information about adding layers to a WebLinkChart.
const [LinkChartLayer, WebLinkChart, LinkChartView] = await $arcgis.import([
"@arcgis/core/layers/LinkChartLayer.js",
"@arcgis/core/WebLinkChart.js",
"@arcgis/core/LinkChartView.js"
]);
const myLinkChartLayer = new LinkChartLayer({
title: "link chart layer",
url: "https://sampleserver7.arcgisonline.com/arcgis/rest/services/Hosted/SmallBumbleBees/KnowledgeGraphServer"
});
myLinkChartLayer.load().then(()=>{
const linkchart = new WebLinkChart({
layers: [myLinkChartLayer]
});
})
new LinkChartLayer(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
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;
});Inherited
Property id String
The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.
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 is true and a new entity type is added to the knowledge graph, that new entity type will not be added to the inclusion list. Similarly, if useAllData is true 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 namedTypeDefinition
namedTypeDefinitions: namedTypeDefinition
}//examples of the initializationInclusionModeDefinition structure inside the LinkChartLayer
//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}",
},
"{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
}
}
}The default configuration options for a new link chart layer. This includes the layout and any layout settings for the initial view of the layer.
Constructor Only
This property is only supported when passed to the constructor on the first initialization of a link chart layer. Use WebLinkChart.applyLayout() to update the layout and layout settings after initialization.
A collection of operational sublayers. Each sublayer represents an entity type or relationship type in the graph.
Each feature contained in each sublayer has a geometry that allows it to be rendered as a graphic with spatial context on the view. In GEOGRAPHIC layout mode, any spatial entities with geometry will be drawn at their appropriate locations. All non-spatial entities will be arrayed around the spatial entities they relate to. In all other layouts, the geometry for each entity is its location on the link chart canvas. The location of specific instances can be set so that when the layout mode changes or the link chart is reloaded, they remain in the same spot.
Features within the layer may also contain data attributes that provide additional information that may be viewed in a 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
LinkChartLayer.layers.forEach((sublayer)=>{
sublayer.popupTemplate = new PopupTemplate({
title: "{common_name}",
content: [{
type: "text",
text: "Scientific Name: {name}"
}]
});
})Inherited
Property listMode String
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
Possible Values:"show" |"hide" |"hide-children"
The Error object returned if an error occurred while loading.
Inherited
Property loadStatus Stringreadonly
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"
Inherited
Property loadWarnings Object[]readonly
A list of warnings which occurred while loading.
Inherited
Property loaded Booleanreadonly
Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.
Since: ArcGIS Maps SDK for JavaScript 4.32 LinkChartLayer since 4.31, memberEntityTypes added at 4.32.
The entity types included in the LinkChartLayer.
Since: ArcGIS Maps SDK for JavaScript 4.32 LinkChartLayer since 4.31, memberRelationshipTypes added at 4.32.
The relationship types included in the LinkChartLayer.
Inherited
Property opacity Number
The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.
Example
// Makes the layer 50% transparent
layer.opacity = 0.5;The parent to which the layer belongs.
Inherited
Property persistenceEnabled Booleanreadonly
When true, the layer can be persisted. This property only has an effect for layers that are part of the WebMap or WebScene spec.
An optional title for the LinkChartLayer.
Inherited
Property uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 Layer since 4.0, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the start or end date values are available, the layer remains visible indefinitely in the direction where there is no time value.
Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.
Inherited
Property visible Boolean
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.
Example
// The layer is no longer visible in the view
layer.visible = false;
// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
() => layer.visible,
(visible) => {
if (visible) {
anotherLayer.visible = true;
} else {
anotherLayer.visible = false;
}
}
);Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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();
Parameters
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.
applyNewLinkChartLayout()
Calculates the layout for the link chart and refreshes the canvas with the new layout.
Inherited
Method cancelLoad()
Cancels a load() operation if it is already in progress.
Inherited
Method createLayerView(view, options){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. This method is used internally and there is no use case for invoking it directly.
Parameters
view *
The parent view.
optionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Returns
Inherited
Method destroy()
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.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method fetchAttributionData(){Promise<Object>}
Fetches custom attribution data for the layer when it becomes available.
Returns
Type Description Promise<Object> Resolves to an object containing custom attribution data for the layer.Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method isFulfilled(){Boolean}
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.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Inherited
Method load(options){Promise}
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 a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.
Parameters
optionalAdditional options.
Specification
optionalSignal 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.
Returns
Type Description Promise Resolves when the resources have loaded. loadLayerAssumingLocalCache()
Loads layer assuming that data for all of the members defined in the initializationInclusionModeDefinition is already loaded into local storage. This will optimize layer load times.
Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() 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.
Example
view.on("click", function(event){
// event is the event handle returned after the event fires.
console.log(event.mapPoint);
});Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");Inherited
Method when(callback, errback){Promise}
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback 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
}); InclusionModeDefinition Object
Defines the sublayer structure and the named types that will be in the LinkChartLayer.
Specifies whether to create sublayers for each named type regardless of whether or not they are included in the namedTypeDefinition. If true all named types (EntityType and RelationshipType) will be added as an empty sublayer.
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 initializationInclusionModeDefinition and whether all instance of the named type will be used or a specified subset.
If true all of the instances of the named type will be included regardless of if there is a defined list of members. If false only the instances specified in the members property will be included.
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 the initializationInclusionModeDefinition.
The global ID of the specific instance of the named type to be included in the layer.
optionalThe exact point location of the entity on the LinkChart.
initializationLinkChartConfig Object
Defines the initial layout for the link chart and any layout settings for newly created link chart layers.
The layout mode to be applied by default. The system default is organic-standard.
Possible Values:"organic-standard"|"organic-community"|"basic-grid"|"hierarchical-bottom-to-top"|"radial-root-centric"|"tree-left-to-right"|"geographic-organic-standard"|"chronological-mono-timeline"|"chronological-multi-timeline"
optionalBy default, the layout algorithm always runs on link charts when they are first created. If all diagram locations are set for every entity in the inclusion definition, this property can be set to true which skips the layout algorithm step and increases the performance of larger link charts.
Additional layout options for the default layout configuration.
Show inherited events Hide inherited events
Event DetailsInherited
Event layerview-create
Fires after the layer's LayerView is created and rendered in a view.
The view in which the layerView was created.
The LayerView rendered in the view representing the layer in layer.
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;
});Inherited
Event layerview-create-error
Fires when an error emits during the creation of a LayerView after a layer has been added to the map.
The view that failed to create a layerview for the layer emitting this event.
An error object describing why the layer view failed to create.
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);
});Inherited
Event layerview-destroy
Fires after the layer's LayerView is destroyed and no longer renders in a view.
The view in which the layerView was destroyed.
The destroyed LayerView representing the layer.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4