SS.Visualization 1.3.0
Renderer-independent validated scenes, scalar/vector/tensor scientific-field SVG and versioned metadata plus deterministic accessible SVG, PNG, PDF, VTK and VTU export
Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0
No package dependencies declared.
Public API
Visualization.decimateSeries3
export function decimateSeries3(Series3 source, int maximumSamples)->Series3Parameters: source: Series3, maximumSamples: int
Visualization.defaultSvgTheme
export function defaultSvgTheme()->SvgThemeVisualization.displayPayload
export function displayPayload(string objectKind, string identity, string unitLabel, int values, int virtualizationThreshold)->DisplayPayloadParameters: objectKind: string, identity: string, unitLabel: string, values: int, virtualizationThreshold: int
export record DisplayPayload(public string sceneSchema, public string objectKind, public string identity, public string unitLabel, public int values, public bool virtualized)Parameters: sceneSchema: string, objectKind: string, identity: string, unitLabel: string, values: int, virtualized: bool
Visualization.document
export function document(string title, string xLabel, string yLabel, string zLabel, Series[] series2, Series3[] series3, Surface3[] surfaces, VectorField3[] vectorFields, ScalarField3[] scalarFields, TensorField3[] tensorFields, int width, int height)->SceneDocumentParameters: title: string, xLabel: string, yLabel: string, zLabel: string, series2: Series[], series3: Series3[], surfaces: Surface3[], vectorFields: VectorField3[], scalarFields: ScalarField3[], tensorFields: TensorField3[], width: int, height: int
Visualization.exportPdf
export function exportPdf(Scene scene, SvgTheme theme)->stringParameters: scene: Scene, theme: SvgTheme
Visualization.exportPng
export function exportPng(Scene scene, SvgTheme theme)->int[]Parameters: scene: Scene, theme: SvgTheme
Visualization.exportRequest
export function exportRequest(SceneDocument scene, string extension)->ExportRequestParameters: scene: SceneDocument, extension: string
export record ExportRequest(public string sceneSchema, public string mediaType, public string extension, public bool headless)Parameters: sceneSchema: string, mediaType: string, extension: string, headless: bool
export function exportSceneMetadata(SceneDocument scene) -> stringParameters: scene: SceneDocument
Visualization.exportVtk
export function exportVtk(Surface3 surface, ScalarField3 field)->stringParameters: surface: Surface3, field: ScalarField3
Visualization.exportVtu
export function exportVtu(Surface3 surface, ScalarField3 field)->stringParameters: surface: Surface3, field: ScalarField3
export function interactionContract(int maximumVisibleSamples)->InteractionContractParameters: maximumVisibleSamples: int
export record InteractionContract(public string schema, public bool rotate, public bool pan, public bool zoom, public bool select, public bool inspect, public bool exportEnabled, public bool keyboardAccessible, public int maximumVisibleSamples)Parameters: schema: string, rotate: bool, pan: bool, zoom: bool, select: bool, inspect: bool, exportEnabled: bool, keyboardAccessible: bool, maximumVisibleSamples: int
Visualization.mesh
export function mesh(string name, string unitLabel, Point3[] vertices, Triangle[] triangles)->Surface3Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]
Visualization.plot
export function plot(string title, string xLabel, string yLabel, Series[] data, int width, int height) -> SceneParameters: title: string, xLabel: string, yLabel: string, data: Series[], width: int, height: int
Visualization.point
export function point(double x, double y) -> PointParameters: x: double, y: double
Visualization.Point
export record Point(public double x, public double y, public double lower, public double upper)Parameters: x: double, y: double, lower: double, upper: double
Visualization.point3
export function point3(double x, double y, double z)->Point3Parameters: x: double, y: double, z: double
Visualization.Point3
export record Point3(public double x, public double y, public double z)Parameters: x: double, y: double, z: double
Visualization.regularSurface
export function regularSurface(string name, string unitLabel, double[] x, double[] y, double[] z, int rows, int columns)->Surface3Parameters: name: string, unitLabel: string, x: double[], y: double[], z: double[], rows: int, columns: int
export function renderScientificFieldSvg(SceneDocument scene, SvgTheme theme) -> stringParameters: scene: SceneDocument, theme: SvgTheme
Visualization.renderSurfaceSvg
export function renderSurfaceSvg(string title, string xLabel, string yLabel, string zLabel, Surface3 surface, ScalarField3 field, int width, int height, SvgTheme theme)->stringParameters: title: string, xLabel: string, yLabel: string, zLabel: string, surface: Surface3, field: ScalarField3, width: int, height: int, theme: SvgTheme
Visualization.renderSvg
export function renderSvg(Scene scene, SvgTheme theme)->stringParameters: scene: Scene, theme: SvgTheme
Visualization.sampleCount
export function sampleCount(Scene scene) -> intParameters: scene: Scene
Visualization.scalarField3
export function scalarField3(string name, string unitLabel, Point3[] positions, double[] values)->ScalarField3Parameters: name: string, unitLabel: string, positions: Point3[], values: double[]
export record ScalarField3(public string name, public string unitLabel, public Point3[] positions, public double[] values)Parameters: name: string, unitLabel: string, positions: Point3[], values: double[]
Visualization.Scene
export record Scene(public string title, public string xLabel, public string yLabel, public Series[] series, public int width, public int height)Parameters: title: string, xLabel: string, yLabel: string, series: Series[], width: int, height: int
export record SceneDocument(public string schema, public string title, public string xLabel, public string yLabel, public string zLabel, public Series[] series2, public Series3[] series3, public Surface3[] surfaces, public VectorField3[] vectorFields, public ScalarField3[] scalarFields, public TensorField3[] tensorFields, public int width, public int height)Parameters: schema: string, title: string, xLabel: string, yLabel: string, zLabel: string, series2: Series[], series3: Series3[], surfaces: Surface3[], vectorFields: VectorField3[], scalarFields: ScalarField3[], tensorFields: TensorField3[], width: int, height: int
export record SceneValidation(public bool valid, public string dimension, public int layers, public int samples, public string diagnostic)Parameters: valid: bool, dimension: string, layers: int, samples: int, diagnostic: string
Visualization.series
export function series(string name, string unitLabel, Point[] points) -> SeriesParameters: name: string, unitLabel: string, points: Point[]
Visualization.Series
export record Series(public string name, public string unitLabel, public Point[] points)Parameters: name: string, unitLabel: string, points: Point[]
Visualization.series3
export function series3(string name, string unitLabel, Point3[] points)->Series3Parameters: name: string, unitLabel: string, points: Point3[]
Visualization.Series3
export record Series3(public string name, public string unitLabel, public Point3[] points)Parameters: name: string, unitLabel: string, points: Point3[]
Visualization.surface
export function surface(string name, string unitLabel, Point3[] vertices, Triangle[] triangles)->Surface3Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]
Visualization.Surface3
export record Surface3(public string name, public string unitLabel, public Point3[] vertices, public Triangle[] triangles)Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]
Visualization.SvgTheme
export record SvgTheme(public string background, public string axes, public string text, public string first, public string second, public string third, public string fourth, public string fifth)Parameters: background: string, axes: string, text: string, first: string, second: string, third: string, fourth: string, fifth: string
Visualization.tensorField3
export function tensorField3(string name, string unitLabel, TensorSample3[] samples)->TensorField3Parameters: name: string, unitLabel: string, samples: TensorSample3[]
export record TensorField3(public string name, public string unitLabel, public TensorSample3[] samples)Parameters: name: string, unitLabel: string, samples: TensorSample3[]
export record TensorSample3(public Point3 position, public double[] components)Parameters: position: Point3, components: double[]
Visualization.triangle
export function triangle(int first, int second, int third)->TriangleParameters: first: int, second: int, third: int
Visualization.Triangle
export record Triangle(public int first, public int second, public int third)Parameters: first: int, second: int, third: int
Visualization.trisurf
export function trisurf(string name, string unitLabel, double[] x, double[] y, double[] z, Triangle[] triangles)->Surface3Parameters: name: string, unitLabel: string, x: double[], y: double[], z: double[], triangles: Triangle[]
Visualization.uncertainPoint
export function uncertainPoint(double x, double y, double lower, double upper) -> PointParameters: x: double, y: double, lower: double, upper: double
export function validateSceneDocument(SceneDocument scene) -> SceneValidationParameters: scene: SceneDocument
Visualization.vectorField3
export function vectorField3(string name, string unitLabel, VectorGlyph3[] glyphs)->VectorField3Parameters: name: string, unitLabel: string, glyphs: VectorGlyph3[]
export record VectorField3(public string name, public string unitLabel, public VectorGlyph3[] glyphs)Parameters: name: string, unitLabel: string, glyphs: VectorGlyph3[]
export record VectorGlyph3(public Point3 origin, public Point3 vector)Parameters: origin: Point3, vector: Point3
Documentation version
Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.