malcolmjs
latest
Overview
Introduction
User Guide
Getting Started
Quick Start
User Interface Overview
Working With a Design
Monitoring Attribute Values
Understanding Attribute State
System Maintenance Guide
Architecture
Architecture Background
Architectural Decision Record
Sequence Diagrams
Setting up a Development Environment
Developer Workflow
Testing Strategy
Code Structure
Maintenance
Performance
Deployment
Styling
Reference
Glossary
Index
malcolmjs
Docs
»
Contents
Edit on GitHub
Contents
¶
Overview
Introduction
Overview
How is the Documentation Structured
User Guide
Getting Started
Quick Start
User Interface Overview
User Interface Components
Principle User Interface views
Layout View
Attribute View
Panel Popping
Working With a Design
Adding a Block to a Design
Removing a Block from a Design
Working with the Block Palette
Specifying Block Attributes
Types of Attributes
Obtaining Information About an Attribute
Setting a Block Attribute
View/Edit Button
Dropdown List
Text Input
Checkbox
Exporting Attributes
Local vs. Server Parameter Attribute State
Attribute Change Lifecycle
Complex Attributes
Identifying Table Attributes
Specifying Attribute Table Content
Static vs. Dynamic Attribute Tables
Working with Block Methods
Obtaining information about Method execution
Block Ports
Linking Blocks
Creating a Block Link
Interrogating Link Attributes
Removing a Link
Constraints When Using Links
Saving a Design
Opening an Existing Design
Monitoring Attribute Values
Working With Charts
Interactive Chart Functionality
Enhanced Chart Interactivity
Exporting a Chart For External Presentation
Data Retrieval and Chart Update Frequency
Working with Numerical Tables
Data Retrieval and Table Update Frequency
Understanding Attribute State
Normal State
Processing State
Locally Edited State
Update Error State
Warning State
Error State
Invalid State
Disconnected State
Presenting Status Information
System Maintenance Guide
Architecture
Context
Containers
Components
Deployment View
Technologies
By Component
Tools
Languages
Frameworks
Quality
Coding Standards
Security
Testing
Attitude Towards Bugs and Technical Debt
Architecture Background
Architectural Constraints
System Qualities
Engineering Principles
Architectural Styles
Architectural Decision Record
Sequence Diagrams
Connecting to the websocket
Getting Block Details
Loading the layout
Running a method
Setting up a Development Environment
Code Development
Documentation Development
Setting up a virtual environment
In a Diamond environme
In an environment you control
Running a docs build
Developer Workflow
Workflow
Story State Transitions
Branching Strategy
Code Development and Testing
Preparing for a Pull Request
Pull Request Procedure
Monitoring Progress in a Sprint
Testing Strategy
Scope
Strategy
Development Testing
System Testing
Defect Management
User Acceptance Testing
Deployment Testing
Code Structure
How to link UI components to backend actions/reducers
Drawer Container
Block Details
Attribute Details
Methods
NavBar
NavControl
Layout Component
Malcolm
actions
reducers
middleware
malcolmHandlers
MalcolmWidgets
Maintenance
Useful URLs
NPM commands
Editing documentation
User Guide
SMG
The malcolm development server
Running pyMalcolm + PandA simulator & Generating canned data
Simulator
Canned Data
Performance
React Performance Tools
Why-did-you-update Middleware
Deployment
Authentication
Styling
Material-UI Theming
Reference
Glossary
Index
class
_
¶
Needed so that genindex is created
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.