TheTechIdea.OilGas.Wellbore
104 public types. Summaries come from the XML documentation of the compiled assembly.
TheTechIdea.OilGas.Wellbore
| Type | Summary |
|---|---|
AccessibleItemclass | An element of a view described for assistive technology (screen readers): name, role, description, state. |
AnnotationKindenum | Kinds of annotation drawn over the tracks. |
AnnotationRendererstatic class | Annotation geometry and drawing (shared by the screen, printing and hit testing). |
Brandingstatic class | The trademark footnote (environment branding section, default "The Tech Idea™") and optional logo drawn on every export, print and view. A missing or unreadable logo is simply not drawn. |
CorrelationChecksstatic class | Checks shared by maps and cross-sections. |
CorrelationColumnclass | One laid-out column. |
CorrelationLayoutstatic class | Pure layout of a correlation panel: common axis range, flattening offsets, column widths and gaps. |
CorrelationPanelclass | Multi-well correlation panel: wells side by side on a common vertical reference (TVDSS by default, or flattened on a top), with correlation lines joining same-named tops. |
CorrelationRendererstatic class | Draws a correlation panel: aligned wells, well titles, correlation lines and zone shading between tops. |
CorrelationViewclass | Interactive correlation panel: shared zoom / pan across wells, cursor with each well's MD at that level. |
CorrelationWellclass | One well in a correlation panel. |
CrossSectionLayoutstatic class | Paths and surfaces of a cross-section (pure). |
CrossSectionPanelclass | Geological cross-section along a map line: wells projected onto the line at true horizontal distance, paths in TVDSS, tops joined between wells as surfaces, zones filled. Coordinates are projected (easting / northing) in Unit; trajectory azimuths are taken as grid north. Surfaces are straight lines between picks (a correlation, not a mapped horizon). |
CrossSectionRendererstatic class | Draws a cross-section: axes, zones, surfaces, contacts, well paths, labels, vertical exaggeration. |
CrossSectionViewclass | Canvas hosting a cross-section panel (persisted as JSON). |
CrossSectionWellclass | A well placed in a cross-section: its document and surface location in projected coordinates (panel unit). |
Curvestatic class | Linear and monotone cubic (Fritsch-Carlson) evaluation of sorted points. |
CurveDecimationstatic class | Screen-space thinning for long curves. Points are bucketed by pixel row; each row keeps its first, leftmost, rightmost and last point (in original order), so the drawn polyline covers exactly the same pixels — spikes survive — while the point count is bounded by 4 × plot height regardless of sample count. |
DepthAxisclass | The single depth axis shared by all tracks of a well view. |
DepthFeaturestruct | A depth interval (axis units) that needs at least MinPx on screen. |
DepthIntervalclass | One annotated depth interval. |
DepthMapperstruct | The one depth <-> screen-y mapping used by every track. Boolean) reproduces the legacy WellLogLayoutEngine.MapDepthToY exactly (same float operations, same clamping), so moving the log family onto the shared layer changes no pixel. |
DepthMarkerclass | A formation top or fluid contact drawn across every track (depth = MD). |
DepthReferenceenum | What the depth axis measures. |
DepthScaleModeenum | How the depth axis maps to the screen. |
DepthTrackclass | Depth labels at major steps (the one depth scale of a well view). |
DepthUnitenum | Depth unit shared by every well view. |
DepthUnitsstatic class | Unit helpers (exact international foot). |
DepthWarpclass | Monotonic piecewise-linear depth -> plot fraction map shared by all tracks in compressed mode. Built so every feature gets at least its requested pixels and gaps share the rest (long gaps compressed by weighting length^power). Pure and deterministic. |
DisplayUnitsstatic class | Displayed quantities in the environment's display units (calculations stay in their internal units). |
EnvironmentBridgestatic class | Typed access to WellboreEnvironment values for the drawing layer (colours, enums, units). |
FluidContactsstatic class | Fluid contact vocabulary and drawing conventions. |
Frameclass | Geometry of a drawn cross-section: plot rectangle, data ranges and scales (vertical exaggeration). |
HatchLineclass | One line family of a hatch: angle, origin, offset between successive lines, dashes (AutoCAD .pat descriptor). |
HatchPatternclass | A named hatch pattern read from a .pat file. |
HatchPatternsstatic class | Reads AutoCAD hatch pattern definition files (.pat) as Autodesk documents them: "*name, description" headers and descriptor lines "angle, x-origin, y-origin, delta-x, delta-y [, dash-1, dash-2, ...]" (dash > 0 dash, < 0 gap, 0 dot); ';' starts a comment. |
Horizonclass | A correlated surface along a section: its picks, where it ends between wells, and its curve. |
HorizonInterpolationenum | How a surface is drawn between its picks. |
HorizonTerminationenum | How a surface missing in a well ends between wells. |
ILiveStatusinterface | State of a live data feed shown by a canvas (implemented by e.g. the log family's LiveLogFeed). |
IntervalTrackclass | Zonation / remarks track: coloured intervals with text (axis units). |
ITrackFrameinterface | Frame properties every track type exposes (log tracks and wellbore tracks alike). |
LadderPlotViewclass | Ladder plot: centre-to-centre distance and MASD (top) and separation factor with the levels (bottom) along the reference MD. |
LegendEntryclass | One legend item contributed by a track (see LegendEntries). |
LegendKindenum | How a legend entry swatch is drawn. |
LegendRendererstatic class | Collects legend entries from every track and lays them out in columns, grouped. |
LithologyDefinitionclass | One lithology / fluid / fill definition. |
LithologyGeometrystatic class | Pure pattern geometry. Every position is anchored to the canvas origin (not the rectangle), so neighbouring intervals and tracks continue the same pattern seamlessly. Mirrored 1:1 by the symbol-library generator (generator/lithology.py). |
LithologyLibraryclass | The single lithology library for every well family (log lithology tracks, curve fills, schematic formations, SVG tiles). Data lives in the embedded lithology.json; the symbol-library generator reads the same file, so the SVG tiles and the Skia renderer cannot drift. |
LithologyPatternenum | Fill pattern kinds (standard geological symbology plus log-shading styles); the lithologies named are those of the built-in library. |
LithologyRendererstatic class | Fills rectangles with library lithologies (one implementation for logs, schematics and any track). |
LithologyStandardclass | A national lithology standard as a layer over the library: its numbers and names become aliases of the library's lithologies ("GOST 21.302-28", "Песчаник" -> sandstone), and Overrides replace a lithology's drawing with the standard's. |
LithologyStandardEntryclass | One entry of a national lithology standard: its number and name, and the library lithology it is (null: none). |
LithologyStandardsstatic class | National lithology standards (resources.lithologyStandards): built-in GOST 21.302-2013 (Russia / CIS) - FGDC numbers are part of the built-in library - or a company's own standard file. Applied on top of the library in effect by Current. |
MapLayoutstatic class | Pure plan-view geometry: well paths from the trajectories and an equal-scale, north-up world-to-screen transform. |
MapViewclass | Host-independent plan view of wells: surface locations, labels, plan-view paths, grid, scale bar and north arrow at equal scale, north up. Drag pans and the wheel zooms about the pointer; a click selects a well. In DrawSectionMode a drag draws the section line (SectionLineDrawn), and String) turns it into a cross-section. |
MarkerEditHistoryclass | Undo / redo history of marker edits (bounded). |
MarkerEditKindenum | Kind of marker edit: move, add or remove. |
MarkerKindenum | Whether a depth marker is a formation top or a fluid contact. |
MarkerMatchingstatic class | Which markers are "the same top": the canonical unit (marker UnitId, else the lexicon's resolution of its name), else the normalized name. Used by correlation lines, flattening, cross-section surfaces and duplicate-pick checks, so "Top Draupne" and "DRAUPNE FM" correlate when a lexicon knows both. |
MarkerMoveclass | A marker edit: a move (MD before / after), an addition or a removal — raised on commit and kept for undo / redo. |
PanelExportstatic class | PDF export of multi-well panels with the same page template, title, footer and trademark footnote as single wells: correlation panels (paged at the exact print scale on a shared depth window; fitted on one page when flattened or at scale 0) and cross-sections (one page each; several sections in one document). |
PaperSizestruct | Paper size in PDF points (1/72 in). |
Pathsstatic class | Path construction for SkiaSharp 4 (the repo's version): every path is built with SKPathBuilder and detached — SKPath mutators are obsolete there. Uses only MoveTo / LineTo / CubicTo / Close / Detach, the builder API used throughout the repo. Callers dispose the returned path. |
PatternElementstruct | One pattern element in screen space. |
Planclass | A print plan: the pages a document is split into at the chosen scale and paper. |
PrintPagestruct | One printed page: its depth slice and the exact plot height that realises the scale. |
PrintPlannerstatic class | Pure pagination for scaled printing. |
PrintTokensstatic class | Footer and title tokens: {well}, {title}, {reference}, {range}, {scale}, {page}, {pages}, {date}. |
SectionGeometrystatic class | Pure section geometry. |
SectionWellPathclass | A well path projected onto a cross-section line: distance along the line, TVDSS and MD. |
TrackChromestatic class | Shared track chrome: background, header, depth grid, depth labels. One implementation for every family. |
TrackEditclass | An undoable edit made inside a track (e.g. a curve depth shift): description plus undo / redo actions. |
TrackEditHistoryclass | Bounded undo / redo stack of track edits. |
TrackFrameLayoutstruct | Computed rectangles of one track. |
TrajectoryTrackclass | Well path from the document's depth reference (minimum-curvature survey). |
TrajectoryViewenum | What a trajectory track shows (deviation, vertical section or plan view). |
TravellingCylinderViewclass | Travelling-cylinder plot: offset wells around the reference well by direction (from north) and distance in the plane normal to it. |
UiTextstatic class | User-interface texts through the configured ILabelProvider (environment resources.labelFiles); the fallback is the built-in English text, so without a labels file nothing changes. Keys are listed in the documentation. |
UnknownTrackclass | Placeholder for a track type whose family is not loaded. Draws a notice and round-trips its payload untouched. |
ViewKeyenum | Keys a host forwards to a view (map your framework's key codes to these). |
ViewModifiersenum | Modifier keys held with a ViewKey. |
ViewSettingclass | A setting a view publishes for its host to persist (name, type, default, current value, description). |
ViewSurfaceabstract class | Host-independent base of the interactive views (WellboreView, CorrelationView, CrossSectionView): position and size, a Draw(SKCanvas) entry point, pointer input, and two events a UI host wires up - Invalidated (redraw me) and SettingChanged (persist this value). Any SkiaSharp host (WinForms, WPF, MAUI, Avalonia, a Beep.Skia adapter, a server rendering to PDF) can use the views; nothing here depends on a UI framework. |
WellboreAnnotationclass | A note, arrow or highlighted interval drawn over the tracks and saved with the document. Depths are in the document's axis unit (MD); horizontal positions are fractions (0-1) of the plot width of TrackId (null = across all tracks). |
WellboreDocumentclass | A well view: one depth axis, formation tops, and ordered tracks from any family. |
WellboreExportstatic class | Printing and export of well views: exact depth scale, pagination with repeated track headers, header block, footer, legend; PDF (multi-page), SVG and PNG (continuous) through SkiaSharp. |
WellboreInteractionModeenum | How the canvas uses pointer gestures. |
WellboreIssueclass | One validation finding for a wellbore view (document-, track- or item-level). |
WellboreIssueSeverityenum | Severity of a validation issue: error, warning or info. |
WellborePrintOptionsclass | How a well view is printed / exported. |
WellboreRendererstatic class | Draws a WellboreDocument: shared frame layout, headers, one depth grid mapping, every track's content, and tops across all tracks. Returns per-track contexts for hit-testing. |
WellboreThemeclass | Colours, fonts and line weights shared by every well view (defaults = the original log look). |
WellboreValidatorstatic class | Validates a whole wellbore view: document checks here, track data through each track's WellboreDocument) (families add their own rules). |
WellboreViewclass | WellboreView: descriptions for assistive technology. |
WellboreViewStateclass | Interactive view of a well: visible depth window inside the document axis, cursor depth and selection. Pure and deterministic (all gestures are depth arithmetic), so hosts and tests drive it directly. |
WellHeaderBlockstatic class | Well header block drawn at the top of printed / exported well views. |
WellMapclass | Wells on a map (projected easting / northing in Unit) and an optional section line. |
WellMarkersstatic class | Formation tops and fluid contacts of a well as document markers - resolved through the lexicons (display name in the environment's culture, unit colour, canonical unit id) - and the chronostratigraphy zones between them; shared by every view family. |
WellTrackabstract class | A vertical track in a well view. Families subclass this; the shared renderer draws frame, header, depth grid and tops, then calls WellTrackContext) with the common DepthMapper. |
WellTrackContextclass | Everything a track needs to draw: its rectangles, the shared mapper, theme and document. |
WellTrackLayoutEnginestatic class | Shared track layout: the legacy WellLogLayoutEngine.BuildTrackLayouts algorithm, plus an optional top reserve. |
WellTrackRegistrystatic class | Track type key -> factory. Families are discovered through WellTrackTypeAttribute on loaded assemblies (or registered explicitly); unknown keys become UnknownTrack and round-trip untouched. |
WellTrackTypeAttributeclass | Marks a WellTrack type with its persisted type key (enables registry discovery). |
AccessibleItem class
An element of a view described for assistive technology (screen readers): name, role, description, state.
| Member | Summary |
|---|---|
AccessibleItem(string name, string role, string description = null, bool selected = false, bool focused = false) | Creates an element description. |
string Description { get; } | Description. |
bool Focused { get; } | True when it has keyboard focus. |
string Name { get; } | Name. |
string Role { get; } | Role (depth track, well, annotation...). |
bool Selected { get; } | True when selected. |
AnnotationKind enum
Kinds of annotation drawn over the tracks.
| Member | Summary |
|---|---|
Note | A flagged text box at a depth. |
Arrow | An arrow from one point to another, with an optional label. |
Highlight | A coloured band over a depth interval. |
AnnotationRenderer static class
Annotation geometry and drawing (shared by the screen, printing and hit testing).
| Member | Summary |
|---|---|
static SKRect? Bounds(IReadOnlyList<WellTrackContext> contexts, WellboreAnnotation a) | Screen rectangle of an annotation (highlight band, note box, arrow extent); null when its track is not shown. |
static void Draw(SKCanvas canvas, IReadOnlyList<WellTrackContext> contexts, WellboreDocument doc, WellboreTheme th) | Draws the document's annotations over the tracks (when shown). |
static IEnumerable<WellboreIssue> Validate(WellboreDocument doc) | Annotations referring to missing tracks (WB030) or lying outside the axis (WB031). |
Branding static class
The trademark footnote (environment branding section, default "The Tech Idea™") and optional logo drawn on every export, print and view. A missing or unreadable logo is simply not drawn.
| Member | Summary |
|---|---|
static string Footnote { get; } | The footnote text of the current environment. |
static SKImage Logo { get; } | The logo of the current environment: the configured file (decoded once per file; null when it cannot be read - never replaced by another logo), else the built-in The Tech Idea logo; null when branding.showLogo is off. |
const string BuiltInLogoResource = "TheTechIdea.OilGas.Wellbore.the-tech-idea-logo.png" | Name of the embedded default logo (The Tech Idea). |
static float DrawFootnote(SKCanvas canvas, float centerX, float baseline, SKColor color, float size = 7) | Draws the logo (when configured) and the footnote centred on centerX at baseline; returns the width used. |
static void DrawScreenMark(SKCanvas canvas, SKRect bounds, SKColor textColor) | Draws the footnote small and faint in the bottom-right corner of a view (when branding.showOnScreen). |
CorrelationChecks static class
Checks shared by maps and cross-sections.
| Member | Summary |
|---|---|
static List<WellboreIssue> CoordinateSystems(IEnumerable<CrossSectionWell> wells) | WV060 when wells use different coordinate reference systems (their positions are not comparable as given); WV061 when only some wells declare one. |
CorrelationColumn class
One laid-out column.
| Member | Summary |
|---|---|
CorrelationColumn(CorrelationWell well, WellboreDocument view, SKRect bounds, SKRect title, float offset) | Creates a column: the well, its view, bounds, title area and flattening offset. |
SKRect Bounds { get; } | Column bounds. |
IReadOnlyList<WellTrackContext> Contexts { get; } | The drawn tracks of the column. |
float Offset { get; } | Flattening shift applied to this well (axis units). |
SKRect TitleBounds { get; } | Title area. |
WellboreDocument View { get; } | Per-well view on the common axis (a copy; the source document is never modified). |
CorrelationWell Well { get; } | The well shown. |
CorrelationLayout static class
Pure layout of a correlation panel: common axis range, flattening offsets, column widths and gaps.
| Member | Summary |
|---|---|
const float TitleHeight = 34 | Height of the column titles (pixels). |
static float AxisValue(WellboreDocument well, DepthReference reference, float md) | Axis value (panel reference, before flattening) of an MD in a well. |
static List<CorrelationColumn> Build(CorrelationPanel panel, SKRect bounds) | Column geometry for the panel in bounds. |
CorrelationPanel class
Multi-well correlation panel: wells side by side on a common vertical reference (TVDSS by default, or flattened on a top), with correlation lines joining same-named tops.
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
bool DistanceSpacing { get; set; } | Gap proportional to DistanceFromPrevious (between WellGap and 3 x WellGap). |
bool FillZones { get; set; } | Fill the zones between matching tops. |
string FlattenOn { get; set; } | Flatten on this top (all wells shifted so it sits at 0); null = no flattening. |
DepthScaleMode Mode { get; set; } | Depth scale mode of the columns (true or compressed). |
string Name { get; set; } | Panel name. |
DepthReference Reference { get; set; } | Common vertical reference (TVDSS removes datum and deviation differences). |
bool ShowCorrelationLines { get; set; } | Draw lines between matching tops. |
bool ShowWellheads { get; set; } | Show wellhead stacks above the plots (off by default: noise in a correlation view). |
float WellGap { get; set; } | Gap between the wells (pixels; default from the environment). |
List<CorrelationWell> Wells { get; } | The wells, left to right. |
const int CurrentSchemaVersion = 1 | Panel schema version written by this library. |
static CorrelationPanel FromJson(string json) | Reads a panel. |
IReadOnlyList<string> SharedTops() | Tops present in at least two wells (correlation candidates), in order of first appearance. |
string ToJson() | Serializes the panel. |
CorrelationRenderer static class
Draws a correlation panel: aligned wells, well titles, correlation lines and zone shading between tops.
| Member | Summary |
|---|---|
static List<CorrelationColumn> Draw(SKCanvas canvas, SKRect bounds, CorrelationPanel panel, WellboreTheme theme = null, WellboreViewState view = null) | Draws the panel (columns, correlation lines, zones); returns the columns. |
static float? TopY(CorrelationColumn c, string top) | Screen y of a top in a column (null when the well does not have it or it is out of view). |
CorrelationView class
Interactive correlation panel: shared zoom / pan across wells, cursor with each well's MD at that level.
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
IReadOnlyList<AccessibleItem> AccessibleChildren { get; } | The view's elements (tracks, wells...) with their state, for assistive technology. |
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
IReadOnlyList<CorrelationColumn> Columns { get; } | The columns of the last drawing. |
MarkerEditHistory MarkerHistory { get; } | Undo / redo of top moves. |
float MarkerSnap { get; set; } | Depth snap for dragged tops (0 = none). |
CorrelationPanel Panel { get; set; } | The panel shown. |
string PanelJson { get; set; } | The panel as JSON (persisted by hosts). |
WellboreTheme Theme { get; set; } | Theme. |
WellboreViewState View { get; } | Shared depth window, cursor and selection. |
event EventHandler<MarkerMove> MarkerMoved | A top was moved, or a move undone / redone. |
void Commit() | Publishes the panel for persistence and redraws. |
bool HandleMouseHover(SKPoint point) | Pointer moved with no button pressed; true requests a redraw. |
bool HandleMouseLeave() | Pointer left the view; true requests a redraw. |
bool HandleMouseWheel(SKPoint point, float delta) | Wheel over the view (delta > 0 = away from the user); true when consumed. |
IReadOnlyList<(string, float)> MdAt(float y) | Each well's MD at a screen y (cursor readout), by column. |
DepthAxis PanelFullAxis() | The panel's full common axis (independent of zoom). |
bool RedoMarker() | Redoes the last undone top move. |
bool UndoMarker() | Undoes the last top move. |
CorrelationWell class
One well in a correlation panel.
| Member | Summary |
|---|---|
double? DistanceFromPrevious { get; set; } | Distance from the previous well (any consistent unit) — used with distance spacing. |
WellboreDocument Document { get; set; } | The well's view (tracks, markers, axis). |
string Label { get; set; } | Column title; defaults to the well name. |
string Title { get; } | Label, else the well name, else the document name. |
CrossSectionLayout static class
Paths and surfaces of a cross-section (pure).
| Member | Summary |
|---|---|
static List<Horizon> Horizons(CrossSectionPanel panel, IReadOnlyList<SectionWellPath> paths) | Horizons with their terminations: where a surface is missing in a neighbouring well it ends between the two wells (at TerminationFraction) - against the lowest overlying unconformity present in that well (truncation), otherwise on the next deeper surface present in both wells (pinch-out). Ordered shallow to deep. |
static List<SectionWellPath> Paths(CrossSectionPanel panel, int samples = 120) | The projected path of every well (sampled along MD). |
static List<(string, DepthMarker, List<(double, double)>)> Surfaces(IReadOnlyList<SectionWellPath> paths) | Surfaces: each top present in two or more wells, as (s, TVDSS) picks sorted along the line; ordered shallow to deep. |
static List<(int, string, List<(double, double)>)> ZonePolygons(IReadOnlyList<Horizon> horizons, int samples = 60) | Zone polygons: below each horizon down to the next deeper horizon present at each point along the line, so a unit that pinches out tapers to nothing and the unit above continues onto the surface below it. (index, name, closed polygon). |
CrossSectionPanel class
Geological cross-section along a map line: wells projected onto the line at true horizontal distance, paths in TVDSS, tops joined between wells as surfaces, zones filled. Coordinates are projected (easting / northing) in Unit; trajectory azimuths are taken as grid north. Surfaces are straight lines between picks (a correlation, not a mapped horizon).
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
bool FillZones { get; set; } | Fill the zones between surfaces. |
HorizonInterpolation Interpolation { get; set; } | How surfaces are drawn between picks: straight lines, or a smooth curve that never overshoots the picks. |
List<(double, double)> Line { get; } | Section line vertices (projected x = easting, y = northing), at least two. |
double MaxOffset { get; set; } | Wells whose surface lies farther than this from the line are flagged (0 = no limit). |
string Name { get; set; } | Panel name. |
float TerminationFraction { get; set; } | Where between two wells a missing surface ends (0 = at the well that has it, 1 = at the well that lacks it). |
HashSet<string> Unconformities { get; } | Tops that are unconformities: a deeper surface missing in a well ends against them (truncation) instead of pinching out. |
DepthUnit Unit { get; set; } | Length unit of coordinates and of the section axes. |
float? VerticalExaggeration { get; set; } | Fixed vertical exaggeration; null = fit the panel (the value used is shown). |
List<CrossSectionWell> Wells { get; } | The wells. |
Dictionary<string, string> ZoneLithology { get; } | Zone fill below a top (top name -> lithology code); zones without an entry get a pastel tint. |
const int CurrentSchemaVersion = 1 | Panel schema version written by this library. |
static CrossSectionPanel FromJson(string json) | Reads a panel. |
string ToJson() | Serializes the panel. |
List<WellboreIssue> Validate() | Checks the wells shown together: coordinate systems (WV060, WV061). |
CrossSectionRenderer static class
Draws a cross-section: axes, zones, surfaces, contacts, well paths, labels, vertical exaggeration.
| Member | Summary |
|---|---|
static Frame Draw(SKCanvas canvas, SKRect bounds, CrossSectionPanel panel, WellboreTheme theme = null) | Draws the cross-section (paths, surfaces, zones, labels); returns its geometry. |
static List<Frame> DrawStacked(SKCanvas canvas, SKRect bounds, IReadOnlyList<CrossSectionPanel> sections, WellboreTheme theme = null, float gap = 12) | Draws several sections one above another in bounds; returns their geometries. |
static Frame Layout(CrossSectionPanel panel, IReadOnlyList<SectionWellPath> paths, SKRect bounds) | Plot geometry for the paths in bounds (fixed or fitted vertical exaggeration). |
static IEnumerable<(double, double)> Sample(IReadOnlyList<(double, double)> picks, double lo, double hi, int n = 40) | Linear interpolation of a pick polyline at evenly spaced distances in [lo, hi]. |
CrossSectionView class
Canvas hosting a cross-section panel (persisted as JSON).
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
Frame LastFrame { get; } | Geometry of the last drawing, or null. |
CrossSectionPanel Panel { get; set; } | The panel shown. |
string PanelJson { get; set; } | The panel as JSON (persisted by hosts). |
WellboreTheme Theme { get; set; } | Theme. |
void Commit() | Publishes the panel for persistence and redraws. |
CrossSectionWell class
A well placed in a cross-section: its document and surface location in projected coordinates (panel unit).
| Member | Summary |
|---|---|
string Crs { get; set; } | Coordinate reference system of the well's position (null: the document's). |
WellboreDocument Document { get; set; } | The well's view (tracks, markers, trajectory). |
string EffectiveCrs { get; } | The well's coordinate reference system: its own, else its document's. |
string Label { get; set; } | Label; null = the well name. |
string Title { get; } | Label, else the well name, else the document name. |
double X { get; set; } | Surface easting (panel unit). |
double Y { get; set; } | Surface northing (panel unit). |
Curve static class
Linear and monotone cubic (Fritsch-Carlson) evaluation of sorted points.
| Member | Summary |
|---|---|
static double? At(IReadOnlyList<(double, double)> p, double x, HorizonInterpolation mode) | Value at x (null outside the points). |
CurveDecimation static class
Screen-space thinning for long curves. Points are bucketed by pixel row; each row keeps its first, leftmost, rightmost and last point (in original order), so the drawn polyline covers exactly the same pixels — spikes survive — while the point count is bounded by 4 × plot height regardless of sample count.
| Member | Summary |
|---|---|
static List<(float, float)> Decimate(IReadOnlyList<(float, float)> points) | Reduces a polyline to at most four points per pixel row (first, leftmost, rightmost, last); the drawn line covers the same pixels. |
static (int, int) VisibleRange(IReadOnlyList<float> sortedDepths, float top, float bottom) | Index range [from, to] of samples needed to draw depths [top, bottom] (samples sorted ascending), including one sample beyond each end so the line reaches the plot edges. |
DepthAxis class
The single depth axis shared by all tracks of a well view.
| Member | Summary |
|---|---|
float Bottom { get; set; } | Bottom of the axis. |
float CompressionPower { get; set; } | Compressed mode: gap weighting exponent (1 = gaps keep proportional share, lower = long gaps shrink more). |
bool IncreasingDown { get; set; } | True: depth increases downward (normal). False: elevation-style (up). |
float MajorStep { get; set; } | Major grid/label step in axis units; 0 = automatic. |
float MinGapPx { get; set; } | Compressed mode: minimum pixels kept for every empty interval. |
float MinorStep { get; set; } | Minor grid step in axis units; 0 = automatic. |
DepthScaleMode Mode { get; set; } | True (linear) or Compressed (not to scale: content intervals expanded, empty ones compressed). |
DepthReference Reference { get; set; } | Depth reference shown (MD, TVD, TVDSS). |
float Span { get; } | Bottom minus top. |
string Title { get; } | Axis label, e.g. "MD (ft)". |
float Top { get; set; } | Top of the axis (axis unit). |
DepthUnit Unit { get; set; } | Axis unit. |
DepthAxis Clone() | A copy of the axis. |
static double NiceStep(double raw) | A 1 / 2 / 5 x 10^n step not smaller than raw. |
(float, float) ResolveSteps(float plotHeight, float targetMajorPx = 60) | Resolved (major, minor) steps for a plot height: explicit steps win, otherwise a 1-2-5 step giving ~60 px between majors. |
string ToString() | Title and range as text. |
DepthFeature struct
A depth interval (axis units) that needs at least MinPx on screen.
| Member | Summary |
|---|---|
DepthFeature(float top, float bottom, float minPx) | A feature interval (axis units) and the minimum pixels it needs. |
float Bottom { get; } | Bottom of the interval. |
float MinPx { get; } | Minimum height on screen (pixels). |
float Top { get; } | Top of the interval. |
DepthInterval class
One annotated depth interval.
| Member | Summary |
|---|---|
float Bottom { get; set; } | Bottom of the interval. |
string Color { get; set; } | Fill colour (#rrggbb); null = default. |
string Lithology { get; set; } | Optional lithology code/alias (library pattern); overrides Color. |
string Text { get; set; } | Text shown in the interval. |
float Top { get; set; } | Top of the interval. |
DepthMapper struct
The one depth <-> screen-y mapping used by every track. Boolean) reproduces the legacy WellLogLayoutEngine.MapDepthToY exactly (same float operations, same clamping), so moving the log family onto the shared layer changes no pixel.
| Member | Summary |
|---|---|
DepthMapper(DepthAxis axis, float plotTop, float plotBottom) | A mapper for an axis onto a plot span (pixels). |
DepthMapper(DepthAxis axis, float plotTop, float plotBottom, DepthWarp warp) | Mapper with a compressed-depth warp (shared by every track of a view). |
DepthMapper(DepthAxis axis, float plotTop, float plotBottom, DepthWarp warp, Func<float, float> mdToAxis, Func<float, float> axisToMd) | A mapper for a depth range onto a plot span (pixels). |
DepthMapper(float top, float bottom, bool increasingDown, DepthUnit unit, float plotTop, float plotBottom) | A mapper for a depth range onto a plot span (pixels). |
Func<float, float> AxisToMd { get; } | Axis value -> MD; null for MD axes. |
float Bottom { get; } | Bottom depth mapped. |
bool HasDepthTransform { get; } | True when depths are transformed (TVD / TVDSS or compressed). |
bool IncreasingDown { get; } | Depth increases downward on screen. |
Func<float, float> MdToAxis { get; } | MD -> axis value (TVD / TVDSS views); null for MD axes. |
float PlotBottom { get; } | Screen y of the bottom. |
float PlotHeight { get; } | Plot height (pixels). |
float PlotTop { get; } | Screen y of the top. |
float Top { get; } | Top depth mapped. |
DepthUnit Unit { get; } | Depth unit. |
DepthWarp Warp { get; } | Compressed-depth warp; null = true scale. |
static float Map(float minDepth, float maxDepth, bool increasingDown, float depth, float plotTop, float plotBottom, bool clamp = true) | Legacy-compatible mapping (see type remarks). |
float ToAxisValue(float y) | Axis value at a screen y (zoom / pan anchors). |
float ToDepth(float y) | Data depth (MD, axis unit) at a screen y. On TVD / TVDSS axes the axis value is converted back to MD. |
double ToDepth(float y, DepthUnit unit) | Depth at a screen y, expressed in unit. |
float ToY(float depth) | Screen y of a depth in axis units (clamped to the plot, like the legacy log mapping). |
float ToY(double depth, DepthUnit unit, bool clamp = true) | Screen y of a depth given in unit (converted to the axis unit first). |
float ToYAxis(float axisValue) | Screen y of an AXIS value (depth labels, grid, window edges) — no MD transform. |
float ToYAxisUnclamped(float axisValue) | Unclamped screen y of an axis value. |
float ToYUnclamped(float depth) | Unclamped y (objects partially outside the view). |
DepthMarker class
A formation top or fluid contact drawn across every track (depth = MD).
| Member | Summary |
|---|---|
string Color { get; set; } | Line colour (#rrggbb). |
string ContactType { get; set; } | Fluid contact code (see FluidContacts): GOC, OWC, GWC, FWL, GDT, ODT, OUT, WUT. |
float Depth { get; set; } | Depth (document axis unit, MD). |
string Interpreter { get; set; } | Who picked it. |
MarkerKind Kind { get; set; } | Top or fluid contact. |
bool Locked { get; set; } | Locked markers cannot be dragged. |
string Name { get; set; } | Top or contact name. |
string SourceName { get; set; } | The name used by the data source when Name shows a lexicon display name. |
string UnitId { get; set; } | Canonical stratigraphic unit (lexicon id): tops with the same unit correlate whatever their spelling. |
DepthReference enum
What the depth axis measures.
| Member | Summary |
|---|---|
MD | Measured depth along the hole. |
TVD | True vertical depth below the depth datum. |
TVDSS | True vertical depth below sea level. |
DepthScaleMode enum
How the depth axis maps to the screen.
| Member | Summary |
|---|---|
True | Linear (true scale). |
Compressed | Not to scale: intervals with content get guaranteed space, empty intervals are compressed. |
DepthTrack class
Depth labels at major steps (the one depth scale of a well view).
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
string Format { get; set; } | Label format; null = automatic from the step size. |
string Subtitle { get; } | Second header line (units, mnemonic); null = none. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "depth" | Type key of the track (serialization). |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
JsonObject SavePayload() | Type-specific settings for persistence. |
DepthUnit enum
Depth unit shared by every well view.
| Member | Summary |
|---|---|
Meters | Metres. |
Feet | Feet. |
DepthUnits static class
Unit helpers (exact international foot).
| Member | Summary |
|---|---|
const double MetersPerFoot = 0.3048 | Metres per foot (exact). |
static double Convert(double value, DepthUnit from, DepthUnit to) | Converts a depth between units. |
static float Convert(float value, DepthUnit from, DepthUnit to) | Converts a depth between units. |
static DepthUnit? FromMnemonic(string unit) | Maps LAS/WITSML unit mnemonics (M, F, FT, FEET, METER…) to a unit; null when not a depth unit. |
static string Symbol(DepthUnit unit) | Unit symbol (m, ft). |
DepthWarp class
Monotonic piecewise-linear depth -> plot fraction map shared by all tracks in compressed mode. Built so every feature gets at least its requested pixels and gaps share the rest (long gaps compressed by weighting length^power). Pure and deterministic.
| Member | Summary |
|---|---|
IReadOnlyList<float> Depths { get; } | Breakpoint depths (ascending) and their plot fractions (0..1). |
IReadOnlyList<float> Fractions { get; } | Plot fraction of each breakpoint depth. |
IReadOnlyList<(float, float, bool)> Segments { get; } | Segments between breakpoints, flagged when they hold a feature. |
static DepthWarp Build(float top, float bottom, IEnumerable<DepthFeature> features, float plotPx, float minGapPx = 8, float power = 0.5) | Builds the warp for features over [top, bottom] on a plot of plotPx. Returns null when there is nothing to warp (no features) — callers then use true scale. |
float Inverse(float fraction) | Depth at a plot fraction (inverse of Map). |
float Map(float depth) | Plot fraction of a depth (linear extrapolation outside the axis). |
float Ratio(int segment) | Local compression: screen share per depth unit relative to true scale (1 = true scale). |
DisplayUnits static class
Displayed quantities in the environment's display units (calculations stay in their internal units).
| Member | Summary |
|---|---|
static string Pressure { get; } | Pressure display unit (environment units.pressureUnit). |
static string FormatPressure(double psi, string format = "0.0") | A pressure given in psi, formatted with the display unit. |
static double FromPsi(double psi) | A pressure given in psi, in the display unit. |
static double GradientFromPsiPerFt(double psiPerFt, string depthUnit) | A gradient in psi/ft, in display pressure per depthUnit. |
static string GradientUnit(string depthUnit) | Gradient unit label for a depth unit, e.g. "psi/ft", "bar/m", "kPa/m". |
EnvironmentBridge static class
Typed access to WellboreEnvironment values for the drawing layer (colours, enums, units).
| Member | Summary |
|---|---|
static WellboreEnvironment Env { get; } | The current environment. |
static SKColor Surface { get; } | View surface colour. |
static SKColor SurfaceBorder { get; } | View border colour. |
static SKColor Color(string hex, SKColor fallback) | Colour from #rrggbb, else the fallback. |
static DepthUnit DepthUnitOf(string unit) | Depth unit of an environment unit symbol (m, else feet). |
static SKColor OnColor(SKColor background) | Text colour for background: black or white, whichever contrasts more (WCAG relative luminance) - badges and tags take their fill from the environment, so their text must follow it. |
static SKColor[] Palette(IReadOnlyList<string> hexes, SKColor fallback) | Colours from #rrggbb values (fallback when empty). |
static PaperSize Paper(PrintSettings p) | Paper size and orientation from the printing settings. |
static DepthScaleMode ScaleModeOf(string mode) | Depth scale mode of an environment value (Compressed, else true). |
static SKColor Section(string key, SKColor fallback) | Section colour by key from the environment. |
static SKColor Status(string key, SKColor fallback) | Status colour by key from the environment. |
static SKColor StyleColor(IReadOnlyDictionary<string, string> map, string key, SKColor fallback) | Colour for key from a style dictionary (case-insensitive), else fallback. |
FluidContacts static class
Fluid contact vocabulary and drawing conventions.
| Member | Summary |
|---|---|
static IReadOnlyDictionary<string, (string, string, int, int)> Types { get; } | code -> (name, colour, rank from top, limit direction: 0 = level, +1 = "down to", -1 = "up to") from the model catalog in effect. |
static string ColorOf(string code) | Contact colour from the environment's styles (built-in convention as fallback). |
static bool IsKnown(string code) | True when code is a known contact code. |
Frame class
Geometry of a drawn cross-section: plot rectangle, data ranges and scales (vertical exaggeration).
| Member | Summary |
|---|---|
float Kx { get; set; } | Horizontal scale (pixels per panel unit). |
float Ky { get; set; } | Vertical scale (pixels per panel unit). |
SKRect Plot { get; set; } | The plot rectangle. |
double SMax { get; set; } | Distance along the section line at the right edge (panel unit). |
double SMin { get; set; } | Distance along the section line at the left edge (panel unit). |
float VerticalExaggeration { get; } | Vertical exaggeration of the drawing. |
double ZMax { get; set; } | TVDSS at the bottom of the plot (panel unit). |
double ZMin { get; set; } | TVDSS at the top of the plot (panel unit). |
float X(double s) | Screen x of a distance along the line. |
float Y(double z) | Screen y of a TVDSS. |
HatchLine class
One line family of a hatch: angle, origin, offset between successive lines, dashes (AutoCAD .pat descriptor).
| Member | Summary |
|---|---|
double Angle { get; set; } | Angle of the lines (degrees, anticlockwise from the x axis, y up). |
List<double> Dashes { get; set; } | Dash pattern: positive = dash, negative = gap, 0 = dot; empty = continuous. |
double DeltaX { get; set; } | Shift of the dash pattern along each successive line (pattern units). |
double DeltaY { get; set; } | Spacing between successive lines (pattern units). |
double X { get; set; } | Origin x of the first line (pattern units). |
double Y { get; set; } | Origin y of the first line (pattern units). |
HatchPattern class
A named hatch pattern read from a .pat file.
| Member | Summary |
|---|---|
string Description { get; set; } | Description (after the name), if any. |
List<HatchLine> Lines { get; } | Line families. |
string Name { get; set; } | Pattern name (after the '*'). |
HatchPatterns static class
Reads AutoCAD hatch pattern definition files (.pat) as Autodesk documents them: "*name, description" headers and descriptor lines "angle, x-origin, y-origin, delta-x, delta-y [, dash-1, dash-2, ...]" (dash > 0 dash, < 0 gap, 0 dot); ';' starts a comment.
| Member | Summary |
|---|---|
static Dictionary<string, HatchPattern> Read(string text, List<string> errors = null) | The patterns of a .pat text by name (case-insensitive); malformed lines are reported in errors, with their line number. |
Horizon class
A correlated surface along a section: its picks, where it ends between wells, and its curve.
| Member | Summary |
|---|---|
HorizonInterpolation Interpolation { get; set; } | Interpolation between points. |
DepthMarker Marker { get; set; } | The first matching top (colour, kind). |
string Name { get; set; } | Top name. |
List<(double, double)> Picks { get; } | Picks in wells: (distance along the line, TVDSS), sorted. |
List<(double, double)> Points { get; } | Picks and termination points, sorted along the line. |
List<(double, double, HorizonTermination)> Terminations { get; } | Where the surface ends between wells, and why. |
double? At(double s) | TVDSS at a distance along the line, or null outside the surface. |
List<(double, double)> Sample(double lo, double hi, int n = 48) | Points along the surface between lo and hi (all breakpoints included). |
HorizonInterpolation enum
How a surface is drawn between its picks.
| Member | Summary |
|---|---|
Linear | Straight lines between picks. |
Smooth | Monotone cubic curve through the picks (Fritsch-Carlson): smooth, never above or below the neighbouring picks. |
HorizonTermination enum
How a surface missing in a well ends between wells.
| Member | Summary |
|---|---|
PinchOut | The unit thins out: the surface converges onto the next deeper surface. |
Truncation | The surface is cut by an overlying unconformity and ends against it. |
ILiveStatus interface
State of a live data feed shown by a canvas (implemented by e.g. the log family's LiveLogFeed).
| Member | Summary |
|---|---|
DateTime? LastUpdateUtc { get; } | When data last arrived (UTC); null before the first update. |
float? LatestDepth { get; } | Deepest data received, in the document's axis unit (MD); null before the first row. |
bool IsStale(DateTime nowUtc) | No data for longer than the feed's stale threshold at nowUtc. |
IntervalTrack class
Zonation / remarks track: coloured intervals with text (axis units).
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
List<DepthInterval> Intervals { get; } | The intervals. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
const string TypeKeyValue = "intervals" | Type key of the track (serialization). |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
string HitTest(WellTrackContext ctx, float x, float y) | Id of the object under a point, or null. |
(float, float)? ItemDepthRange(string itemId, DepthAxis axis) | Depth range (axis units) of an item, for "zoom to item". |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext ctx, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
SKRect? SelectionBounds(WellTrackContext ctx, string itemId) | Screen rectangle to highlight for a selected item id (any track may show the same item: cross-highlight). |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
ITrackFrame interface
Frame properties every track type exposes (log tracks and wellbore tracks alike).
| Member | Summary |
|---|---|
float HeaderHeight { get; } | Header height (pixels). |
float LeftMargin { get; } | Left margin inside the track (pixels). |
float RightMargin { get; } | Right margin inside the track (pixels). |
bool ShowHeader { get; } | True when the track has a header. |
float WidthRatio { get; } | Relative width of the track. |
LadderPlotView class
Ladder plot: centre-to-centre distance and MASD (top) and separation factor with the levels (bottom) along the reference MD.
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
AntiCollisionResult Result { get; set; } | The scan shown. |
LegendEntry class
One legend item contributed by a track (see LegendEntries).
| Member | Summary |
|---|---|
string Code { get; set; } | Lithology code (Lithology kind). |
SKColor Color { get; set; } | Colour. |
float[] Dash { get; set; } | Dash pattern of line entries; null = solid. |
Action<SKCanvas, SKRect> DrawSwatch { get; set; } | Custom swatch painter (Symbol kind), e.g. a schematic symbol icon. |
string Group { get; set; } | Legend group (entries are grouped under it). |
string Key { get; set; } | De-duplication key within the group (defaults to the label). |
LegendKind Kind { get; set; } | How the entry is drawn. |
string Label { get; set; } | Entry text. |
LegendKind enum
How a legend entry swatch is drawn.
| Member | Summary |
|---|---|
Swatch | A colour swatch. |
Lithology | A lithology pattern swatch. |
Line | A line sample (curves, contacts). |
Symbol | A symbol sample. |
LegendRenderer static class
Collects legend entries from every track and lays them out in columns, grouped.
| Member | Summary |
|---|---|
const float ColumnWidth = 190 | Width of a legend column (pixels). |
const float GroupHeight = 18 | Height of a group title (pixels). |
const float RowHeight = 18 | Height of an entry row (pixels). |
const float SwatchWidth = 30 | Width of the swatch (pixels). |
static List<LegendEntry> Collect(WellboreDocument doc) | The legend entries of every track of a document (duplicates removed). |
static void Draw(SKCanvas canvas, SKRect rect, IReadOnlyList<LegendEntry> entries, WellboreTheme theme = null) | Draws legend entries in columns inside rect. |
static string GroupTitle(string group) | Legend group title through the labels (key "legend." + group name in lower case, spaces as dots). |
static float Measure(IReadOnlyList<LegendEntry> entries, float width) | Height needed to draw entries in width. |
LithologyDefinition class
One lithology / fluid / fill definition.
| Member | Summary |
|---|---|
List<string> Aliases { get; set; } | Other codes / names that map to this lithology. |
string Background { get; set; } | Background colour (#rrggbb). |
string Background2 { get; set; } | Optional second background colour: diagonal gradient (log shading look). |
string Category { get; set; } | rock | fluid | fill. |
string Code { get; set; } | Lithology code (for example SS, SH, LS). |
string Foreground { get; set; } | Pattern colour (#rrggbb). |
List<HatchLine> Hatch { get; set; } | Hatch line families (pattern Hatch), as in an AutoCAD .pat definition. |
string HatchPattern { get; set; } | Name of a pattern in the standard layer's .pat files (sets Hatch). |
float HatchScale { get; set; } | Pixels per hatch pattern unit (e.g. 4 for a pattern in millimetres at about 4 px/mm). |
string Name { get; set; } | Display name. |
LithologyPattern Pattern { get; set; } | Fill pattern. |
float Size { get; set; } | Dot / circle radius or cross half-arm, px at scale 1. |
float Spacing { get; set; } | Pattern pitch in px at scale 1. |
float Stroke { get; set; } | Pattern line width. |
LithologyGeometry static class
Pure pattern geometry. Every position is anchored to the canvas origin (not the rectangle), so neighbouring intervals and tracks continue the same pattern seamlessly. Mirrored 1:1 by the symbol-library generator (generator/lithology.py).
| Member | Summary |
|---|---|
const int MaxHatchElements = 20000 | Most elements one hatch fill may produce (a guard against very dense patterns). |
static List<PatternElement> Generate(LithologyDefinition d, float left, float top, float right, float bottom, float scale = 1) | Pattern elements filling a rectangle (world-anchored, so patterns line up across tracks). |
LithologyLibrary class
The single lithology library for every well family (log lithology tracks, curve fills, schematic formations, SVG tiles). Data lives in the embedded lithology.json; the symbol-library generator reads the same file, so the SVG tiles and the Skia renderer cannot drift.
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
static LithologyLibrary Current { get; } | The library in effect: one a host set (WellboreServices.Set<LithologyLibrary>), else the environment's resources.lithologyFile, else the built-in library. Renderers, tracks and validation use this. |
static LithologyLibrary Default { get; } | The built-in library. |
IReadOnlyList<LithologyDefinition> Definitions { get; } | The lithologies. |
string Version { get; } | Library version. |
const string EmbeddedResourceName = "TheTechIdea.OilGas.Wellbore.lithology.json" | Name of the embedded default library resource. |
IEnumerable<LithologyDefinition> ByCategory(string category) | Lithologies of a category. |
static LithologyLibrary FromJson(string json) | Reads a library from JSON. |
static LithologyLibrary LoadFromFile(string path) | Reads a library file. |
LithologyDefinition Resolve(string codeOrAlias) | Definition for a code/alias, or the "default" fill when unknown. |
string ToJson() | The library as JSON (version and lithologies), readable by String). |
bool TryGet(string codeOrAlias, LithologyDefinition definition) | Case-insensitive lookup by code or alias; '-' and '_' are equivalent. |
LithologyPattern enum
Fill pattern kinds (standard geological symbology plus log-shading styles); the lithologies named are those of the built-in library.
| Member | Summary |
|---|---|
Solid | Solid fill (coal, overburden, log fills such as gamma ray and SP). |
Horizontal | Horizontal lines (depth track, density and water fills). |
DiagonalLeft | Diagonal lines rising to the left (resistivity and sonic fills). |
DiagonalRight | Diagonal lines rising to the right (caliper and oil fills). |
CrossHatch | Cross-hatching (anhydrite, basement / igneous, gas fill). |
Dots | Dots (sandstone and fluid-bearing sands, porosity and photoelectric fills). |
Circles | Circles (conglomerate). |
Crosses | Crosses (salt / halite). |
Dashes | Dashes (shale, claystone / mudstone). |
DotsDashes | Dots and dashes (siltstone). |
Bricks | Bricks (limestone, chalk). |
RhombBricks | Offset rhomb bricks (dolomite). |
Hatch | CAD hatch: line families as in an AutoCAD .pat definition (Hatch). |
LithologyRenderer static class
Fills rectangles with library lithologies (one implementation for logs, schematics and any track).
| Member | Summary |
|---|---|
static void Fill(SKCanvas canvas, SKRect rect, string codeOrAlias, byte alpha = 255, float scale = 1, LithologyLibrary library = null) | Fills rect with the lithology codeOrAlias. alpha scales the background (pattern is drawn slightly stronger, as in the original log shading). |
LithologyStandard class
A national lithology standard as a layer over the library: its numbers and names become aliases of the library's lithologies ("GOST 21.302-28", "Песчаник" -> sandstone), and Overrides replace a lithology's drawing with the standard's.
| Member | Summary |
|---|---|
List<string> AliasesOfName { get; set; } | Other names the standard is selected by (GOST 21.302 ...). |
List<LithologyStandardEntry> Entries { get; set; } | The standard's entries. |
string Name { get; set; } | Standard name (e.g. GOST 21.302-2013). |
List<LithologyDefinition> Overrides { get; set; } | The standard's drawings: definitions that replace pattern / colours of the library lithology with the same code. |
List<string> PatFiles { get; set; } | AutoCAD .pat hatch files (relative to the environment file) whose patterns the overrides name in hatchPattern. |
string Source { get; set; } | Where the numbers and names come from. |
IEnumerable<LithologyStandardEntry> Unmapped { get; } | Entries the library has no lithology for. |
LithologyStandardEntry class
One entry of a national lithology standard: its number and name, and the library lithology it is (null: none).
| Member | Summary |
|---|---|
string Code { get; set; } | Library lithology code this entry is; null when the library has no such rock. |
string Name { get; set; } | Name in the standard (its own language). |
int Number { get; set; } | Number in the standard's table. |
LithologyStandards static class
National lithology standards (resources.lithologyStandards): built-in GOST 21.302-2013 (Russia / CIS) - FGDC numbers are part of the built-in library - or a company's own standard file. Applied on top of the library in effect by Current.
| Member | Summary |
|---|---|
static IReadOnlyList<string> BuiltInNames { get; } | Names of the built-in standards. |
static LithologyStandard Gost21302 { get; } | The built-in GOST 21.302-2013 layer (Table 4 numbers and names). |
static LithologyLibrary Apply(LithologyLibrary library, IReadOnlyList<string> standards) | The library with the standards layered on (cached per library and standard list). |
static LithologyStandard FromJson(string json) | Reads a standard file. |
static LithologyStandard Load(string nameOrFile) | A standard by built-in name (or one of its aliases) or a JSON file path; null for FGDC (already in the library) or when unreadable. |
MapLayout static class
Pure plan-view geometry: well paths from the trajectories and an equal-scale, north-up world-to-screen transform.
| Member | Summary |
|---|---|
static (double, double, double, double) Bounds(WellMap map) | World bounds of everything drawn (surface locations, paths, section line), padded; never zero-sized. |
static List<(double, double)> PlanPath(CrossSectionWell w, DepthUnit unit, int samples = 60) | Plan-view path of a well (easting, northing in unit): surface location plus trajectory offsets. |
MapView class
Host-independent plan view of wells: surface locations, labels, plan-view paths, grid, scale bar and north arrow at equal scale, north up. Drag pans and the wheel zooms about the pointer; a click selects a well. In DrawSectionMode a drag draws the section line (SectionLineDrawn), and String) turns it into a cross-section.
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
IReadOnlyList<AccessibleItem> AccessibleChildren { get; } | The view's elements (tracks, wells...) with their state, for assistive technology. |
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
bool DrawSectionMode { get; set; } | When true, a drag draws a straight section line instead of panning. |
CrossSectionWell HoveredWell { get; } | The well under the pointer, or null. |
WellMap Map { get; set; } | The map shown. |
CrossSectionWell SelectedWell { get; } | The selected well, or null. |
event EventHandler<IReadOnlyList<(double, double)>> SectionLineDrawn | A section line was drawn (world coordinates). |
event EventHandler<CrossSectionWell> WellSelected | A well was selected (null = cleared). |
bool HandleKey(ViewKey key, ViewModifiers modifiers = None) | Keys: arrows pan 10 %, + / - zoom, Home fits, Tab / Shift+Tab select wells in turn, Escape ends section drawing and clears the selection. |
bool HandleMouseHover(SKPoint point) | Pointer moved with no button pressed; true requests a redraw. |
bool HandleMouseLeave() | Pointer left the view; true requests a redraw. |
bool HandleMouseWheel(SKPoint point, float delta) | Wheel over the view (delta > 0 = away from the user); true when consumed. |
bool HandlePinch(SKPoint center, float scale) | Pinch zooms about the pinch centre (the map point under the fingers stays put). |
bool HandleTwoFingerPan(SKPoint delta) | Two-finger drag pans (the map follows the fingers). |
static double NiceStep(double raw) | A 1 / 2 / 5 x 10^n step not smaller than raw. |
SKRect Plot() | The map area on screen. |
SKPoint ToScreen(double x, double y) | World (easting, northing) to screen (north up, equal scale). |
(double, double) ToWorld(SKPoint s) | Screen to world (easting, northing). |
CrossSectionWell WellAt(SKPoint s) | The well whose surface marker is within the environment's pick radius of s. |
void ZoomToFit() | Fits all wells, paths and the section line in the view. |
MarkerEditHistory class
Undo / redo history of marker edits (bounded).
| Member | Summary |
|---|---|
bool CanRedo { get; } | True when there is an edit to redo. |
bool CanUndo { get; } | True when there is an edit to undo. |
int Capacity { get; set; } | Maximum number of edits kept. |
void Push(MarkerMove move) | Records an edit (clears the redo list). |
MarkerMove Redo() | Redoes the last undone edit; null when none. |
static float Snap(float md, float increment) | Snaps an MD to increment (0 = no snapping). |
MarkerMove Undo() | Undoes the last edit; null when none. |
MarkerEditKind enum
Kind of marker edit: move, add or remove.
| Member | Summary |
|---|---|
Move | A top moved. |
Add | A top added. |
Remove | A top removed. |
MarkerKind enum
Whether a depth marker is a formation top or a fluid contact.
| Member | Summary |
|---|---|
Top | A formation top. |
FluidContact | A fluid contact (GOC, OWC...). |
MarkerMatching static class
Which markers are "the same top": the canonical unit (marker UnitId, else the lexicon's resolution of its name), else the normalized name. Used by correlation lines, flattening, cross-section surfaces and duplicate-pick checks, so "Top Draupne" and "DRAUPNE FM" correlate when a lexicon knows both.
| Member | Summary |
|---|---|
static DepthMarker Find(IEnumerable<DepthMarker> markers, string nameOrKeyName) | The marker matching nameOrKeyName (by unit or normalized name). |
static string Key(DepthMarker m) | Matching key of a top: its stratigraphic unit (unit:ID) when known, else the normalized name. |
static string KeyOf(string name) | Matching key of a name: unit:ID when the lexicon resolves it, else name: plus the normalized name. |
MarkerMove class
A marker edit: a move (MD before / after), an addition or a removal — raised on commit and kept for undo / redo.
| Member | Summary |
|---|---|
MarkerMove(DepthMarker marker, float from, float to, string wellTitle = null) | A move of a top from one depth to another (optionally in a correlation well). |
float From { get; } | Depth before. |
int Index { get; } | Position in its list of an added or removed top (undo restores it there). |
MarkerEditKind Kind { get; } | Move, add or remove. |
DepthMarker Marker { get; } | The top edited. |
IList<DepthMarker> Owner { get; } | The marker list an addition / removal applies to. |
float To { get; } | Depth after. |
string WellTitle { get; } | Correlation panels: which well the marker belongs to. |
static MarkerMove Added(DepthMarker marker, IList<DepthMarker> owner) | A marker added to owner (undo removes it). |
static MarkerMove Removed(DepthMarker marker, IList<DepthMarker> owner, int index) | A marker removed from owner at index (undo restores it there). |
PanelExport static class
PDF export of multi-well panels with the same page template, title, footer and trademark footnote as single wells: correlation panels (paged at the exact print scale on a shared depth window; fitted on one page when flattened or at scale 0) and cross-sections (one page each; several sections in one document).
| Member | Summary |
|---|---|
static List<(float, float)?> CorrelationPages(CorrelationPanel panel, WellborePrintOptions o, WellboreTheme theme = null) | The depth windows of the pages (axis units), or a single null window for one fitted page. |
static int ToPdf(CorrelationPanel panel, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Writes a correlation panel as PDF; returns the number of pages. |
static int ToPdf(CrossSectionPanel panel, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Writes a correlation panel as PDF; returns the number of pages. |
static int ToPdf(IReadOnlyList<CrossSectionPanel> sections, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Writes a correlation panel as PDF; returns the number of pages. |
PaperSize struct
Paper size in PDF points (1/72 in).
| Member | Summary |
|---|---|
PaperSize(float width, float height, string name) | A paper size in points (1/72 inch). |
static PaperSize A3 { get; } | ISO A3. |
static PaperSize A4 { get; } | ISO A4. |
float Height { get; } | Height (points). |
static PaperSize Letter { get; } | US Letter. |
string Name { get; } | Name. |
static PaperSize Tabloid { get; } | US Tabloid. |
float Width { get; } | Width (points). |
PaperSize Landscape() | The same paper in landscape. |
Paths static class
Path construction for SkiaSharp 4 (the repo's version): every path is built with SKPathBuilder and detached — SKPath mutators are obsolete there. Uses only MoveTo / LineTo / CubicTo / Close / Detach, the builder API used throughout the repo. Callers dispose the returned path.
| Member | Summary |
|---|---|
static SKPath Build(Action<SKPathBuilder> draw) | Builds a path with a path builder. |
static SKPath Circle(float cx, float cy, float r) | Circle as four cubic arcs. |
static SKPath Polygon(SKPoint[] pts) | A closed polygon. |
static SKPath Polyline(IReadOnlyList<SKPoint> pts, bool close = false) | A polyline through the points (closed when close). |
static void QuadTo(SKPathBuilder b, float x0, float y0, float qx, float qy, float x, float y) | Quadratic segment as the exactly equivalent cubic (from the current point p0). |
static SKPath Rect(SKRect r) | A rectangle as a path. |
PatternElement struct
One pattern element in screen space.
| Member | Summary |
|---|---|
PatternElement(bool isLine, float x1, float y1, float x2, float y2, float radius, bool filled) | Creates a pattern element (line or circle). |
bool Filled { get; } | Filled circle. |
bool IsLine { get; } | True for a line, false for a circle. |
float Radius { get; } | Circle radius. |
float X1 { get; } | Line start x / circle centre x. |
float X2 { get; } | Line end x. |
float Y1 { get; } | Line start y / circle centre y. |
float Y2 { get; } | Line end y. |
Plan class
A print plan: the pages a document is split into at the chosen scale and paper.
| Member | Summary |
|---|---|
Plan(WellboreDocument printDoc, IReadOnlyList<PrintPage> pages, (float, float) first, (float, float) other, IReadOnlyList<LegendEntry> legend) | Creates a print plan: the document printed, its pages, the track chrome of first and other pages, and the legend. |
(float, float) FirstChrome { get; } | Space above / below the plot on the first page. |
IReadOnlyList<LegendEntry> Legend { get; } | Legend entries printed on the last page. |
(float, float) OtherChrome { get; } | Space above / below the plot on the other pages. |
IReadOnlyList<PrintPage> Pages { get; } | The pages. |
WellboreDocument PrintDocument { get; } | The document as printed (true depth scale). |
PrintPage struct
One printed page: its depth slice and the exact plot height that realises the scale.
| Member | Summary |
|---|---|
PrintPage(int index, int count, float top, float bottom, float plotHeight, bool first, bool last) | Creates a page: position, depth window, plot height and first / last flags. |
float Bottom { get; } | Bottom depth of the page. |
int Count { get; } | Number of pages. |
int Index { get; } | Page number (0-based). |
bool IsFirst { get; } | True for the first page. |
bool IsLast { get; } | True for the last page. |
float PlotHeight { get; } | Plot height in points; equals (Bottom - Top) x points-per-depth-unit. |
float Top { get; } | Top depth of the page (axis unit). |
PrintPlanner static class
Pure pagination for scaled printing.
| Member | Summary |
|---|---|
static List<PrintPage> Plan(DepthAxis axis, WellborePrintOptions o, float chromeFirst, float chromeOther) | Slices [top, bottom] into pages. chromeFirst / chromeOther = vertical space on a page that is not plot (margins, header block, track headers, footer). ScaleRatio 0 = fit on one page. |
static float PointsPerDepthUnit(DepthUnit unit, float ratio) | Points on paper per axis depth unit at 1:ratio (ft: 864/R, m: 2834.65/R). |
PrintTokens static class
Footer and title tokens: {well}, {title}, {reference}, {range}, {scale}, {page}, {pages}, {date}.
| Member | Summary |
|---|---|
static string Expand(string template, IReadOnlyDictionary<string, string> values) | Replaces the {token}s of template with values; unknown tokens are kept as written. |
SectionGeometry static class
Pure section geometry.
| Member | Summary |
|---|---|
static double Length(IReadOnlyList<(double, double)> line) | Length of a polyline. |
static (double, double) LocalMetres(double lat, double lon, double lat0, double lon0) | Latitude / longitude to local x (east) / y (north) in metres about a reference point (equirectangular) — adequate over a field-scale section (a few to tens of km); use properly projected coordinates beyond that. |
static (double, double) Project(IReadOnlyList<(double, double)> line, double x, double y) | Closest point on the polyline: distance along it and perpendicular offset (positive left of travel). Points beyond the first / last vertex project onto the extended end segments (negative distance before the start, beyond the length after the end). |
SectionWellPath class
A well path projected onto a cross-section line: distance along the line, TVDSS and MD.
| Member | Summary |
|---|---|
List<(double, double, double)> Points { get; } | (distance along line, TVDSS, MD) in the panel unit, top to TD. |
double SurfaceOffset { get; set; } | Perpendicular distance of the surface location from the line (positive left of travel). |
CrossSectionWell Well { get; set; } | The well projected. |
(double, double)? At(double mdDoc) | Section position and TVDSS of a measured depth (document unit), or null. |
TrackChrome static class
Shared track chrome: background, header, depth grid, depth labels. One implementation for every family.
| Member | Summary |
|---|---|
static void DrawBackground(SKCanvas canvas, SKRect bounds, SKColor color) | Fills a track background. |
static void DrawDepthGrid(SKCanvas canvas, SKRect plot, DepthMapper mapper, float axisTop, float axisBottom, float major, float minor, SKColor gridColor) | Minor + major depth grid lines across the plot, using the shared mapper. |
static void DrawDepthLabels(SKCanvas canvas, SKRect plot, DepthMapper mapper, float axisTop, float axisBottom, float major, WellboreTheme theme, string format = "0.0") | Depth labels at major steps, centred in the plot, just above each major line. |
static void DrawHeader(SKCanvas canvas, SKRect header, string title, string subtitle, WellboreTheme theme) | Draws a track header: box, title and subtitle. |
TrackEdit class
An undoable edit made inside a track (e.g. a curve depth shift): description plus undo / redo actions.
| Member | Summary |
|---|---|
TrackEdit(string trackId, string description, Action undo, Action redo) | Creates an edit: its track, description and undo / redo actions. |
string Description { get; } | What the edit did. |
Action Redo { get; } | Applies the edit again. |
string TrackId { get; } | Id of the track edited (annotations: "annotations"). |
Action Undo { get; } | Reverts the edit. |
TrackEditHistory class
Bounded undo / redo stack of track edits.
| Member | Summary |
|---|---|
bool CanRedo { get; } | True when there is an edit to redo. |
bool CanUndo { get; } | True when there is an edit to undo. |
int Capacity { get; set; } | Maximum number of edits kept. |
void Push(TrackEdit e) | Records an edit (clears the redo list). |
TrackEdit Redo() | Redoes the last undone edit; null when none. |
TrackEdit Undo() | Undoes the last edit; null when none. |
TrackFrameLayout struct
Computed rectangles of one track.
| Member | Summary |
|---|---|
TrackFrameLayout(int index, SKRect track, SKRect header, SKRect reserve, SKRect plot) | Creates the layout of a track: index and its track, header, reserve and plot rectangles. |
SKRect HeaderBounds { get; } | The header. |
int Index { get; } | Position of the track. |
SKRect PlotBounds { get; } | Depth-mapped area. Identical top/bottom for every track of a view. |
SKRect ReserveBounds { get; } | Uniform band between header and plot (e.g. wellhead stack); zero height when unused. |
SKRect TrackBounds { get; } | The whole track. |
TrajectoryTrack class
Well path from the document's depth reference (minimum-curvature survey).
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
bool IsDepthIndexed { get; } | False for tracks that are not drawn against depth (tables, legends, header blocks): the view then skips depth grid, tops, break marks and cursor for them, and they may use the full height below the header. |
double? SectionAzimuth { get; set; } | Section azimuth in degrees; null = closure azimuth. |
bool ShowUncertainty { get; set; } | Draw position-uncertainty ellipses in the section and plan views (error sources and sigma from the environment's survey.uncertainty). |
string Subtitle { get; } | Second header line (units, mnemonic); null = none. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
TrajectoryView View { get; set; } | What the track shows. |
const string TypeKeyValue = "trajectory" | Type key of the track (serialization). |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
TrajectoryView enum
What a trajectory track shows (deviation, vertical section or plan view).
| Member | Summary |
|---|---|
Deviation | Inclination (0-90°), azimuth (0-360°) and dogleg severity against depth. |
Section | Vertical section: horizontal displacement along the closure azimuth vs TVD (not depth-indexed). |
Plan | Plan view: northing vs easting (not depth-indexed). |
TravellingCylinderView class
Travelling-cylinder plot: offset wells around the reference well by direction (from north) and distance in the plane normal to it.
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
double MaxRadius { get; set; } | Largest distance shown (m); 0 = from the data. |
AntiCollisionResult Result { get; set; } | The scan shown. |
UiText static class
User-interface texts through the configured ILabelProvider (environment resources.labelFiles); the fallback is the built-in English text, so without a labels file nothing changes. Keys are listed in the documentation.
| Member | Summary |
|---|---|
static string Format(string key, string fallback, object[] args) | A configured format string ({0}, {1}...) filled with args. |
static string Get(string key, string fallback) | The configured text for key, else fallback. |
UnknownTrack class
Placeholder for a track type whose family is not loaded. Draws a notice and round-trips its payload untouched.
Inherits / implements: WellTrack, ITrackFrame
| Member | Summary |
|---|---|
UnknownTrack(string typeKey) | A placeholder for a track type that is not registered (its payload is kept unchanged). |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
void DrawContent(SKCanvas canvas, WellTrackContext ctx) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
JsonObject SavePayload() | Type-specific settings for persistence. |
ViewKey enum
Keys a host forwards to a view (map your framework's key codes to these).
| Member | Summary |
|---|---|
Up | Up arrow. |
Down | Down arrow. |
Left | Left arrow. |
Right | Right arrow. |
PageUp | Page Up. |
PageDown | Page Down. |
Home | Home. |
End | End. |
Plus | Plus (zoom in). |
Minus | Minus (zoom out). |
Tab | Tab (focus / selection; Shift for backwards). |
Enter | Enter. |
Escape | Escape. |
Delete | Delete. |
Z | Z (with Control: undo). |
Y | Y (with Control: redo). |
ViewModifiers enum
Modifier keys held with a ViewKey.
| Member | Summary |
|---|---|
None | No modifier. |
Shift | Shift held. |
Control | Control held. |
Alt | Alt held. |
ViewSetting class
A setting a view publishes for its host to persist (name, type, default, current value, description).
Inherits / implements: EventArgs
| Member | Summary |
|---|---|
ViewSetting(string name, Type type, object defaultValue, object value, string description, IReadOnlyList<string> choices = null) | Creates a setting: name, type, default, value, description and allowed choices. |
IReadOnlyList<string> Choices { get; } | Allowed values when the setting is a choice (hosts may offer a drop-down). |
object DefaultValue { get; } | Default value. |
string Description { get; } | Description. |
string Name { get; } | Setting name. |
Type Type { get; } | Value type. |
object Value { get; } | Current value. |
ViewSurface abstract class
Host-independent base of the interactive views (WellboreView, CorrelationView, CrossSectionView): position and size, a Draw(SKCanvas) entry point, pointer input, and two events a UI host wires up - Invalidated (redraw me) and SettingChanged (persist this value). Any SkiaSharp host (WinForms, WPF, MAUI, Avalonia, a Beep.Skia adapter, a server rendering to PDF) can use the views; nothing here depends on a UI framework.
| Member | Summary |
|---|---|
IReadOnlyList<AccessibleItem> AccessibleChildren { get; } | The view's elements (tracks, wells...) with their state, for assistive technology. |
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
float Height { get; set; } | Height. |
string Name { get; set; } | View name. |
IReadOnlyDictionary<string, object> Settings { get; } | Last published value of every setting. |
float Width { get; set; } | Width. |
float X { get; set; } | Left edge (host coordinates). |
float Y { get; set; } | Top edge. |
event EventHandler Invalidated | The view needs to be redrawn (hosts call their own invalidate / refresh). |
event EventHandler<ViewSetting> SettingChanged | A persistable setting changed (hosts store it, e.g. in their document or node properties). |
void Draw(SKCanvas canvas) | Draws the view at (X, Y, Width, Height) on canvas. |
bool HandleKey(ViewKey key, ViewModifiers modifiers = None) | A key with modifiers; true when handled (the host redraws). See each view for its keys. |
bool HandleMouseDown(SKPoint point) | Pointer pressed; true when the view handled it. |
bool HandleMouseHover(SKPoint point) | Pointer moved with no button pressed; true requests a redraw. |
bool HandleMouseLeave() | Pointer left the view; true requests a redraw. |
bool HandleMouseMove(SKPoint point) | Pointer moved with a button pressed; true when the view handled it. |
bool HandleMouseUp(SKPoint point) | Pointer released; true when the view handled it. |
bool HandleMouseWheel(SKPoint point, float delta) | Wheel over the view (delta > 0 = away from the user); true when consumed. |
bool HandlePinch(SKPoint center, float scale) | Touch pinch about center; scale > 1 spreads the fingers (zoom in) - relative to the previous event. |
bool HandleTwoFingerPan(SKPoint delta) | Two-finger drag by delta pixels since the previous event (scrolls / pans). |
WellboreAnnotation class
A note, arrow or highlighted interval drawn over the tracks and saved with the document. Depths are in the document's axis unit (MD); horizontal positions are fractions (0-1) of the plot width of TrackId (null = across all tracks).
| Member | Summary |
|---|---|
string Author { get; set; } | Who added it. |
string Color { get; set; } | Colour (#rrggbb). |
DateTime Date { get; set; } | When it was added (UTC). |
float Depth { get; set; } | Depth of the annotation (document axis unit, MD); the top of a highlight. |
string Id { get; set; } | Annotation id. |
AnnotationKind Kind { get; set; } | Note, arrow or highlight. |
string Text { get; set; } | Text shown. |
float? ToDepth { get; set; } | Bottom of a highlight, or the depth an arrow points to. |
float? ToX { get; set; } | Horizontal fraction an arrow points to. |
string TrackId { get; set; } | Track the annotation belongs to; null = across all tracks. |
float X { get; set; } | Horizontal position as a fraction (0-1) of the plot width. |
WellboreAnnotation Clone() | A copy of the annotation. |
WellboreDocument class
A well view: one depth axis, formation tops, and ordered tracks from any family.
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
List<WellboreAnnotation> Annotations { get; } | Notes, arrows and highlighted intervals drawn over the tracks. |
DepthAxis Axis { get; set; } | The depth axis. |
float AxisOffset { get; set; } | Shift subtracted from axis values (axis units): 0 normally; correlation panels set it to a top's depth to flatten on it. |
string Crs { get; set; } | Coordinate reference system of the well's location (maps and sections warn when wells differ). |
WellDepthReference DepthReference { get; set; } | Datum and survey; enables TVD / TVDSS axes (data stays MD-indexed). |
List<DepthMarker> Markers { get; } | Formation tops and fluid contacts. |
string Name { get; set; } | Document name. |
Dictionary<string, string> Properties { get; } | Free-form metadata (source file, data standard, operator, field, UWI…). |
long Revision { get; set; } | Change counter for render caches. Call Touch after editing tracks or data in place. |
bool ShowAnnotations { get; set; } | Draw annotations (screen and print). |
List<WellTrack> Tracks { get; } | The tracks, left to right. |
string WellName { get; set; } | Well name. |
const int CurrentSchemaVersion = 2 | v1 = documents written before versioning; v2 adds the explicit version (structure unchanged). |
static IReadOnlyDictionary<int, Action<JsonObject>> Migrations | Migration steps (key = from-version); add one per future format change. |
void ConvertTo(DepthUnit unit) | Converts the whole document to unit: axis range, explicit grid steps (re-rounded to 1-2-5 values), markers, and every track's depth data. Idempotent when already in that unit. |
T FindTrack<T>(Func<T, bool> predicate = null) | The first track of a type (matching predicate when given), or null. |
static WellboreDocument FromJson(string json) | Reads a document (older versions upgraded; unknown track types kept as placeholders). |
IList<WellTrack> ImportTracks(WellboreDocument source, Func<WellTrack, bool> filter = null, bool includeMarkers = false) | Copies tracks from another document (e.g. a parsed LAS file in feet) into this one, converting their depth data into this document's axis unit. Tracks are deep-copied through the registry and payloads. |
bool SetAxisReference(DepthReference target) | Switches the axis to MD, TVD or TVDSS, converting the axis range; track data stays MD. Returns false when TVD/TVDSS is requested without a survey. |
string ToJson(bool indented = false) | Serializes the document (tracks by type key with their payloads); indented for readable files. |
void Touch() | Marks the document changed (drawing caches rebuild). |
WellboreExport static class
Printing and export of well views: exact depth scale, pagination with repeated track headers, header block, footer, legend; PDF (multi-page), SVG and PNG (continuous) through SkiaSharp.
| Member | Summary |
|---|---|
static float HeaderHeight { get; } | Track header height on printed pages (from the environment). |
static float TrackGap { get; } | Gap between tracks on printed pages (from the environment). |
const float BlockGap = 6 | Gap between page blocks (points). |
static void DrawFooter(SKCanvas canvas, WellborePrintOptions o, float pageH, IReadOnlyDictionary<string, string> tokens, WellboreTheme th) | Draws a page footer: rule, left and right texts (tokens expanded) and the trademark footnote in the centre. |
static Dictionary<string, string> FooterTokens(WellborePrintOptions o, string well, string reference, string range, string scale, int page, int pages) | The footer tokens for a page (well, title, reference, range, scale, page, pages, date). |
static float PageHeight(Plan plan, PrintPage page, WellborePrintOptions o) | Height of a page: paper height, or as tall as needed for continuous output. |
static Plan Paginate(WellboreDocument doc, WellborePrintOptions options = null, WellboreTheme theme = null) | Pages for a document (UI print preview uses this too). |
static bool RenderPage(SKCanvas canvas, Plan plan, PrintPage page, WellborePrintOptions o, WellboreTheme theme = null) | Draws one page. Returns true when the legend still needs its own page (did not fit). |
static int ToPdf(WellboreDocument doc, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Multi-page PDF. Returns the number of pages written. |
static void ToPng(WellboreDocument doc, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Single continuous PNG page at Dpi. |
static void ToSvg(WellboreDocument doc, Stream stream, WellborePrintOptions options = null, WellboreTheme theme = null) | Single continuous SVG page (vector). |
WellboreInteractionMode enum
How the canvas uses pointer gestures.
| Member | Summary |
|---|---|
Explore | Drag pans depth, click selects, hover shows the depth cursor, wheel zooms (depth track) or scrolls. Headers still drag the component. |
Design | All gestures go to the diagram editor (move/resize the component). |
WellboreIssue class
One validation finding for a wellbore view (document-, track- or item-level).
| Member | Summary |
|---|---|
WellboreIssue(WellboreIssueSeverity severity, string code, string message, string trackId = null, string itemId = null) | Creates an issue: severity, code, message and optionally the track and item concerned. |
string Code { get; } | Stable code: WV = view / document, WL = logs, WS / WB / WA = schematic, barriers, annuli. |
string ItemId { get; } | Item concerned (select it in the view). |
string Message { get; } | What is wrong. |
WellboreIssueSeverity Severity { get; } | How serious the issue is. |
string TrackId { get; } | Track concerned. |
string ToString() | Severity, code and message on one line. |
WellboreIssueSeverity enum
Severity of a validation issue: error, warning or info.
| Member | Summary |
|---|---|
Info | Information. |
Warning | Should be reviewed. |
Error | The view is not valid. |
WellborePrintOptions class
How a well view is printed / exported.
| Member | Summary |
|---|---|
bool Continuous { get; set; } | One continuous page as tall as the scale requires (plotters, PDF viewers) instead of paging. |
(float, float)? DepthRange { get; set; } | Depth range to print (axis units); null = whole axis. |
float Dpi { get; set; } | Raster exports (PNG) resolution. |
float FooterHeight { get; set; } | Height of the page footer (points). |
string FooterLeft { get; set; } | Left footer text (tokens: {well}, {title}, {reference}, {range}, {scale}, {page}, {pages}, {date}). |
string FooterRight { get; set; } | Right footer text (same tokens). |
float HeaderBlockHeight { get; set; } | Height of the header block (points). |
Dictionary<string, string> HeaderFields { get; } | Extra header-block fields (label -> value), e.g. "Rig", "Logging company", "Revision". |
bool IncludeHeaderBlock { get; set; } | Print the well header block on the first page. |
bool IncludeLegend { get; set; } | Print the legend on the last page. |
float Margin { get; set; } | Page margin (points). |
PaperSize Paper { get; set; } | Paper (default from the environment). |
DateTime PrintDate { get; set; } | Date printed on the pages. |
float ScaleRatio { get; set; } | Depth scale 1:ScaleRatio (e.g. 500 = 1:500). 0 = fit the whole range on one page. |
static IReadOnlyCollection<string> TemplateNames { get; } | Names of the page templates in the environment (printing.templates). |
string Title { get; set; } | Title printed in the header; null = the document name. |
static WellborePrintOptions FromTemplate(string name) | Print options from a named template of the environment: the printing defaults, then what the template sets. |
WellboreRenderer static class
Draws a WellboreDocument: shared frame layout, headers, one depth grid mapping, every track's content, and tops across all tracks. Returns per-track contexts for hit-testing.
| Member | Summary |
|---|---|
static (Func<float, float>, Func<float, float>) DepthTransform(WellboreDocument document) | MD (axis unit) <-> axis value transform for TVD / TVDSS axes; (null, null) for MD or without a survey. |
static IReadOnlyList<WellTrackContext> Draw(SKCanvas canvas, SKRect bounds, WellboreDocument document, WellboreTheme theme = null, float trackGap = 6, float headerHeight = 28, WellboreViewState view = null, bool drawOverlay = true, Func<WellTrack, bool> drawContentOf = null, float? topReserve = null) | Lays out and draws every track of a document in bounds (tracks, markers, annotations, selection, overlay); returns the track contexts for hit testing and readouts. |
static void DrawOverlay(SKCanvas canvas, IReadOnlyList<WellTrackContext> contexts, WellboreViewState view, WellboreTheme theme = null) | Dynamic overlay (depth cursor + readouts). Hosts that cache the static scene (e.g. as an SKPicture) redraw only this on hover. |
static (string, string) HitTest(IReadOnlyList<WellTrackContext> contexts, float x, float y) | (track id, object id) under a point, using contexts from the last draw. |
static DepthMarker HitTestMarker(IReadOnlyList<WellTrackContext> contexts, WellboreDocument document, float x, float y, float tolerance = 4) | Marker within tolerance px of a point in a depth-indexed plot (for dragging), nearest first. |
static IReadOnlyList<WellTrackContext> Layout(SKRect bounds, WellboreDocument document, WellboreTheme theme = null, float trackGap = 6, float headerHeight = 28, WellboreViewState view = null, float? topReserve = null) | Layout only (no drawing): the contexts a draw would use. |
static IEnumerable<DepthMarker> VisibleMarkers(WellboreDocument document, DepthAxis shown, Func<float, float> mdToAxis = null) | Markers inside the shown window (zoom / printed page) — never pinned to the plot edge. Marker depths are MD; on TVD, TVDSS or flattened axes pass the view's MD-to-axis transform so the comparison happens in axis values. |
WellboreTheme class
Colours, fonts and line weights shared by every well view (defaults = the original log look).
| Member | Summary |
|---|---|
SKColor Cursor { get; set; } | Depth cursor colour. |
static WellboreTheme Default { get; } | Theme of the current environment (built-in colours unless the environment overrides them). |
float DepthFontSize { get; set; } | Depth label font size. |
SKColor DepthLabel { get; set; } | Depth labels. |
SKColor DepthTrackBackground { get; set; } | Background of depth tracks. |
SKColor Frame { get; set; } | Track frames. |
float FrameWidth { get; set; } | Frame line width. |
SKColor Grid { get; set; } | Grid lines. |
SKColor HeaderBorder { get; set; } | Header border. |
SKColor HeaderFill { get; set; } | Header background. |
float MarkerWidth { get; set; } | Line width of tops and contacts. |
SKColor Selection { get; set; } | Selection highlight colour. |
float SubtitleFontSize { get; set; } | Track subtitle font size. |
SKColor Text { get; set; } | Text. |
float TitleFontSize { get; set; } | Track title font size. |
SKColor TrackBackground { get; set; } | Background of the tracks. |
static WellboreTheme FromSettings(ThemeSettings s) | A theme from environment settings (invalid colours fall back to the built-in ones). |
static SKColor Parse(string hex, SKColor fallback) | #rrggbb / #aarrggbb -> colour; fallback when null or invalid. |
WellboreValidator static class
Validates a whole wellbore view: document checks here, track data through each track's WellboreDocument) (families add their own rules).
| Member | Summary |
|---|---|
static double DoglegWarning { get; } | Dogleg severity above which a survey station is flagged (environment survey.doglegWarning, default 15 deg / 100 ft or 30 m). |
static string Summary(IEnumerable<WellboreIssue> issues) | One-line summary, e.g. "2 errors, 3 warnings, 1 info". |
static IReadOnlyList<WellboreIssue> Validate(WellboreDocument doc) | Validates a view: axis, depth reference, tracks and every track's own checks. |
WellboreView class
WellboreView: descriptions for assistive technology.
Inherits / implements: ViewSurface
| Member | Summary |
|---|---|
IReadOnlyList<AccessibleItem> AccessibleChildren { get; } | The view's elements (tracks, wells...) with their state, for assistive technology. |
string AccessibleDescription { get; } | What the view shows now, for screen readers (updated with the view). |
string AccessibleName { get; } | Short name for assistive technology. |
bool AllowAnnotationEditing { get; set; } | Pressing on an annotation drags it and Delete removes it (off by default); a click always selects it and raises AnnotationClicked. |
bool AllowMarkerEditing { get; set; } | Allow dragging tops / contacts in Explore mode. |
Func<DateTime> Clock { get; set; } | Clock for staleness (injectable for tests). |
WellboreDocument Document { get; set; } | The document shown. |
string DocumentJson { get; set; } | The document as JSON (persisted by hosts). |
string FocusedTrackId { get; set; } | The track with keyboard focus (Tab / Shift+Tab); drawn with a focus frame. |
bool FollowLatest { get; set; } | Keep the newest data at the bottom of the view (window = [latest - FollowSpan, latest]). |
float FollowSpan { get; set; } | Depth span shown in follow mode (axis units). |
float HeaderHeight { get; set; } | Track header height (pixels). |
WellboreInteractionMode InteractionMode { get; set; } | Explore (zoom, pan, select, edit) or leave pointer input to the host. |
IReadOnlyList<WellTrackContext> LastContexts { get; } | Per-track contexts from the last draw (hit-testing, overlays). |
string LastLiveBadge { get; } | Text of the live badge from the last draw (diagnostics / tests). |
ILiveStatus Live { get; set; } | Live feed shown by this canvas (follow mode, LIVE / STALE badge); null = static data. |
MarkerEditHistory MarkerHistory { get; } | Marker edit history (undo / redo). |
float MarkerSnap { get; set; } | Snap dragged markers to this MD increment (0 = off). |
int SceneBuilds { get; } | Number of times the static scene was (re)built — diagnostics / tests. |
WellboreAnnotation SelectedAnnotation { get; set; } | The annotation last clicked or set by the host; Delete removes it. |
SKColor SurfaceColor { get; set; } | Background colour of the view. |
WellboreTheme Theme { get; set; } | Theme. |
TrackEditHistory TrackEdits { get; } | Undo / redo of edits made inside tracks (curve depth shifts...). |
float TrackGap { get; set; } | Gap between tracks (pixels). |
WellboreViewState View { get; } | Visible depth window, cursor and selection. |
event EventHandler<WellboreAnnotation> AnnotationClicked | An annotation was clicked (not dragged). |
event EventHandler<MarkerMove> MarkerEdited | Any marker edit (move, add, remove), including undo / redo; see Kind. |
event EventHandler<MarkerMove> MarkerMoved | Raised when a marker drag is committed (also for undo / redo). |
event EventHandler<(string, string)> SelectionChanged | Raised when a click selects (or clears) an item: (track id, item id). |
event EventHandler<TrackEdit> TrackEdited | A track edit was committed, undone or redone. |
void AddAnnotation(WellboreAnnotation a) | Adds an annotation (undoable). |
DepthMarker AddMarker(string name, float md, MarkerKind kind = Top, string contactType = null) | Adds a top or contact at an MD (e.g. picked from a context menu). |
WellboreAnnotation AnnotationAt(float x, float y) | The topmost annotation at a screen point (last drawn wins). |
void BeginCurveShift(string trackId, string key) | Dragging inside trackId now shifts key (e.g. a curve mnemonic) instead of panning. |
void CommitDocumentChanges() | Re-persists and repaints after editing Document in place. |
void EndCurveShift() | Ends shift mode (dragging pans again). |
int ExportPdf(Stream stream, WellborePrintOptions options = null) | Exports the whole document (not just the visible window) as a multi-page PDF at scale. |
void ExportPng(Stream stream, WellborePrintOptions options = null) | Exports the document as PNG. |
void ExportSvg(Stream stream, WellborePrintOptions options = null) | Exports the document as SVG. |
bool HandleKey(ViewKey key, ViewModifiers modifiers = None) | Keys: Up / Down scroll 10 %, PageUp / PageDown a screen, Home / End the ends, + / - zoom, Tab / Shift+Tab focus tracks, Escape clears the selection and ends shift mode, Delete removes the selected annotation (when annotation editing is on), Ctrl+Z / Ctrl+Y undo / redo. |
bool HandleMouseHover(SKPoint point) | Pointer moved with no button pressed; true requests a redraw. |
bool HandleMouseLeave() | Pointer left the view; true requests a redraw. |
bool HandleMouseWheel(SKPoint point, float delta) | Wheel over the view (delta > 0 = away from the user); true when consumed. |
bool HandlePinch(SKPoint center, float scale) | Pinch zooms about the pinch centre (depth under the fingers stays put). |
bool HandleTwoFingerPan(SKPoint delta) | Two-finger vertical drag scrolls (content follows the fingers). |
(string, string) HitTest(float x, float y) | The track and item at a screen point. |
void LoadFromJsonFile(string path) | Loads a document file. |
void RecordTrackEdit(TrackEdit edit) | Records an edit already applied in code (e.g. SchematicTrack.AddEquipment) so it can be undone like a drag. |
bool RedoLast() | Redoes the most recently undone edit; false when there is none. |
bool RedoMarker() | Redoes the last undone top edit. |
bool RedoTrackEdit() | Redoes the last undone track edit. |
bool RemoveAnnotation(string id) | Removes an annotation by id (undoable); false when absent. |
bool RemoveMarker(DepthMarker marker) | Removes a marker (undoable); false when it is locked or not in the document. |
void ResetView() | Shows the whole axis. |
void SaveToJsonFile(string path) | Saves the document to a file. |
bool UndoLast() | Undoes the most recent edit (tops or track edits); false when there is none. |
bool UndoMarker() | Undoes the last top edit. |
bool UndoTrackEdit() | Undoes the last track edit (curve shift, schematic edit, annotation). |
IReadOnlyList<WellboreIssue> Validate() | Validates the whole view (document, survey and every track's data). |
void ZoomIn() | Zooms in by 2 about the centre. |
void ZoomOut() | Zooms out by 2 about the centre. |
bool ZoomToItem(string itemId) | Zooms to an item (equipment, interval…) using the first track that knows its depth range; selects it. |
void ZoomToRange(float top, float bottom) | Shows a depth range (axis values). |
WellboreViewState class
Interactive view of a well: visible depth window inside the document axis, cursor depth and selection. Pure and deterministic (all gestures are depth arithmetic), so hosts and tests drive it directly.
| Member | Summary |
|---|---|
float? CursorDepth { get; set; } | Depth under the pointer (axis units); null = no cursor. |
float CursorX { get; set; } | Screen x of the pointer (readout box placement). |
bool IsZoomed { get; } | True when a depth window is set (zoomed or scrolled). |
float MinSpan { get; set; } | Absolute smallest visible span in axis units; 0 (default) = display.minZoomSpan converted to the axis's unit. |
float MinSpanFraction { get; set; } | Smallest visible span as a fraction of the full axis (default 1/5000). |
string SelectedItemId { get; set; } | The selected item. |
string SelectedTrackId { get; set; } | The track of the selected item. |
void PanBy(DepthAxis axis, float delta) | Moves the window by delta axis units (positive = deeper). |
void Reset() | Shows the whole axis again. |
void SetRange(DepthAxis axis, float top, float bottom) | Sets the depth window (axis values), clamped to the axis. |
DepthAxis ViewAxis(DepthAxis axis) | Axis clone restricted to the visible window (what the renderer draws). |
(float, float) Window(DepthAxis axis) | Visible window for axis (full axis when not zoomed). |
void ZoomAt(DepthAxis axis, float anchorDepth, float factor) | Zooms by factor (<1 = in) keeping anchorDepth at the same screen position. |
void ZoomTo(DepthAxis axis, float top, float bottom, float margin = 0.5) | Zooms so [top, bottom] fills the view with margin (fraction of the interval) around it. |
WellHeaderBlock static class
Well header block drawn at the top of printed / exported well views.
| Member | Summary |
|---|---|
static void Draw(SKCanvas canvas, SKRect rect, WellboreDocument doc, WellborePrintOptions o, float top, float bottom, WellboreTheme theme = null) | Draws the well header block. |
static IReadOnlyList<(string, string)> Fields(WellboreDocument doc, WellborePrintOptions o, float top, float bottom) | The header block fields: well, UWI, operator, field, depth reference and unit, scale, interval, print date and configured extras. |
WellMap class
Wells on a map (projected easting / northing in Unit) and an optional section line.
Inherits / implements: IJsonPersistable
| Member | Summary |
|---|---|
string Name { get; set; } | Map name. |
List<(double, double)> SectionLine { get; } | Section line vertices (easting, northing); empty until drawn or set. |
DepthUnit Unit { get; set; } | Unit of the coordinates. |
List<CrossSectionWell> Wells { get; } | The wells (surface easting / northing). |
const int CurrentSchemaVersion = 1 | Map schema version written by this library. |
CrossSectionPanel CreateCrossSection(double? maxOffset = null, string name = null) | A cross-section along SectionLine with the wells whose surface lies within maxOffset of it (0 = all wells; null = the environment's crossSection.maxOffset). Null when no line has been drawn. |
static WellMap FromJson(string json) | Reads a map. |
static WellMap FromLatLon(IEnumerable<(WellboreDocument, double, double)> wells) | Adds wells from latitude / longitude (degrees) as local metres about the first well (equirectangular - adequate at field scale; use projected coordinates for larger areas). |
string ToJson() | Serializes the map. |
List<WellboreIssue> Validate() | Checks the wells shown together: coordinate systems (WV060, WV061). |
WellMarkers static class
Formation tops and fluid contacts of a well as document markers - resolved through the lexicons (display name in the environment's culture, unit colour, canonical unit id) - and the chronostratigraphy zones between them; shared by every view family.
| Member | Summary |
|---|---|
static IntervalTrack ChronostratigraphyTrack(WellModel model, DepthUnit unit, float axisBottom, string rank = null) | Chronostratigraphy zones at rank (default: display.chronostratigraphyRank): from each top to the next, the chart unit of that rank enclosing the top's unit, with its colour and age range; consecutive tops in the same chart unit merge. Null when no rank is set or no top resolves to a unit of that rank. |
static List<DepthMarker> FromTops(WellModel model, DepthUnit unit) | Markers for the well's tops and contacts on an axis in unit (MD). |
WellTrack abstract class
A vertical track in a well view. Families subclass this; the shared renderer draws frame, header, depth grid and tops, then calls WellTrackContext) with the common DepthMapper.
Inherits / implements: ITrackFrame
| Member | Summary |
|---|---|
string Background { get; set; } | Background colour (#rrggbb); null = theme default. |
float HeaderHeight { get; set; } | Requested header height; tracks may grow it (e.g. one scale bar per curve). The view uses the tallest. |
string Id { get; set; } | Track id (unique in the document). |
bool IsDepthIndexed { get; } | False for tracks that are not drawn against depth (tables, legends, header blocks): the view then skips depth grid, tops, break marks and cursor for them, and they may use the full height below the header. |
float LeftMargin { get; set; } | Left margin inside the track (pixels). |
string Name { get; set; } | Track title. |
float RightMargin { get; set; } | Right margin inside the track (pixels). |
bool ShowGrid { get; set; } | Draw the depth grid. |
bool ShowHeader { get; set; } | Show the header. |
string Subtitle { get; } | Second header line (units, mnemonic); null = none. |
string TypeKey { get; } | Stable key of the track type, written to documents and used to recreate the track (see WellTrackTypeAttribute). |
float WidthRatio { get; set; } | Relative width of the track. |
TrackEdit CommitDepthShift(string key, float delta, float referenceDepth, string depthUnit) | Commits a previewed shift and returns its undoable edit (null when nothing changed or unsupported). |
void ConvertDepthUnit(DepthUnit from, DepthUnit to) | Converts depth data the track stores in the document axis unit (called by DepthUnit) and Boolean)). Tracks whose data carries its own unit (e.g. schematics) need not override. |
IEnumerable<DepthFeature> DepthFeatures(float plotWidth, DepthAxis axis) | Compressed depth: intervals (axis units) this track needs readable space for. Default none (curves adapt). |
void DrawContent(SKCanvas canvas, WellTrackContext context) | Draws into the plot (and, if needed, the reserve band). Clipped to the track below its header. |
void DrawHeader(SKCanvas canvas, WellTrackContext context) | Draws the header box (default: title + optional subtitle with the shared chrome). |
string HitTest(WellTrackContext context, float x, float y) | Id of the object under a point, or null. |
string HitTestEditable(WellTrackContext context, float x, float y) | The key of an editable item at (x, y) (e.g. a schematic packer or casing shoe), or null; pressing on it drags it. |
(float, float)? ItemDepthRange(string itemId, DepthAxis axis) | Depth range (axis units) of an item, for "zoom to item". |
IEnumerable<LegendEntry> LegendEntries() | Legend items this track contributes to printed / exported views. |
void LoadPayload(JsonObject payload) | Restores the type-specific settings written by SavePayload (null: keep the defaults). |
float PreferredTopReserve(float plotWidth, DepthAxis axis) | Height this track wants above the plot (applied uniformly to all tracks to keep them aligned). |
bool PreviewDepthShift(string key, float delta) | Previews a vertical shift of one item (e.g. a curve by mnemonic) by delta depth units; false if unsupported. |
string ReadoutAt(WellTrackContext context, float depth) | Cursor readout at depth (axis units), e.g. "GR 65.2 API"; null = nothing to show. |
JsonObject SavePayload() | Type-specific settings for persistence. |
SKRect? SelectionBounds(WellTrackContext context, string itemId) | Screen rectangle to highlight for a selected item id (any track may show the same item: cross-highlight). |
IEnumerable<WellboreIssue> Validate(WellboreDocument document) | Track-level validation (called by WellboreValidator); families add their own data rules. |
WellTrackContext class
Everything a track needs to draw: its rectangles, the shared mapper, theme and document.
| Member | Summary |
|---|---|
WellTrackContext(WellTrack track, TrackFrameLayout layout, DepthMapper mapper, WellboreDocument document, WellboreTheme theme) | Creates a drawing context. |
DepthAxis Axis { get; } | The document's depth axis. |
WellboreDocument Document { get; } | The document. |
TrackFrameLayout Layout { get; } | Its layout. |
DepthMapper Mapper { get; } | Depth to screen mapping. |
WellboreTheme Theme { get; } | The theme. |
WellTrack Track { get; } | The track drawn. |
WellTrackLayoutEngine static class
Shared track layout: the legacy WellLogLayoutEngine.BuildTrackLayouts algorithm, plus an optional top reserve.
| Member | Summary |
|---|---|
static IReadOnlyList<TrackFrameLayout> Build(SKRect bounds, IReadOnlyList<ITrackFrame> tracks, float trackGap = 6, float defaultHeaderHeight = 28, float topReserve = 0) | Lays out tracks side by side in bounds by their width ratios. |
WellTrackRegistry static class
Track type key -> factory. Families are discovered through WellTrackTypeAttribute on loaded assemblies (or registered explicitly); unknown keys become UnknownTrack and round-trip untouched.
| Member | Summary |
|---|---|
static IEnumerable<string> TypeKeys { get; } | Every registered track type key. |
static WellTrack Create(string typeKey) | Creates an empty track of a type key (an UnknownTrack when not registered). |
static bool IsRegistered(string typeKey) | True when a track type key can be created. |
static void Register(string typeKey, Func<WellTrack> factory) | Registers a factory for a track type key (in addition to [WellTrackType] classes). |
static void RegisterAssembly(Assembly assembly) | Registers every WellTrackTypeAttribute type with a parameterless constructor in assembly. |
WellTrackTypeAttribute class
Marks a WellTrack type with its persisted type key (enables registry discovery).
Inherits / implements: Attribute
| Member | Summary |
|---|---|
WellTrackTypeAttribute(string typeKey) | Registers a track class under a type key. |
string TypeKey { get; } | The type key. |