53 lines
3.9 KiB
Markdown
53 lines
3.9 KiB
Markdown
---
|
||
source_files:
|
||
- Common/DTS.Common/Interface/DTS.Viewer/Legend/ILegendView.cs
|
||
- Common/DTS.Common/Interface/DTS.Viewer/Legend/ILegendViewModel.cs
|
||
generated_at: "2026-04-16T03:07:28.401794+00:00"
|
||
model: "Qwen/Qwen3-Coder-Next-FP8"
|
||
schema_version: 1
|
||
sha256: "0b4af6a3a34a7912"
|
||
---
|
||
|
||
# Legend
|
||
|
||
## 1. Purpose
|
||
This module defines the foundational interfaces for a legend view–view model pair within the DTS viewer subsystem. It establishes the contract between the presentation layer (view) and the business/logic layer (view model) for displaying legend information—typically used to explain symbols, colors, or categories in a visualization (e.g., maps, charts, or diagrams). The interfaces inherit from base abstractions (`IBaseView`, `IBaseViewModel`) to integrate with a larger MVVM (Model-View-ViewModel) framework, ensuring consistency and testability across the application.
|
||
|
||
## 2. Public Interface
|
||
|
||
### `ILegendView`
|
||
```csharp
|
||
public interface ILegendView : IBaseView
|
||
```
|
||
- **Description**: Represents the view component responsible for rendering legend content. It inherits from `IBaseView`, implying it participates in a standardized view lifecycle (e.g., initialization, binding, disposal) defined elsewhere. No additional members are declared in this interface—its behavior is entirely governed by the base interface and implementation.
|
||
|
||
### `ILegendViewModel`
|
||
```csharp
|
||
public interface ILegendViewModel : IBaseViewModel
|
||
{
|
||
ILegendView View { get; }
|
||
}
|
||
```
|
||
- **Description**: Represents the view model for the legend. It exposes a read-only property `View` that provides access to the associated `ILegendView` instance. This follows a common MVVM pattern where the view model holds a reference to its view for coordination (e.g., triggering view updates or responding to view-specific state). Inherits from `IBaseViewModel`, implying standard view model capabilities (e.g., property change notification, command handling).
|
||
|
||
## 3. Invariants
|
||
- `ILegendView` must be implemented by a concrete view class that adheres to the contract of `IBaseView` (e.g., supports data binding, lifecycle management).
|
||
- `ILegendViewModel` must always return a non-null `ILegendView` instance via the `View` property during its active lifetime (though the source does not enforce this explicitly, it is implied by the design).
|
||
- The `View` property in `ILegendViewModel` is read-only—no setter is defined, meaning view assignment (if any) must occur internally or during construction.
|
||
|
||
## 4. Dependencies
|
||
- **Internal Dependencies**:
|
||
- `DTS.Common.Base` namespace (specifically `IBaseView` and `IBaseViewModel`), indicating reliance on a shared base layer for UI abstractions.
|
||
- **External Dependencies**:
|
||
- Unknown—no other namespaces or types are referenced in the provided source.
|
||
- **Dependents**:
|
||
- Likely consumed by a DI container or MVVM framework to wire up legend-related UI components.
|
||
- Concrete implementations (not shown) would depend on this interface for decoupled testing and composition.
|
||
|
||
## 5. Gotchas
|
||
- **Ambiguity in `View` property semantics**: The `ILegendViewModel.View` property suggests a back-reference to the view, but its lifecycle management (e.g., who sets it? when is it null? can it change?) is not specified in the source. This could lead to runtime errors if implementations assume ownership or mutability.
|
||
- **No explicit data members**: Neither interface declares properties for legend data (e.g., items, titles, colors). This implies legend content is either:
|
||
- Handled via `IBaseView`/`IBaseViewModel` (e.g., through generic data-binding mechanisms),
|
||
- Defined in derived interfaces or concrete classes (not included here), or
|
||
- An oversight (but cannot be assumed without further evidence).
|
||
- **No versioning or extensibility markers**: The interfaces are minimal and may lack hooks for future enhancements (e.g., `INotifyPropertyChanged` is not declared here, though likely inherited from `IBaseViewModel`). |