KnowledgeGraphLayer

// 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 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
		}
	}
}

//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}"
  }]
 });
})