excel-grapher
v0.5.1
User Guide
Reference
Changelog
API
/
grapher.validate_graph()
API Index
Public Modules
exporter.GoogleSeriesDocstringRenderer
exporter.NumpySeriesDocstringRenderer
exporter.PlainSeriesDocstringRenderer
exporter.RstSeriesDocstringRenderer
exporter.CodeGenerator
exporter.IdentityTransitCompression
exporter.FieldDoc
exporter.SeriesBindingDocstringContext
exporter.SeriesBindingDocstringContract
exporter.SeriesFunctionDoc
exporter.BaseProjectionManifest
exporter.CollapsedGroup
exporter.CompositeProjectionManifest
exporter.FormulaRewrite
exporter.ProjectedNodeSnapshot
exporter.ProjectionResult
exporter.SeriesDocstringRenderCallable
exporter.SeriesDocstringRenderer
exporter.SeriesBindingDocstringCallback
exporter.ProjectionManifest
exporter.ProjectionStep
exporter.WebVizLayoutPlugin
exporter.resolve_series_docstring_renderer()
exporter.list_series_docstring_callbacks()
exporter.register_series_docstring_callback()
exporter.resolve_series_docstring_callback()
exporter.unregister_series_docstring_callback()
exporter.to_web_viz_payload()
exporter.apply_projection()
exporter.build_forwarding_projection_manifest()
exporter.register_projection_manifest()
exporter.resolve_projection_manifest()
exporter.unregister_projection_manifest()
exporter.list_web_viz_layouts()
exporter.register_web_viz_layout()
exporter.resolve_web_viz_layout()
exporter.unregister_web_viz_layout()
exporter.SeriesDocstringRendererName
exporter.SeriesDocstringRendererSpec
exporter.SeriesBindingDocstringCallbackSpec
exporter.WebVizPayload
exporter.LAYOUT_FORCEATLAS2
exporter.LAYOUT_GRAPHVIZ_DOT
exporter.LAYOUT_GRAPHVIZ_SFDP
exporter.LAYOUT_MULTIPARTITE
exporter.LAYOUT_SPRING
exporter.LAYOUT_STRATIFIED_MULTIPARTITE
exporter.WebVizLayoutSpec
grapher.GreaterThanCell
grapher.NotEqualCell
grapher.RealBetween
grapher.RealIntervalDomain
grapher.EdgeProvenance
grapher.DynamicRefConfig
grapher.DynamicRefLimits
grapher.DynamicRefTraceEvent
grapher.FromWorkbook
grapher.LightweightVizLocalEdges
grapher.LightweightVizModule
grapher.LightweightVizModuleEdge
grapher.LightweightVizNodeColumns
grapher.LightweightVizPayload
grapher.LightweightVizStats
grapher.LocalForceSubgraph
grapher.CycleReport
grapher.DependencyGraph
grapher.And
grapher.Compare
grapher.GuardExpr
grapher.Literal
grapher.Not
grapher.Or
grapher.GuardCellRef
grapher.Node
grapher.WorkbookCalcSettings
grapher.GraphReadView
grapher.CacheValidationPolicy
grapher.DependencyCause
grapher.DynamicRefError
grapher.CycleError
grapher.ValidationResult
grapher.normalize_blank_range_specs()
grapher.create_dependency_graph()
grapher.list_dynamic_ref_constraint_candidates()
grapher.build_graph_cache_meta()
grapher.build_graph_cache_meta_portable()
grapher.save_graph_cache()
grapher.try_load_graph_cache()
grapher.infer_dynamic_index_targets()
grapher.infer_dynamic_indirect_targets()
grapher.infer_dynamic_offset_targets()
grapher.trace_dynamic_refs()
grapher.select_local_force_subgraph()
grapher.select_path_induced_subgraph()
grapher.to_graphviz()
grapher.to_mermaid()
grapher.to_networkx()
grapher.write_lightweight_viz_data()
grapher.write_lightweight_viz_html()
grapher.write_web_viz_html()
grapher.format_cell_key()
grapher.needs_quoting()
grapher.get_calc_settings()
grapher.validate_graph()
grapher.GRAPH_CACHE_SCHEMA_VERSION
grapher.DynamicRefTraceFn
grapher.NodeHook
grapher.NodeKey
grapher.format_key
series_bindings.GoogleSeriesDocstringRenderer
series_bindings.NumpySeriesDocstringRenderer
series_bindings.PlainSeriesDocstringRenderer
series_bindings.RstSeriesDocstringRenderer
series_bindings.ResolutionIssue
series_bindings.FieldDoc
series_bindings.SeriesBindingDocstringContext
series_bindings.SeriesBindingDocstringContract
series_bindings.SeriesFunctionDoc
series_bindings.SeriesDocstringRenderCallable
series_bindings.SeriesDocstringRenderer
series_bindings.SeriesBindingDocstringCallback
series_bindings.SeriesBindingsLoadError
series_bindings.SeriesBindingsSchemaError
series_bindings.InputSeries
series_bindings.InputSeriesCell
series_bindings.LeafResolution
series_bindings.OutputSeries
series_bindings.OutputSeriesCell
series_bindings.ResolutionReport
series_bindings.SeriesResolution
series_bindings.ValidationIssue
series_bindings.ValidationReport
series_bindings.WorkbookSeriesBindings
series_bindings.emit_series_bindings_block()
series_bindings.bindings_canonical_sha256()
series_bindings.emit_compute_function()
series_bindings.emit_computes_block()
series_bindings.generate_computes_module()
series_bindings.resolve_series_docstring_renderer()
series_bindings.list_series_docstring_callbacks()
series_bindings.register_series_docstring_callback()
series_bindings.resolve_series_docstring_callback()
series_bindings.unregister_series_docstring_callback()
series_bindings.derive_input_series()
series_bindings.load_series_bindings()
series_bindings.merge_series_binding_documents()
series_bindings.parse_bindings_file()
series_bindings.has_input_direction()
series_bindings.has_output_direction()
series_bindings.merge_series_entries()
series_bindings.normalize_bindings_document()
series_bindings.normalize_series_entry()
series_bindings.derive_output_series()
series_bindings.expand_data_range()
series_bindings.expand_data_range_for_graph()
series_bindings.resolve_series_binding()
series_bindings.resolve_series_bindings()
series_bindings.format_schema_errors()
series_bindings.validate_bindings_document()
series_bindings.emit_setter_function()
series_bindings.emit_setter_helpers()
series_bindings.emit_setters_block()
series_bindings.generate_setters_module()
series_bindings.validate_series_bindings()
series_bindings.is_bind_implemented()
series_bindings.is_layout_implemented()
series_bindings.SeriesDocstringRendererName
series_bindings.SeriesDocstringRendererSpec
series_bindings.SeriesBindingDocstringCallbackSpec
series_bindings.Record
series_bindings.Records
series_bindings.Scalar
series_bindings.ValidationLevel
series_bindings.IMPLEMENTED_BIND_KINDS
series_bindings.IMPLEMENTED_LAYOUTS
series_bindings.PLANNED_BIND_KINDS
series_bindings.PLANNED_LAYOUTS
series_bindings.SUPPORTED_SCHEMA_VERSIONS
Exporter API
exporter.CodeGenerator
exporter.IdentityTransitCompression
exporter.ProjectionStep
exporter.ProjectionResult
exporter.ProjectionManifest
exporter.BaseProjectionManifest
exporter.CompositeProjectionManifest
exporter.ProjectedNodeSnapshot
exporter.FormulaRewrite
exporter.CollapsedGroup
exporter.apply_projection()
exporter.build_forwarding_projection_manifest()
exporter.register_projection_manifest()
exporter.resolve_projection_manifest()
exporter.unregister_projection_manifest()
exporter.WebVizPayload
exporter.to_web_viz_payload()
exporter.LAYOUT_FORCEATLAS2
exporter.LAYOUT_GRAPHVIZ_DOT
exporter.LAYOUT_GRAPHVIZ_SFDP
exporter.LAYOUT_MULTIPARTITE
exporter.LAYOUT_SPRING
exporter.LAYOUT_STRATIFIED_MULTIPARTITE
exporter.WebVizLayoutPlugin
exporter.WebVizLayoutSpec
exporter.list_web_viz_layouts()
exporter.register_web_viz_layout()
exporter.resolve_web_viz_layout()
exporter.unregister_web_viz_layout()
exporter.FieldDoc
exporter.GoogleSeriesDocstringRenderer
exporter.NumpySeriesDocstringRenderer
exporter.PlainSeriesDocstringRenderer
exporter.RstSeriesDocstringRenderer
exporter.SeriesDocstringRenderCallable
exporter.SeriesDocstringRenderer
exporter.SeriesDocstringRendererName
exporter.SeriesDocstringRendererSpec
exporter.SeriesBindingDocstringCallback
exporter.SeriesBindingDocstringCallbackSpec
exporter.SeriesBindingDocstringContext
exporter.SeriesBindingDocstringContract
exporter.SeriesFunctionDoc
exporter.list_series_docstring_callbacks()
exporter.register_series_docstring_callback()
exporter.resolve_series_docstring_callback()
exporter.unregister_series_docstring_callback()
exporter.resolve_series_docstring_renderer()
Grapher Namespaced API
grapher.DependencyCause
grapher.EdgeProvenance
grapher.LightweightVizLocalEdges
grapher.LightweightVizModule
grapher.LightweightVizModuleEdge
grapher.LightweightVizNodeColumns
grapher.LightweightVizStats
grapher.GRAPH_CACHE_SCHEMA_VERSION
grapher.DynamicRefTraceFn
grapher.GraphReadView
grapher.NodeHook
grapher.NodeKey
grapher.infer_dynamic_index_targets()
grapher.infer_dynamic_indirect_targets()
grapher.infer_dynamic_offset_targets()
Series Bindings API
series_bindings.InputSeries
series_bindings.InputSeriesCell
series_bindings.OutputSeries
series_bindings.OutputSeriesCell
series_bindings.Record
series_bindings.Records
series_bindings.Scalar
series_bindings.FieldDoc
series_bindings.GoogleSeriesDocstringRenderer
series_bindings.NumpySeriesDocstringRenderer
series_bindings.PlainSeriesDocstringRenderer
series_bindings.RstSeriesDocstringRenderer
series_bindings.SeriesDocstringRenderCallable
series_bindings.SeriesDocstringRenderer
series_bindings.SeriesDocstringRendererName
series_bindings.SeriesDocstringRendererSpec
series_bindings.SeriesBindingDocstringCallback
series_bindings.SeriesBindingDocstringCallbackSpec
series_bindings.SeriesBindingDocstringContext
series_bindings.SeriesBindingDocstringContract
series_bindings.SeriesFunctionDoc
series_bindings.LeafResolution
series_bindings.ResolutionIssue
series_bindings.ResolutionReport
series_bindings.SeriesResolution
series_bindings.ValidationIssue
series_bindings.ValidationLevel
series_bindings.ValidationReport
series_bindings.WorkbookSeriesBindings
series_bindings.IMPLEMENTED_BIND_KINDS
series_bindings.IMPLEMENTED_LAYOUTS
series_bindings.PLANNED_BIND_KINDS
series_bindings.PLANNED_LAYOUTS
series_bindings.SUPPORTED_SCHEMA_VERSIONS
series_bindings.bindings_canonical_sha256()
series_bindings.derive_input_series()
series_bindings.derive_output_series()
series_bindings.emit_compute_function()
series_bindings.emit_computes_block()
series_bindings.emit_series_bindings_block()
series_bindings.emit_setter_function()
series_bindings.emit_setter_helpers()
series_bindings.emit_setters_block()
series_bindings.generate_computes_module()
series_bindings.generate_setters_module()
series_bindings.has_input_direction()
series_bindings.has_output_direction()
series_bindings.merge_series_entries()
series_bindings.normalize_bindings_document()
series_bindings.normalize_series_entry()
series_bindings.expand_data_range()
series_bindings.expand_data_range_for_graph()
series_bindings.format_schema_errors()
series_bindings.list_series_docstring_callbacks()
series_bindings.load_series_bindings()
series_bindings.merge_series_binding_documents()
series_bindings.parse_bindings_file()
series_bindings.register_series_docstring_callback()
series_bindings.resolve_series_docstring_callback()
series_bindings.unregister_series_docstring_callback()
series_bindings.resolve_series_binding()
series_bindings.resolve_series_bindings()
series_bindings.resolve_series_docstring_renderer()
series_bindings.validate_bindings_document()
series_bindings.validate_series_bindings()
series_bindings.is_bind_implemented()
series_bindings.is_layout_implemented()
Classes
CodeGenerator
ParseError
CodeGenerator Methods
CodeGenerator.__enter__()
CodeGenerator.__exit__()
CodeGenerator.derive_input_series()
CodeGenerator.classify_leaf_nodes()
CodeGenerator.generate()
CodeGenerator.generate_modules()
Dataclasses
And
Compare
CycleReport
DependencyGraph
DynamicRefConfig
DynamicRefLimits
DynamicRefTraceEvent
ExcelRange
FormulaEvaluator
FromWorkbook
GreaterThanCell
GuardCellRef
GuardExpr
LightweightVizPayload
Literal
LocalForceSubgraph
Node
Not
NotEqualCell
Or
RealBetween
RealIntervalDomain
WorkbookCalcSettings
DependencyGraph Methods
DependencyGraph.add_node()
DependencyGraph.__contains__()
DependencyGraph.__iter__()
DependencyGraph.__len__()
DependencyGraph.keys()
DependencyGraph.add_edge()
DependencyGraph.get_node()
DependencyGraph.get_dependencies()
DependencyGraph.get_dependents()
DependencyGraph.get_edge_attrs()
DependencyGraph.get_edge_guard()
DependencyGraph.set_node_value()
DependencyGraph.set_node_metadata()
DependencyGraph.register_hook()
DependencyGraph.leaves()
DependencyGraph.formula_nodes()
DependencyGraph.leaf_node_items()
DependencyGraph.formula_keys()
DependencyGraph.leaf_keys()
DependencyGraph.target_keys()
DependencyGraph.roots()
DependencyGraph.cycle_report()
DependencyGraph.evaluation_order()
DependencyGraph.compress_identity_transits()
DependencyGraph.__getstate__()
DependencyGraph.__setstate__()
Enumerations
CacheValidationPolicy
XlError
Exceptions
CycleError
DynamicRefError
SeriesBindingsLoadError
SeriesBindingsSchemaError
Named Tuples
ValidationResult
Typed Dicts
ValidationReport
Functions
bindings_canonical_sha256()
build_graph_cache_meta()
build_graph_cache_meta_portable()
create_dependency_graph()
format_cell_key()
get_calc_settings()
list_dynamic_ref_constraint_candidates()
load_series_bindings()
needs_quoting()
normalize_blank_range_specs()
resolve_series_bindings()
save_graph_cache()
select_local_force_subgraph()
select_path_induced_subgraph()
to_graphviz()
to_mermaid()
to_networkx()
to_web_viz_payload()
trace_dynamic_refs()
try_load_graph_cache()
validate_graph()
validate_series_bindings()
write_lightweight_viz_data()
write_lightweight_viz_html()
write_web_viz_html()
Constants
format_key
grapher.validate_graph()
Usage
Source
grapher
.
validate_graph
(
graph
,
workbook_path
,
*
,
scope
=
None
, )