Lattix API#
The Lattix API will allow you access the features of Lattix external from the Lattix application.
- You will get access the following (not a complete list)
Load, save, create, and update Lattix Projects.
Query dependencies, metrics, rules, and violations in a project.
Create and delete subsystems, rules in a project.
Available apis:
- Java Lattix API
- Lattix Python API
- Python API Reference
- Module: pyliblattix
IteratorAtomBasicCollectionAtomKindAtomKind.has_behavior()AtomKind.memberAtomKind.supports_dependencies()AtomKind.supports_members()AtomKind.get_atom_property_definition()AtomKind.get_property_definition()AtomKind.flagsAtomKind.image_nameAtomKind.module_idAtomKind.nameAtomKind.res_nameAtomKind.behavior_iterator()AtomKind.property_definition_iterator()
MetricMetricsDataMetricsData.get_metric()MetricsData.get_metric2()MetricsData.get_metric3()MetricsData.custom_metricsMetricsData.hidden_metricsMetricsData.notify()MetricsData.notify_all()MetricsData.wait()MetricsData.to_string()MetricsData.all_metrics_iteratorMetricsData.metrics_iteratorMetricsData.hash_code()MetricsData.get_global_metric()MetricsData.add_global_metric()MetricsData.set_global_metrics_data()MetricsData.add_to_all_metrics()MetricsData.build_all_metrics()MetricsData.cleanup()MetricsData.dispose()MetricsData.dump_metrics()
AtomCollectionAtomSetDsmOrderingAlgorithmDependModuleDependencyKindGraphCyclesDependencyBehaviorDependencyBehavior.maskDependencyBehavior.hash_code()DependencyBehavior.ordinal()DependencyBehavior.name_resDependencyBehavior.name()DependencyBehavior.notify()DependencyBehavior.notify_all()DependencyBehavior.wait()DependencyBehavior.to_string()DependencyBehavior.value_of()DependencyBehavior.behavor_string_to_flags()DependencyBehavior.get_behavior_string()
AtomBehaviorAtomBehavior.maskAtomBehavior.hash_code()AtomBehavior.ordinal()AtomBehavior.name_resAtomBehavior.name()AtomBehavior.notify()AtomBehavior.notify_all()AtomBehavior.wait()AtomBehavior.to_string()AtomBehavior.has_member_behavior()AtomBehavior.is_member_behavior()AtomBehavior.value_of()AtomBehavior.behavor_string_to_flags()
PartitionEdgePathPartitionEdgePathCollectionMetricGroupMetricGroup.do_calc_as_group()MetricGroup.disable_hierarchyMetricGroup.hiddenMetricGroup.get_metric()MetricGroup.remove_metric()MetricGroup.descriptionMetricGroup.notify()MetricGroup.notify_all()MetricGroup.wait()MetricGroup.idMetricGroup.res_nameMetricGroup.to_string()MetricGroup.metric_iterator()MetricGroup.hash_code()MetricGroup.get_atom_kind_count_iterator()MetricGroup.add_metric()MetricGroup.remove_all()MetricGroup.set_disable_hierarchy()
AtomKindCountAtomKindCount.disable_hierarchy()AtomKindCount.percentAtomKindCount.segment_map_indexAtomKindCount.idAtomKindCount.image_nameAtomKindCount.nameAtomKindCount.notify()AtomKindCount.notify_all()AtomKindCount.set_segment_map_index()AtomKindCount.wait()AtomKindCount.decimal_precisionAtomKindCount.hash_code()AtomKindCount.atom_kind_res_nameAtomKindCount.module_idAtomKindCount.get_description()AtomKindCount.format_stringAtomKindCount.format_string_resAtomKindCount.to_string()AtomKindCount.build_id()AtomKindCount.create_count_resource()AtomKindCount.get_icon_base64()
CriteriaDependencyFilterRuleSetWorkItemWorkItem.has_child_work_items()WorkItem.parent_work_itemWorkItem.priorityWorkItem.key_indexWorkItem.key_map_indexWorkItem.default_descriptionWorkItem.descriptionWorkItem.idWorkItem.nameWorkItem.ownerWorkItem.plain_text_descriptionWorkItem.titleWorkItem.typeWorkItem.child_work_items()WorkItem.set_key_index()WorkItem.set_key_map_index()
WorkItemCollectionRuleViolatorDependencyBasicDependencyCollectionRuleRule.cannot_useRule.defaultRule.exceptionRule.must_useRule.rule_setRule.rule_sourceRule.rule_typeRule.target_typeRule.clear_text_descriptionRule.dependency_filter_stringRule.descriptionRule.display_nameRule.nameRule.source_atom_filter_stringRule.target_atom_filter_stringRule.target_name
RuleSourceRuleTypePartitionPartition.atom_partitionPartition.leafPartition.referencePartition.references_atom()Partition.atomPartition.atom_setPartition.containerPartition.partition_referencePartition.parent_rule_sourcePartition.levelPartition.segment_map_indexPartition.clear_text_descriptionPartition.descriptionPartition.display_namePartition.namePartition.short_display_namePartition.x_m_l_partition_typePartition.atom_iterator()Partition.property_name_iterator()Partition.set_segment_map_index()
PartitionCollectionPartitionCollectionCollectionPartitionSetPartitionRelationPartitionRelationCollectionRuleViolatorCollectionRuleViolatorSetDependencyEdgeDependencyEdgeCollectionAtomPropertyDefinitionAtomPropertyDefinition.has_behavior()AtomPropertyDefinition.long_precisionAtomPropertyDefinition.clone()AtomPropertyDefinition.decimal_precisionAtomPropertyDefinition.flagAtomPropertyDefinition.typeAtomPropertyDefinition.format_string_resAtomPropertyDefinition.module_idAtomPropertyDefinition.nameAtomPropertyDefinition.res_nameAtomPropertyDefinition.behavior_iterator()
PropertyBehaviorPropertyBehavior.maskPropertyBehavior.hash_code()PropertyBehavior.ordinal()PropertyBehavior.name_resPropertyBehavior.name()PropertyBehavior.notify()PropertyBehavior.notify_all()PropertyBehavior.wait()PropertyBehavior.to_string()PropertyBehavior.value_of()PropertyBehavior.behavor_string_to_flags()
TagTagCollectionTagManagerNumberColorProjectModelProjectModel.contains_atom()ProjectModel.has_ancestor()ProjectModel.has_ancestor2()ProjectModel.has_collapsed_members()ProjectModel.has_expanded_members()ProjectModel.is_dependency_edge_hidden()ProjectModel.is_dependency_edge_hidden2()ProjectModel.disposedProjectModel.is_partition_hidden()ProjectModel.is_partition_tagged()ProjectModel.read_onlyProjectModel.is_top_level_atom_partition()ProjectModel.validProjectModel.new_search_criteria_builder()ProjectModel.get_manual_atom()ProjectModel.new_manual_atom()ProjectModel.get_atom()ProjectModel.get_atom2()ProjectModel.get_atom_at()ProjectModel.get_main_ancestor_atom()ProjectModel.get_parent_atom()ProjectModel.get_source_atom_for()ProjectModel.get_target_atom_for()ProjectModel.get_target_atom_for2()ProjectModel.get_all_atoms()ProjectModel.get_atoms_at()ProjectModel.partitions_to_atoms()ProjectModel.get_atom_kind()ProjectModel.new_atom_set()ProjectModel.get_dependencies()ProjectModel.get_depend_module()ProjectModel.new_manual_dependency()ProjectModel.new_dependency_edge()ProjectModel.get_edges()ProjectModel.get_edges2()ProjectModel.get_edges3()ProjectModel.get_edges_between()ProjectModel.get_edges_from()ProjectModel.get_edges_from_work_item()ProjectModel.get_external_edges()ProjectModel.get_used_by_edges()ProjectModel.get_used_by_edges2()ProjectModel.get_used_by_edges3()ProjectModel.get_uses_edges()ProjectModel.get_uses_edges2()ProjectModel.get_dependency_kind()ProjectModel.get_ordering_algorithm()ProjectModel.get_metric_definition()ProjectModel.new_partition()ProjectModel.new_partition_with_atom()ProjectModel.get_child_partition_by_name()ProjectModel.get_display_sub_partition()ProjectModel.get_partition()ProjectModel.get_partition2()ProjectModel.root_partitionProjectModel.get_sub_partition()ProjectModel.atoms_to_partitions()ProjectModel.get_all_partitions()ProjectModel.get_all_partitions2()ProjectModel.get_descendant_atom_partitions()ProjectModel.get_partitions_by_name()ProjectModel.get_sub_partitions()ProjectModel.get_tagged_partitions()ProjectModel.get_cycle_components()ProjectModel.get_low_level_cycle_components()ProjectModel.new_partition_set()ProjectModel.new_partition_set2()ProjectModel.new_sorted_partition_set()ProjectModel.new_sorted_partition_set2()ProjectModel.new_rule()ProjectModel.new_rule2()ProjectModel.new_rule3()ProjectModel.get_partition_rules()ProjectModel.get_rule_violators()ProjectModel.get_rule_violators2()ProjectModel.get_rule_violators3()ProjectModel.get_rule_violators_from_work_item()ProjectModel.new_rule_violator_set()ProjectModel.applied_rulesProjectModel.create_or_find_tag()ProjectModel.new_impact_tag()ProjectModel.new_impact_tag2()ProjectModel.new_tag()ProjectModel.get_tag()ProjectModel.all_tagsProjectModel.get_direct_tags_for()ProjectModel.get_sub_tags()ProjectModel.get_tags_for()ProjectModel.display_modelProjectModel.create_work_item()ProjectModel.create_work_item2()ProjectModel.create_work_item3()ProjectModel.create_work_item4()ProjectModel.work_itemsProjectModel.inc_ref()ProjectModel.get_dependency_strength()ProjectModel.get_impact_strength()ProjectModel.get_partition_index()ProjectModel.get_sub_partition_count()ProjectModel.instanceProjectModel.get_metric_value()ProjectModel.get_atom_kind_resource_name()ProjectModel.get_atom_property_value()ProjectModel.get_dependency_kind_resource_name()ProjectModel.get_full_source_name()ProjectModel.get_partition_description()ProjectModel.get_partition_name_path()ProjectModel.project_nameProjectModel.get_smart_name()ProjectModel.all_high_level_cyclesProjectModel.all_metric_definitionsProjectModel.get_all_partition_iterator()ProjectModel.get_atom_partition_iterator()ProjectModel.atoms_from_databaseProjectModel.get_descendent_rules_for()ProjectModel.get_inherited_rules_for()ProjectModel.get_module_atom_kinds()ProjectModel.get_module_dependency_kinds()ProjectModel.module_idsProjectModel.ordering_algorithmsProjectModel.project_atom_kindsProjectModel.project_dependency_kindsProjectModel.get_rules_for()ProjectModel.get_tags_for2()ProjectModel.get_used_by_edges_closure()ProjectModel.get_uses_edges_closure()ProjectModel.partition_property_name_iterator()ProjectModel.sub_partition_display_iterator()ProjectModel.sub_partition_iterator()ProjectModel.visible_sub_partition_iterator()ProjectModel.add_atom_to_partition()ProjectModel.add_partition_to_tag()ProjectModel.add_partitions_to_tag()ProjectModel.change_atom_kind()ProjectModel.clear_partition_property()ProjectModel.clear_tag_filter()ProjectModel.collapse_members()ProjectModel.delete_partition()ProjectModel.delete_partition_tree()ProjectModel.delete_rule()ProjectModel.delete_tag()ProjectModel.expand_members()ProjectModel.hide_dependencies()ProjectModel.hide_partition()ProjectModel.import_file_as_manual()ProjectModel.import_l_d_ias_module()ProjectModel.move_partition()ProjectModel.move_partition_to()ProjectModel.perform_ordering()ProjectModel.remove_atom_from_partition()ProjectModel.remove_dependency_edge()ProjectModel.remove_dependency_edge2()ProjectModel.remove_partitions_from_tag()ProjectModel.rename_partition()ProjectModel.set_cell_text()ProjectModel.set_cell_text2()ProjectModel.set_partition_description()ProjectModel.set_tag_color()ProjectModel.set_tag_criteria()ProjectModel.set_tag_edges()ProjectModel.set_tag_filter()ProjectModel.set_tag_partitions()ProjectModel.set_work_item_description()ProjectModel.set_work_item_name()ProjectModel.set_work_item_owner()ProjectModel.unhide_dependencies()ProjectModel.unhide_partition()ProjectModel.check_canceled()ProjectModel.dispose()ProjectModel.get_metrics_data_from_project_model()ProjectModel.empty_partition_collection()ProjectModel.create_or_find_tag2()ProjectModel.create_or_find_tag_default_color()ProjectModel.create_or_find_tag_red()ProjectModel.get_display_model2()ProjectModel.get_resource_manager()ProjectModel.color_from_str()ProjectModel.get_atom_kind_icon_base64()ProjectModel.get_dependency_kind_resource_name2()ProjectModel.get_dsm_js_data()ProjectModel.get_full_source_name2()ProjectModel.get_name_alt()ProjectModel.get_string_atom_property()ProjectModel.get_all_tags2()ProjectModel.get_atom_property_names()ProjectModel.get_int_edge_propertys()ProjectModel.save_project()ProjectModel.save_project_as()
LattixPythonApiFileFile.can_execute()File.can_read()File.can_write()File.create_new_file()File.exists()File.absoluteFile.directoryFile.fileFile.hiddenFile.mkdir()File.mkdirs()File.rename_to()File.set_executable()File.set_executable2()File.set_read_only()File.set_readable()File.set_readable2()File.set_writable()File.set_writable2()File.notify()File.notify_all()File.wait()File.compare_to()File.hash_code()File.absolute_fileFile.canonical_fileFile.parent_fileFile.absolute_pathFile.canonical_pathFile.nameFile.parentFile.pathFile.to_string()File.create_temp_file()File.create_temp_file2()File.delete_on_exit()
ResourceManagerSearchCriteriaBuilderSearchCriteriaBuilder.atom_kind_filter_builder()SearchCriteriaBuilder.case_sensitive()SearchCriteriaBuilder.reg_exSearchCriteriaBuilder.partitions_with_atoms()SearchCriteriaBuilder.partitions_without_atoms()SearchCriteriaBuilder.text()SearchCriteriaBuilder.build()SearchCriteriaBuilder.notify()SearchCriteriaBuilder.notify_all()SearchCriteriaBuilder.wait()SearchCriteriaBuilder.to_string()SearchCriteriaBuilder.hash_code()
AtomKindFilterBuilderSearchCriteriaPartitionStatePartitionState.contains_top_level_atom_sub_partitions()PartitionState.depends()PartitionState.has_ancestor()PartitionState.is_container_partition()PartitionState.is_dependency_hidden()PartitionState.can_shuffle_display()PartitionState.has_dependencies()PartitionState.has_hidden_dependencies()PartitionState.has_hidden_partitions()PartitionState.hide_partition()PartitionState.hide_partitions()PartitionState.fast_cachePartitionState.shuffle_display()PartitionState.unhide_partition()PartitionState.has_tag()PartitionState.is_top_level_classification()PartitionState.a()PartitionState.a2()PartitionState.a4()PartitionState.a5()PartitionState.a6()PartitionState.a7()PartitionState.a8()PartitionState.b()PartitionState.b2()PartitionState.b3()PartitionState.c()PartitionState.c2()PartitionState.g()PartitionState.h()PartitionState.is_high_level_partition()PartitionState.is_low_level_partition()PartitionState.is_member_atom_partition()PartitionState.mirroredPartitionState.is_top_level_atom_partition()PartitionState.o()PartitionState.passes_filter()PartitionState.supports_abstract_atoms()PartitionState.u()PartitionState.u2()PartitionState.v()PartitionState.w()PartitionState.y()PartitionState.z()PartitionState.get_top_level_atoms()PartitionState.types_map()PartitionState.get_local_atoms()PartitionState.get_tagged_atoms()PartitionState.get_edges()PartitionState.get_edges2()PartitionState.b4()PartitionState.get_edges3()PartitionState.get_edges4()PartitionState.get_edges5()PartitionState.get_edges6()PartitionState.get_external_edges()PartitionState.dependency_filterPartitionState.get_metric_threshold_state()PartitionState.get_atom_part()PartitionState.get_atom_part_no_ref()PartitionState.get_display_sub_partition()PartitionState.root_partitionPartitionState.get_top_partition()PartitionState.get_top_partition2()PartitionState.get_sub_partition()PartitionState.get_atom_part2()PartitionState.get_atom_part_no_ref2()PartitionState.get_main_partition()PartitionState.get_parent_toplevel_part()PartitionState.get_partition()PartitionState.get_partition_reference()PartitionState.get_all_sub_partitions()PartitionState.get_all_tagged_partitions()PartitionState.get_tag_partition_set()PartitionState.atoms_to_partitions()PartitionState.usedby_set()PartitionState.a12()PartitionState.a13()PartitionState.a14()PartitionState.b5()PartitionState.c3()PartitionState.c5()PartitionState.d2()PartitionState.get_all_sub_partitions2()PartitionState.hidden_partitionsPartitionState.default_rule_setPartitionState.b6()PartitionState.get_rule_violators()PartitionState.rule_violators2PartitionState.get_rule_violators3()PartitionState.get_rule_violators_with_lookup()PartitionState.c6()PartitionState.f2()PartitionState.n()PartitionState.get_tag()PartitionState.get_tag2()PartitionState.get_top_level_classification()PartitionState.a15()PartitionState.q()PartitionState.tag_managerPartitionState.dependency_cache_numPartitionState.get_dependency_strength()PartitionState.dirty_numPartitionState.get_level()PartitionState.order_cache_numPartitionState.partition_cache_numPartitionState.get_partition_property_cache_num()PartitionState.rules_cache_numPartitionState.get_sibling_index()PartitionState.tag_cache_numPartitionState.work_list_cache_numPartitionState.modification_numPartitionState.partition_filter_cache_numPartitionState.get_row_count()PartitionState.get_sub_partition_count()PartitionState.get_top_level_atom_count()PartitionState.rules_cache_num2PartitionState.tag_countPartitionState.get_display_sibling_index()PartitionState.get_display_sub_partition_index()PartitionState.get_sub_partition_index()PartitionState.get_top_level_atom_count2()PartitionState.n2()PartitionState.p()PartitionState.q2()PartitionState.get_partition_reference_id()PartitionState.selected_tagPartitionState.get_tag_name_from_index()PartitionState.all_partition_iterator()PartitionState.all_partition_iterator2()PartitionState.atom_partition_iterator()PartitionState.display_sub_partition_iterator()PartitionState.display_sub_partition_iterator_reverse()PartitionState.get_aggregate_dependency_atom_iterator()PartitionState.all_intersect_infoPartitionState.get_partition_usage_iterator()PartitionState.get_partition_usage_iterator2()PartitionState.hidden_dependencies()PartitionState.sub_partitions()PartitionState.sub_partitions_reversed()PartitionState.threshold_partition_iterator()PartitionState.atom_partition_iterator2()PartitionState.atom_partition_iterator3()PartitionState.atom_partition_no_refs_iterator()PartitionState.all_partition_metricsPartitionState.partition_metricsPartitionState.get_uses_partitions()PartitionState.top_level_atom_partition_iterator()PartitionState.get_local_partition_and_aggregated_member_level_partitions()PartitionState.a19()PartitionState.all_partition_iterator3()PartitionState.atom_partition_iterator4()PartitionState.b7()PartitionState.d4()PartitionState.e2()PartitionState.get_aggregate_uses_partitions()PartitionState.get_local_atoms_and_aggregated_member_level_atoms()PartitionState.get_target_atoms_for_local_partition()PartitionState.get_target_atoms_for_partition()PartitionState.main_atom_partition_iterator()PartitionState.s()PartitionState.sibling_partitions()PartitionState.x()PartitionState.clear_cache()PartitionState.clear_cache2()PartitionState.dispose()PartitionState.enable_partition_filter()PartitionState.set_auto_cache()PartitionState.set_disable_calculations()PartitionState.set_hidden_partitions()PartitionState.set_impact_invalid()PartitionState.set_selected_tag()PartitionState.sort_by_name()PartitionState.update_tags()PartitionState.validate_cache()PartitionState.d5()PartitionState.e3()PartitionState.h2()PartitionState.i2()
MetricThresholdStateMetricThresholdState.has_value()MetricThresholdState.needs_update()MetricThresholdState.partitionMetricThresholdState.notify()MetricThresholdState.notify_all()MetricThresholdState.wait()MetricThresholdState.idMetricThresholdState.to_string()MetricThresholdState.hash_code()MetricThresholdState.calc()MetricThresholdState.calc2()
IntersectInfoPartitionUsageDisplayModelWorkspaceViewWorkspaceContextWorkspaceContext.can_apply()WorkspaceContext.can_cancel()WorkspaceContext.can_confirm()WorkspaceContext.is_content_available()WorkspaceContext.mutableWorkspaceContext.property_managerWorkspaceContext.resource_managerWorkspaceContext.content_countWorkspaceContext.idWorkspaceContext.confirm_status_stringWorkspaceContext.get_content_name()WorkspaceContext.description_resWorkspaceContext.image_nameWorkspaceContext.ok_res_nameWorkspaceContext.property_name_prefixWorkspaceContext.title_resWorkspaceContext.dispose()WorkspaceContext.update()WorkspaceContext.cancel_changes()WorkspaceContext.invalidate()WorkspaceContext.revert_changes()WorkspaceContext.remove_all_content()
ContextModelPropertyManageracquire_lattix_api()
- Module: pyliblattix