import type { IdTypePair, LayoutMode, InclusionModeDefinition, LayerInclusionDefinition, LayerInclusionMemberDefinition } from "@arcgis/core/layers/knowledgeGraph/types.js";Type definitions
IdTypePair
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The id and named type of a record to be added or removed from the knowledge graph.
id
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The global ID of the record to be added to or removed from the the knowledge graph layer.
typeName
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
the named type of the record to be added or removed from the knowledge graph layer.
LayoutMode
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- Extract<LayoutType‚ "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">
InclusionModeDefinition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer
generateAllSublayers
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
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.
namedTypeDefinitions
- Type
- Map<string, LayerInclusionDefinition>
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A map of named types and the specific instances of those types to include in the layer.
LayerInclusionDefinition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Defines the contents of each specified named type in the KnowledgeGraphLayer.inclusionModeDefinition and whether all instance of the named type will be used or a specified subset.
useAllData
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
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.
members
- Type
- Map<string, LayerInclusionMemberDefinition> | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A map of the specific members of the named type to be included. The key is the global ID of the instance.
LayerInclusionMemberDefinition
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Defines the list of members for a named type in the KnowledgeGraphLayer.inclusionModeDefinition.
id
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The global ID of the specific instance of the named type to be included in the layer.