| Property | Value | Description |
|---|---|---|
| Undirected | 0 | Relationships are considered to be undirected. |
| Directed | 1 | Relationships are considered to be directed. |
| Reversed | 2 | Relationships are considered to be directed and their direction is reversed. |
| Property | Value | Description |
|---|---|---|
| None | 0 | No normalization is done. |
| Global | 1 | Normalize globally. |
| ByComponent | 2 | Normalize by component. |
| Property | Value | Description |
|---|---|---|
| None | 0 | Events ticks are not shown. |
| StartOnly | 1 | Only start ticks are shown. |
| StartAndEnd | 2 | Start and End ticks are shown. |
| Property | Type | Description |
|---|---|---|
| name | string | The name of the configuration. |
| originEntities | [CIMFilteredFindPathsEntity] | The origin entities. |
| destinationEntities | [CIMFilteredFindPathsEntity] | The destination entities. |
| pathFilters | [CIMFilteredFindPathsPathFilter] | The path filters. |
| defaultTraversalDirectionType | enumeration KGTraversalDirectionType | The default traversal direction which is used for any relationship type that is not defined in the traversal directions list. |
| traversalDirections | [CIMKGTraversalDirection] | The traversal directions. |
| entityUsage | enumeration FilteredFindPathsEntityUsage | The usage of origin/destination entities in the filtered find paths algorithm. |
| pathMode | enumeration KGPathMode | Whether the filtered find paths algorithm searches for shortest paths or for all paths. |
| minPathLength | long | The min path length. |
| maxPathLength | long | The max path length. The default of 0 means the value is unlimited. |
| maxCountPaths | long | The max number of paths the filtered find paths algorithm returns. |
| timeFilter | CIMKGTimeFilter | The time filter. |
Represents a Knowledge Graph Filtered Find Paths Entity. An entity can be used for a specific instance, in this case the ID has a value, or for all instances of a type, in this case the ID is null.
| Property | Type | Description |
|---|---|---|
| ID | any | The id of the entity instance used as a origin/destination entity. If this id is null, then the filtered find paths algorithm uses all instances of the specified entity type. |
| entityTypeName | string | The type name of the entity (type or instance) used as an origin/destination entity. |
| propertyFilterPredicate | string | The property filter predicate (cypher syntax) associated with the path filter. |
| Property | Value | Description |
|---|---|---|
| AnyOriginAnyDestination | 0 | The filtered find paths algorithm only returns the shortest paths for the origin entities that have the shortest shortest paths and the shortest paths for the destination entities that have the shortest shortest paths. When multiple entities are used, this option leads to faster computations. |
| AnyOriginAllDestinations | 1 | The filtered find paths algorithm returns the shortest paths for the origin entities that have the shortest shortest paths and all shortest paths for all destination entities. When multiple entities are used, this option leads to longer computations. |
| AllOriginsAnyDestination | 2 | The filtered find paths algorithm returns all shortest paths for all origin entities and the shortest paths for the destination entities that have the shortest shortest paths. When multiple entities are used, this option leads to longer computations. |
| AllOriginsAllDestinations | 3 | The filtered find paths algorithm returns all shortest paths for all origin entities and all shortest paths for all destination entities. When multiple entities are used, this option leads to longer computations. |
Represents a Knowledge Graph Filtered Find Paths Path Filter. A path filter can be used for a specific instance, in this case the ID has a value, or for all instances of a type, in this case the ID is null.
| Property | Type | Description |
|---|---|---|
| ID | any | The id of the entity/relationship instance used for the path filter. If this id is null, then the path filter is used on all instances of the specified entity/relationship type. |
| itemTypeName | string | The type name of the entity/relationship (type or instance) used for the path filter. |
| itemType | enumeration KGPathFilterItemType | Whether the path filter is used for entities or relationships. |
| filterType | enumeration KGPathFilterType | The filter type of the path filter. |
| propertyFilterPredicate | string | The property filter predicate (cypher syntax) associated with the path filter. |
Rules defining which "successor" events are allowed to be after a given "predecessor" event. One implied rule is that a successor event must start at or after the start of the predecessor event. These rules use the notions of "Gap" and "Overlap" defined hereunder. Definition of "Overlap": When the successor event start is before the predecessor event end, the overlap is the time from the successor event start to the predecessor event end. When the successor event start is after the predecessor event end, the overlap is zero. Definition of "Gap": When the successor event start is before the predecessor event end, the gap is zero. When the successor event start is after the predecessor event end, the gap is the time from the predecessor event end to the successor event start.
| Property | Type | Description |
|---|---|---|
| restrictMaxOverlap | boolean | A value indicating whether the max overlap is restricted. |
| maxOverlap | double | The max overlap between consecutive events. The unit of this value is MaxOverlapUnit. This value is taken into account only if RestrictMaxOverlap is true. |
| maxOverlapUnit | enumeration esriTimeUnits | The unit of MaxOverlap. Accepted values are { esriTimeUnitsMilliseconds, esriTimeUnitsSeconds, esriTimeUnitsMinutes, esriTimeUnitsHours, esriTimeUnitsDays, esriTimeUnitsWeeks }. |
| restrictMaxGap | boolean | A value indicating whether the max gap is restricted. |
| maxGap | double | The max gap. The unit of this value is MaxGapUnit. This value is taken into account only if RestrictMaxGap is true. |
| maxGapUnit | enumeration esriTimeUnits | The unit of MaxGap. Accepted values are { esriTimeUnitsMilliseconds, esriTimeUnitsSeconds, esriTimeUnitsMinutes, esriTimeUnitsHours, esriTimeUnitsDays, esriTimeUnitsWeeks }. |
| Property | Value | Description |
|---|---|---|
| Error | 0 | Return an error. |
| Exclude | 1 | Do not use the event in a path. |
| MakeNonEvent | 2 | Consider the entity or relationship is not an event. |
| MakePunctualEvent | 3 | Convert the durative event to a punctual event at the known time. |
| Property | Value | Description |
|---|---|---|
| Error | 0 | Return an error. |
| Exclude | 1 | Do not use the event in a path. |
| MakeNonEvent | 2 | Consider the entity or relationship is not an event. |
| MakeMinPunctualEvent | 3 | Convert the durative event to a punctual event at the minimum time. |
| MakeMaxPunctualEvent | 4 | Convert the durative event to a punctual event at the maximum time. |
| MakeDurativeEvent | 5 | Swap start and end time so that start time is before end time. |
Constraints on the duration of durative events. Note that this constraint does not apply to punctual events.
| Property | Type | Description |
|---|---|---|
| timeUnit | enumeration esriTimeUnits | The unit of minimum and maximum durations. Accepted values are { esriTimeUnitsMilliseconds, esriTimeUnitsSeconds, esriTimeUnitsMinutes, esriTimeUnitsHours, esriTimeUnitsDays, esriTimeUnitsWeeks }. |
| minDuration | double | The minimum duration. The unit of minimum duration is TimeUnit. |
| useMaxDuration | boolean | A value indicating whether the maximum duration should be used. |
| maxDuration | double | The maximum duration. The unit of maximum duration is TimeUnit. This value is only used if UseMaxDuration is true. |
Events can be durative (with both start and end properties) or punctual (with just start or just end property).
| Property | Type | Description |
|---|---|---|
| namedType | string | The entity or relationship type name. |
| startProperty | string | The name of the property defining the start time of the event. |
| endProperty | string | The name of the property defining the end time of the event. |
| Property | Type | Description |
|---|---|---|
| KGEventMissingAllTimesBehaviour | enumeration KGEventMissingAllTimesBehaviour | The behaviour when an event has no time. |
| KGDurativeEventMissingOneTimeBehaviour | enumeration KGDurativeEventMissingOneTimeBehaviour | The behaviour when a durative event has one missing time. |
| KGDurativeEventSwappedTimesBehaviour | enumeration KGDurativeEventSwappedTimesBehaviour | The behaviour when a durative event has swapped times. |
| Property | Value | Description |
|---|---|---|
| Error | 0 | Return an error. |
| Exclude | 1 | Do not use the event in a path. |
| MakeNonEvent | 2 | Consider the entity or relationship is not an event. |
| Property | Type | Description |
|---|---|---|
| eventDefinitions | [CIMKGEventDefinition] | The list of CIMKGEventDefinition. |
Specifies whether the path filter is applied to an entity/entity type or a relationship/relationship type.
| Property | Value | Description |
|---|---|---|
| Entity | 0 | Path filter is applied to an entity or entity type. |
| Relationship | 1 | Path filter is applied to a Relationship. |
| Property | Value | Description |
|---|---|---|
| IncludeOnly | 0 | The filtered find paths algorithm will only consider paths which contain included types (type is active). If a path filter does not use the include only option, all types are active. |
| Exclude | 1 | The filtered find paths algorithm will ignore paths that contain excluded types (type is not active). |
| MandatoryWaypoint | 2 | The filtered find paths algorithm will only consider paths passing through the all the mandatory waypoints. |
| OptionalWaypoint | 3 | The filtered find paths algorithm will only consider paths passing through at least one of the optional waypoints. |
Specifies whether the filtered find paths algorithm searches for all paths or only the shortest paths.
| Property | Value | Description |
|---|---|---|
| Shortest | 0 | The filtered find paths algorithm only searches for the shortest paths. |
| All | 1 | The filtered find paths algorithm searches for all paths. |
| Property | Value | Description |
|---|---|---|
| Forward | 0 | Time flows forward. |
| Backward | 1 | Time flows backward. |
| Unconstrained | 2 | Time flows in any direction and can alternate. |
| Property | Type | Description |
|---|---|---|
| enabled | boolean | A value indicating whether the filter is enabled. Note that having an empty list of event definitions is equivalent to not enabling the time filter, however since "Enable time filter" is a separate setting in the UI we have this member. |
| KGPathTimeFlow | enumeration KGPathTimeFlow | A value indicating how time should flow along the result paths. |
| timeWindow | CIMKGTimeWindow | The time window. Any event that has a time span not intersecting the time window will be excluded. |
| eventsDefinitions | CIMKGEventsDefinitions | The events definitions. |
| durativeEventsDurationConstraint | CIMKGDurativeEventsDurationConstraint | The constraint on durative events duration. |
| eventErrorHandling | CIMKGEventErrorHandling | A value indicating how event data errors should be handled. |
| consecutiveEventsRestrictions | CIMKGConsecutiveEventsRestrictions | The consecutive events restrictions. |
| Property | Type | Description |
|---|---|---|
| minTime | TimestampOffset | The minimum time. Can be null if no minimum time exists. |
| maxTime | TimestampOffset | The maximum time. Can be null if no maximum time exists. |
Represents a Knowledge Graph Filtered Find Paths TraversalDirection. The filtered find paths algorithm uses traversal directions to specify how relationships are traversed. When no traversal direction is defined for a specific relationship type, the default traversal direction is used.
| Property | Type | Description |
|---|---|---|
| relationshipTypeName | string | The relationship type name of the traversal direction object. |
| traversalDirectionType | enumeration KGTraversalDirectionType | The traversal direction of the traversal direction object. |
| Property | Value | Description |
|---|---|---|
| Any | 0 | The filtered find paths algorithm considers all relationships independent of their direction. |
| Forward | 1 | The filtered find paths algorithm considers only the relationships that are traversed in forward direction. |
| Backward | 2 | The filtered find paths algorithm considers only the relationships that are traversed in backward direction. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| fieldNames | [string] | The field names of this property value. |
| spatialReference | SpatialReference | The spatial reference of the coordinates. |
| interpretAsLongitudeLatitude | boolean | A value indicating whether the coordinate should be interpreted as long,lat (true) or lat,lon(false,default). This value only has meaning when the coordinate is ambiguous. For example, the coordinate "34N 22E" is not ambiguous as the latitude and longitude are both defined by the coordinate. However, "34 22" is ambiguous since it could mean either "34N 22E" or "34E 22N". In this situation the value of this property determines the recognized coordinate. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| workspaceConnectionString | string | The workspace connection string. |
| workspaceFactory | enumeration WorkspaceFactory | The workspace factory. |
| customWorkspaceFactoryCLSID | string | The classID of the custom workspace factory. |
| dataset | string | The dataset name. |
| datasetType | enumeration esriDatasetType | The dataset type. |
| Property | Type | Description |
|---|---|---|
| definitionQuery | string | The OpenCypher definition query. |
| Property | Type | Description |
|---|---|---|
| name | string | The name of the Data Loading Configuration. Names are expected to be unique within an Investigation. |
| entities | [CIMKnowledgeGraphDataLoadingEntity] | The entities. |
| relationships | [CIMKnowledgeGraphDataLoadingRelationship] | The relationships. |
| Property | Type | Description |
|---|---|---|
| name | string | The name of the entity. |
| entityType | string | The type of the entity. |
| typeIsFieldName | boolean | A value indicating whether the Type property is a name itself or the name of a field. |
| entityTypeExpression | CIMExpressionInfo | The expression which is used to generate the entity type of this entity. This property takes precedence over the TypeIsFieldName and EntityType properties. If the EntityTypeExpression property is not null, the EntityType is generated from the script defined in the expression object. If the EntityTypeExpression property is null, the value of the EntityType property is interpreted based on the TypeIsFieldName property. |
| properties | [CIMKnowledgeGraphProperty] | The properties of this entity. |
| merge | boolean | A value indicating whether this entity should be merged. |
| Property | Type | Description |
|---|---|---|
| name | string | The name of the relationship. |
| sourceEntityName | string | The source entity name. |
| relationshipType | string | The type of the relationship. |
| typeIsFieldName | boolean | A value indicating whether the Type property is a name itself or the name of a field. |
| relationshipTypeExpression | CIMExpressionInfo | The expression which is used to generate the relationship type of this relationship. This property takes precedence over the TypeIsFieldName and RelationshipType properties. If the RelationshipTypeExpression is not null, the RelationshipType is generated from the script defined in the expression object. If the RelationshipTypeExpression is null, the value of the RelationshipType property is interpreted based on the TypeIsFieldName property. |
| targetEntityName | string | The target entity name. |
| properties | [CIMKnowledgeGraphProperty] | The properties of this relationship. |
| merge | boolean | A value indicating whether this relationship should be merged. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| expression | CIMExpressionInfo | The expression info of this property value. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| fieldName | string | The field name of this property value. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| fixedValue | string | The fixed value of this property value. |
Represents the ID property value from a specific CIMKnowledgeGraphDataLoadingEntity or CIMKnowledgeGraphDataLoadingRelationship.
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| dataLoadingItemName | string | The name of a CIMKnowledgeGraphDataLoadingEntity or CIMKnowledgeGraphDataLoadingRelationship. |
| Property | Type | Description |
|---|---|---|
| name | string | The name. |
| URI | string | The URI of the definition. Typically set by the system and used as an identifier. |
| sourceURI | string | The source URI of the item. Set if sourced from an external item such as an item on a portal. |
| sourceModifiedTime | TimeInstant | The time the source was last modified, as of the last sync. Used to detect when another sync is needed. |
| metadataURI | string | The metadata URI. |
| useSourceMetadata | boolean | A value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project. |
| sourcePortalUrl | string | The source portal URI of the item. Set if sourced from an external item such as an item on a portal. |
| Property | Type | Description |
|---|---|---|
| dataConnection | DataConnection | The data connection. |
| dataLoadingConfigurations | [CIMKnowledgeGraphDataLoadingConfiguration] | The array of Data Loading Configurations referenced by this Investigation. All configurations are expected to have unique names. |
| searchDefinitions | [CIMKnowledgeGraphSearchDefinition] | The array of search definitions referenced by this Investigation. All search definitions are expected to have unique names. |
| queryDefinitions | [CIMKnowledgeGraphQueryDefinition] | The array of query definitions referenced by this Investigation. All query definitions are expected to have unique names. |
| filteredFindPathsConfigurations | [CIMFilteredFindPathsConfiguration] | The array of Filtered Find Paths Configurations referenced by this Investigation. All configurations are expected to have unique names. |
| typeInfos | [CIMKnowledgeGraphInvestigationTypeInfo] | The array of Knowledge Graph Investigation Type Infos referenced by this Investigation. All infos are expected to have unique type names. |
| customProperties | [CIMStringMap] | The custom properties of the investigation. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content. |
| Property | Type | Description |
|---|---|---|
| typeName | string | The name of the type. |
| popupInfo | CIMPopupInfo | The pop-up info. |
| symbol | CIMSymbolReference | The symbol for the type. |
| displayExpressionInfo | CIMExpressionInfo | The expression information used to create the display name for members of the type. |
| Property | Type | Description |
|---|---|---|
| name | string | The name. |
| URI | string | The URI of the definition. Typically set by the system and used as an identifier. |
| sourceURI | string | The source URI of the item. Set if sourced from an external item such as an item on a portal. |
| sourceModifiedTime | TimeInstant | The time the source was last modified, as of the last sync. Used to detect when another sync is needed. |
| metadataURI | string | The metadata URI. |
| useSourceMetadata | boolean | A value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project. |
| sourcePortalUrl | string | The source portal URI of the item. Set if sourced from an external item such as an item on a portal. |
| Property | Type | Description |
|---|---|---|
| attribution | string | The attribution text that appears on a map that draws this layer. |
| description | string | The description. |
| layerElevation | CIMLayerElevationSurface | The layer elevation. |
| expanded | boolean | A value indicating whether this layer is expanded in the contents pane. |
| layer3DProperties | CIM3DLayerProperties | The 3D layer properties. |
| layerMasks | [string] | The URIs of the layers used as masks. |
| layerType | enumeration MapLayerType | The map layer type. |
| maxScale | double | The maximum scale for layer draw (set as the denominator of the scale's representative fraction). |
| minScale | double | The minimum scale for layer draw (set as the denominator of the scale's representative fraction). |
| layerScaleVisibilityOptions | CIMLayerScaleVisibilityOptions | The layer's scale visibility options. |
| showLegends | boolean | A value indicating whether or not to show legends. |
| transparency | double | The transparency of the layer. |
| visibility | boolean | A value indicating whether or not this layer is visible. |
| displayCacheType | enumeration DisplayCacheType | The display cache type. |
| maxDisplayCacheAge | double | The maximum display cache age. |
| layerTemplate | CIMLayerTemplate | The layer template. |
| popupInfo | CIMPopupInfo | The pop-up info. |
| showPopups | boolean | A value indicating whether or not to show pop-ups. |
| serviceLayerID | long | Identifier that will be used to identify the layer in server. |
| charts | [CIMChart] | Identifier the layer's charts. |
| searchable | boolean | A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search. |
| refreshRate | double | The amount of time to wait between refreshing the layer. |
| refreshRateUnit | enumeration esriTimeUnits | The units for the amount of time to wait between refreshing the layer. |
| showMapTips | boolean | A value indicating whether or not the display value is shown when hovering over a layer in the view. |
| customProperties | [CIMStringMap] | The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content. |
| webMapLayerID | string | An identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map. |
| blendingMode | enumeration BlendingMode | The blending mode for the layer. |
| allowDrapingOnIntegratedMesh | boolean | A value indicating whether layer can be draped on integrated mesh. |
| rasterizeOnExport | boolean | A value indicating whether layer should be rasterized when exporting. |
| useVisibilityTimeExtent | boolean | A value indicating whether or not to use the visibility time extent. When true the map time must overlap the visibility time extent for the layer to be visible. |
| visibilityTimeExtent | TimeExtent | The visibility time extent. |
| enableLayerEffects | boolean | A value indicating whether to enable any type of effects on the layer. |
| layerEffects | [CIMLayerEffect] | The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect. |
| Property | Type | Description |
|---|---|---|
| standaloneTables | [string] | The standalone tables as an array of table repository paths. |
| Property | Type | Description |
|---|---|---|
| dataConnection | DataConnection | The data connection. |
| layers | [string] | The layer URIs of the layers in the composite layer. |
| Property | Type | Description |
|---|---|---|
| relationshipsInterpretation | enumeration CentralityRelationshipInterpretation | The relationships interpretation. |
| multiedgeFactor | double | The multiedge factor. Acceptable values lie in [0, 1]. In centrality computations, each multiple edge is reduced to a single edge with a weight of: '(1 - MultiedgeFactor) + "count of edges in the multiple edge" * MultiedgeFactor'. Hence, if MultiedgeFactor is 0, the weight is 1, and if MultiedgeFactor is 1, the weight is "count edges in multiedge". |
| normalization | enumeration CentralityScoresNormalization | The scores normalization. |
| Property | Type | Description |
|---|---|---|
| nodesURI | string | The URI of the binary reference containing a serialized representation of the internal Nodes table. |
| linksURI | string | The URI of the binary reference containing a serialized representation of the internal Links table. |
| aggregatedNodesURI | string | The URI of the binary reference containing a serialized representation of the internal AggregatedNodes table. |
| aggregatedLinksURI | string | The URI of the binary reference containing a serialized representation of the internal AggregatedLinks table. |
| autoCollapseRelationships | boolean | A value indicating whether this Link Chart automatically collapses eligible relationships. |
| centralityConfiguration | CIMKnowledgeGraphLinkChartCentralityConfiguration | The Configuration for Centrality computation in this Link Chart. Centrality scores found in the Nodes and AggregatedNodes tables were computed using this Configuration. |
| centralityIsUpToDate | boolean | A value indicating whether the Centrality scores found in the Nodes and AggregatedNodes tables were computed using the current Link Chart topology. |
| lastUsedLayout | CIMKnowledgeLinkChartLayout | Information about the last used layout. |
| nonspatialDataDisplay | CIMKnowledgeNonspatialDataDisplay | The Nonspatial Data Display information in this Link Chart. |
| Property | Type | Description |
|---|---|---|
| name | string | The name of the property. |
| propertyType | enumeration esriFieldType | The type of the property. |
| value | KnowledgeGraphPropertyValue | The value which is to be imported. Value will have to be tested for type in order to properly perform the import. |
| merge | boolean | A value indicating whether this property should be used to determine a merge. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| name | string | User defined name for open cypher query. |
| openCypherQuery | string | User defined open cypher query. |
| provenanceBehavior | enumeration ProvenanceBehavior | The query behavior for Provenance. |
| Property | Type | Description |
|---|---|---|
| name | string | User defined name for search. |
| searchString | string | User defined search string. Search string is based on Lucene syntax. |
| filterSetting | CIMKnowledgeGraphSearchFilterSetting | Search filter setting. |
| Property | Value | Description |
|---|---|---|
| Entities | 1 | Search only in entities. |
| Relationships | 2 | Search only in relationships. |
| BothEntitiesAndRelationships | 3 | Search in entities and relationships. |
| Provenance | 4 | Search in provenance. |
| Property | Type | Description |
|---|---|---|
| scope | enumeration KnowledgeGraphSearchFilterScope | The scope of search. |
| typeNames | [string] | The name of types to be included in search filter. |
Represents a Spatial Knowledge Graph Data Loading Property used for entities. This class is expected to be used only when the Type of property is esriFieldTypeGeometry.
| Property | Type | Description |
|---|---|---|
| name | string | The name of the property. |
| propertyType | enumeration esriFieldType | The type of the property. |
| value | KnowledgeGraphPropertyValue | The value which is to be imported. Value will have to be tested for type in order to properly perform the import. |
| merge | boolean | A value indicating whether this property should be used to determine a merge. |
| Property | Type | Description |
|---|---|---|
| spatialReference | SpatialReference | The spatial reference of the property. |
| geometryType | enumeration esriGeometryType | The geometry type of the property. Currently, only allowed values: - esriGeometryPoint - esriGeometryMultipoint - esriGeometryPolyline - esriGeometryPolygon Others will be allowed in future. |
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|---|---|
| workspaceConnectionString | string | The workspace connection string. |
| workspaceFactory | enumeration WorkspaceFactory | The workspace factory. |
| customWorkspaceFactoryCLSID | string | The classID of the custom workspace factory. |
| dataset | string | The dataset name. |
| datasetType | enumeration esriDatasetType | The dataset type. |
| Property | Type | Description |
|---|---|---|
| definitionQuery | string | The OpenCypher definition query. |
| Property | Type | Description |
|---|---|---|
| inclusionSetURI | string | The URI of the binary reference containing the InclusionSet for the table. |
| Property | Type | Description |
|---|---|---|
| timeDirection | enumeration LinkChartLayoutDirection | The time axis direction. |
| timeBannerUTCOffsetInMinutes | long | The UTC offset of the time banner, in minutes. |
| eventsTicksVisualization | enumeration EventsTicksVisualization | The event ticks visualization option. Event ticks are displayed in the time banner. |
| showDurationLineForNonZeroDurationEntityEvents | boolean | A value indicating whether lines representing the duration of events with non-zero durations are shown. |
| durationLineWidth | long | A value indicating the width of the line, in points, representing the duration of an event with non-zero duration. |
| entityPositionAtDurationRatio | double | A value indicating where the entity of a non-zero duration event will be placed. 0.0 represents the start of the duration interval, 1.0 represents the end of the duration interval. Used in multi-timeline layout only. |
| showNonZeroDurationIntervalBounds | boolean | A value indicating whether duration interval bounds are represented in relationship lines of events that have non-zero durations. Used in multi-timeline layout only. |
| separateTimeOverlaps | boolean | A value indicating whether events that overlap in time are separated. |
| separateTimelineOverlaps | boolean | A value indicating whether events that overlap on a timeline are separated. |
| moveFirstBends | boolean | A value indicating whether the first bend on a relationship line related to an event is moved higher up from the event location when some events are separated. Used only in the mono-timeline layout, when 'SeparateTimelineOverlaps' is true. |
| secondBendRatio | double | The ratio at which the second bend or a relationship occurs, for event relationships and non-event relationships between events and non-event entities. Used only in the mono-timeline layout. |
| lineSeparationMultiplier | double | The multiplier used for line separation. Lines will be more separated with a higher multiplier. |
| spaceSeparatedLinesEvenly | boolean | A value indicating whether separated lines are spaced evenly. When true, the offset for the i-th overlapping line is proportional to 'i'. When false, the offset for the i-th overlapping line is proportional to 'squareRoot(i)'. |
| useBezierCurves | boolean | A value indicating whether to use Bezier curves to represent separated lines. |
| separatedLineShapeRatio | double | The separated line shape ratio. When the ratio is high, the angle between the extremities of the separated line geometry and the original line is small. |
| Property | Type | Description |
|---|---|---|
| algorithm | enumeration KnowledgeLinkChartLayoutAlgorithm | The layout algorithm. |
| organicLayoutSettings | CIMKnowledgeLinkChartOrganicLayoutSettings | The organic layout settings. |
| chronologicalLayoutSettings | CIMKnowledgeLinkChartChronologicalLayoutSettings | The chronological layout settings. |
| autoApply | boolean | A value indicating whether the layout is automatically redone when a setting value changes. |
| preserveExtent | boolean | A value indicating whether the current Link Chart extent is preserved by the layout (only applies to Chronological and Geographical layouts). |
| Property | Value | Description |
|---|---|---|
| Organic_Standard | 0 | Organic Standard. |
| Organic_LeafCircle | 1 | Organic Leaf Circle. |
| Organic_Fusiform | 2 | Organic Fusiform. |
| Organic_Community | 3 | Organic Community. |
| Geographic_Organic_Standard | 4 | A Geographic layout that positions entities geographically using their geometry. Spatial entities that have a null geometry and non-spatial entities are arranged using the Organic Standard layout. |
| Basic_Grid | 5 | Basic Grid. |
| Tree_LeftToRight | 6 | Tree Left To Right. |
| Tree_RightToLeft | 7 | Tree Right To Left. |
| Tree_TopToBottom | 8 | Tree Top To Bottom. |
| Tree_BottomToTop | 9 | Tree Bottom To Top. |
| Radial_RootCentric | 10 | Radial Root Centric. |
| Radial_NodeCentric | 11 | Radial Node Centric. |
| Hierarchical_TopToBottom | 12 | Hierarchical Top To Bottom. |
| Hierarchical_BottomToTop | 13 | Hierarchical Bottom To Top. |
| Chronological_MonoTimeline | 14 | Chronological Mono-Timeline. |
| Chronological_MultiTimeline | 15 | Chronological Multi-Timeline. |
| Property | Type | Description |
|---|---|---|
| computationTimeBudget | double | The computation time budget, in seconds. The maximum count of iterations of the force directed algorithm is computed based on the size of the link chart and this computation budget, assuming computations are executed by a theoretical CPU with some known characteristics. Higher values lead to better looking layouts. |
| absoluteIdealEdgeLength | double | The value, in degrees, to use for the ideal edge length during layout calculations when the IdealEdgeLengthType is 'absoluteValue'. Only used for geographic layouts. |
| multiplicativeIdealEdgeLength | double | The value used to multiply the default edge length to determine the ideal edge length during layout calculations, when the IdealEdgeLengthType is 'multiplier'. Only used for geographic layouts. |
| idealEdgeLengthType | enumeration LinkChartLayoutIdealEdgeLengthType | The ideal edge length type which determines which property to use to compute the ideal edge length. Only used for geographic layouts. When the value is 'AbsoluteValue', the 'AbsoluteIdealEdgeLength' property is used. When the value is 'Multiplier', the 'MultiplicativeIdealEdgeLength' property is used. |
| autoComputeRepulsionRadius | boolean | A value indicating whether the repulsion radius is automatically computed or if it is computed according to 'RepulsionRadiusMultiplier'. |
| repulsionRadiusMultiplier | double | The value to be used for the repulsion radius multiplier. The repulsion radius is computed as the repulsion radius multiplier multiplied by the actual ideal edge length. Only used when 'AutoComputeRepulsionRadius' is false. |
| Property | Type | Description |
|---|---|---|
| mode | enumeration KnowledgeNonspatialDataDisplayMode | The display mode. |
| Property | Value | Description |
|---|---|---|
| Visible | 0 | Visible. |
| Hidden | 1 | Hidden. |
| Property | Type | Description |
|---|---|---|
| name | string | The name. |
| URI | string | The URI of the definition. Typically set by the system and used as an identifier. |
| sourceURI | string | The source URI of the item. Set if sourced from an external item such as an item on a portal. |
| sourceModifiedTime | TimeInstant | The time the source was last modified, as of the last sync. Used to detect when another sync is needed. |
| metadataURI | string | The metadata URI. |
| useSourceMetadata | boolean | A value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project. |
| sourcePortalUrl | string | The source portal URI of the item. Set if sourced from an external item such as an item on a portal. |
| Property | Type | Description |
|---|---|---|
| attribution | string | The attribution text that appears on a map that draws this layer. |
| description | string | The description. |
| layerElevation | CIMLayerElevationSurface | The layer elevation. |
| expanded | boolean | A value indicating whether this layer is expanded in the contents pane. |
| layer3DProperties | CIM3DLayerProperties | The 3D layer properties. |
| layerMasks | [string] | The URIs of the layers used as masks. |
| layerType | enumeration MapLayerType | The map layer type. |
| maxScale | double | The maximum scale for layer draw (set as the denominator of the scale's representative fraction). |
| minScale | double | The minimum scale for layer draw (set as the denominator of the scale's representative fraction). |
| layerScaleVisibilityOptions | CIMLayerScaleVisibilityOptions | The layer's scale visibility options. |
| showLegends | boolean | A value indicating whether or not to show legends. |
| transparency | double | The transparency of the layer. |
| visibility | boolean | A value indicating whether or not this layer is visible. |
| displayCacheType | enumeration DisplayCacheType | The display cache type. |
| maxDisplayCacheAge | double | The maximum display cache age. |
| layerTemplate | CIMLayerTemplate | The layer template. |
| popupInfo | CIMPopupInfo | The pop-up info. |
| showPopups | boolean | A value indicating whether or not to show pop-ups. |
| serviceLayerID | long | Identifier that will be used to identify the layer in server. |
| charts | [CIMChart] | Identifier the layer's charts. |
| searchable | boolean | A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search. |
| refreshRate | double | The amount of time to wait between refreshing the layer. |
| refreshRateUnit | enumeration esriTimeUnits | The units for the amount of time to wait between refreshing the layer. |
| showMapTips | boolean | A value indicating whether or not the display value is shown when hovering over a layer in the view. |
| customProperties | [CIMStringMap] | The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content. |
| webMapLayerID | string | An identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map. |
| blendingMode | enumeration BlendingMode | The blending mode for the layer. |
| allowDrapingOnIntegratedMesh | boolean | A value indicating whether layer can be draped on integrated mesh. |
| rasterizeOnExport | boolean | A value indicating whether layer should be rasterized when exporting. |
| useVisibilityTimeExtent | boolean | A value indicating whether or not to use the visibility time extent. When true the map time must overlap the visibility time extent for the layer to be visible. |
| visibilityTimeExtent | TimeExtent | The visibility time extent. |
| enableLayerEffects | boolean | A value indicating whether to enable any type of effects on the layer. |
| layerEffects | [CIMLayerEffect] | The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect. |
| Property | Type | Description |
|---|---|---|
| autoGenerateFeatureTemplates | boolean | A value indicating whether to automatically generate feature templates from the renderer. |
| extrusion | CIMFeatureExtrusion | The feature extrusion. |
| featureElevationExpression | string | The feature elevation expression. |
| featureTable | CIMFeatureTable | The feature table. |
| featureTemplates | [CIMEditingTemplate] | The feature templates. |
| htmlPopupEnabled | boolean | A value indicating whether HTML pop-ups are enabled. |
| htmlPopupFormat | CIMHtmlPopupFormat | The HTML pop-ups format. |
| isFlattened | boolean | A value indicating whether the layer is flattened. |
| selectable | boolean | A value indicating whether the layer is selectable. |
| selectionColor | Color | The selection color. For polygons, this is used as the outline color. |
| polygonSelectionFillColor | Color | The selection fill color. Only used for polygons. |
| selectionSymbol | CIMSymbolReference | The selection symbol. |
| useSelectionSymbol | boolean | A value indicating whether to use the selection symbol. |
| pageDefinition | CIMPageDefinition | The page definition which allows for using current map series page to filter features. |
| featureCacheType | enumeration FeatureCacheType | The feature cache type. |
| enableDisplayFilters | boolean | A value indicating whether the current set of display filters are honored during drawing. |
| displayFilters | [CIMDisplayFilter] | The current set of scale based display filters. |
| displayFiltersType | enumeration DisplayFilterType | DisplayFiltersType value. |
| displayFilterName | string | The active display filter. |
| displayFilterChoices | [CIMDisplayFilter] | The current set of display filters. |
| featureElevationExpressionInfo | CIMExpressionInfo | The expression for setting the feature elevation. |
| featureBlendingMode | enumeration BlendingMode | The per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn. |
| featureSortInfos | [CIMFeatureSortInfo] | The collection of field names and sort directions used to sort features during draw. |
| layerEffectsMode | enumeration LayerEffectsMode | The layer effects mode. |
| featureEffects | CIMFeatureLayerEffect | The collection of layer effects that apply to subset of features. |
| Property | Type | Description |
|---|---|---|
| actions | [CIMLayerAction] | The layer actions. |
| exclusionSet | [long long] | The set of excluded features. |
| featureMasks | [CIMDataConnection] | The data connection of the masking data. |
| labelClasses | [CIMLabelClass] | The collection of label class definitions. |
| labelVisibility | boolean | A value indicating whether to display labels for this layer's label classes. |
| maskedSymbolLayers | [CIMSymbolLayerMasking] | The masked symbol layers. Each SymbolLayerMasking gives the symbol layers that are masked by that masking layer. |
| renderer | Renderer | The primary symbol renderer. |
| scaleSymbols | boolean | A value indicating whether to scale the symbols in this layer based on the map's reference scale. |
| snappable | boolean | A value indicating whether this layer participates in snapping in the editor. |
| symbolLayerDrawing | CIMSymbolLayerDrawing | The symbol layer drawing properties. |
| trackLinesRenderer | Renderer | The track renderer when displaying tracks. |
| previousObservationsRenderer | Renderer | The previous observations renderer. |
| previousObservationsCount | long | The previous observation count. |
| useRealWorldSymbolSizes | boolean | A value indicating whether to use real world symbols sizes (meters) vs. points. This value should always be in sync with the UseRealWorldSymbolSizes property at the symbol level. |
| showPreviousObservations | boolean | A value indicating whether previous observations are being drawn. |
| featureReduction | FeatureReduction | The feature reduction technique in use by this layer. |
| showTracks | boolean | A value indicating whether track lines are being drawn. |
| Property | Type | Description |
|---|---|---|
| aggregationLayerURI | string | The layer URI of the aggregation layer. |
| Property | Value | Description |
|---|---|---|
| Top | 0 | Top |
| Bottom | 1 | Bottom |
| Left | 2 | Left |
| Right | 3 | Right |
| Property | Value | Description |
|---|---|---|
| AbsoluteValue | 0 | The ideal edge length is specified as an absolute value. |
| Multiplier | 1 | The ideal edge length is the computed ideal edge length multiplied by a value. |
| Property | Value | Description |
|---|---|---|
| Exclude | 0 | Query behaves as if there were no Provenance records in the graph, nor Provenance Entity Type defined in the data model. |
| Include | 1 | Query can reference the Provenance Entity Type. The result set may return provenance records. |