Skip to content
OFFICIAL SS DOCUMENTATION

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
API 1.3.0
MIT
source

Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0

No package dependencies declared.

Public API

Public signature
export function decimateSeries3(Series3 source, int maximumSamples)->Series3

Parameters: source: Series3, maximumSamples: int


Public signature
export function defaultSvgTheme()->SvgTheme

Public signature
export function displayPayload(string objectKind, string identity, string unitLabel, int values, int virtualizationThreshold)->DisplayPayload

Parameters: objectKind: string, identity: string, unitLabel: string, values: int, virtualizationThreshold: int


Public signature
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


Public signature
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)->SceneDocument

Parameters: title: string, xLabel: string, yLabel: string, zLabel: string, series2: Series[], series3: Series3[], surfaces: Surface3[], vectorFields: VectorField3[], scalarFields: ScalarField3[], tensorFields: TensorField3[], width: int, height: int


Public signature
export function exportPdf(Scene scene, SvgTheme theme)->string

Parameters: scene: Scene, theme: SvgTheme


Public signature
export function exportPng(Scene scene, SvgTheme theme)->int[]

Parameters: scene: Scene, theme: SvgTheme


Public signature
export function exportRequest(SceneDocument scene, string extension)->ExportRequest

Parameters: scene: SceneDocument, extension: string


Public signature
export record ExportRequest(public string sceneSchema, public string mediaType, public string extension, public bool headless)

Parameters: sceneSchema: string, mediaType: string, extension: string, headless: bool


Public signature
export function exportSceneMetadata(SceneDocument scene) -> string

Parameters: scene: SceneDocument


Public signature
export function exportVtk(Surface3 surface, ScalarField3 field)->string

Parameters: surface: Surface3, field: ScalarField3


Public signature
export function exportVtu(Surface3 surface, ScalarField3 field)->string

Parameters: surface: Surface3, field: ScalarField3


Public signature
export function interactionContract(int maximumVisibleSamples)->InteractionContract

Parameters: maximumVisibleSamples: int


Public signature
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


Public signature
export function mesh(string name, string unitLabel, Point3[] vertices, Triangle[] triangles)->Surface3

Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]


Public signature
export function plot(string title, string xLabel, string yLabel, Series[] data, int width, int height) -> Scene

Parameters: title: string, xLabel: string, yLabel: string, data: Series[], width: int, height: int


Public signature
export function point(double x, double y) -> Point

Parameters: x: double, y: double


Public signature
export record Point(public double x, public double y, public double lower, public double upper)

Parameters: x: double, y: double, lower: double, upper: double


Public signature
export function point3(double x, double y, double z)->Point3

Parameters: x: double, y: double, z: double


Public signature
export record Point3(public double x, public double y, public double z)

Parameters: x: double, y: double, z: double


Public signature
export function regularSurface(string name, string unitLabel, double[] x, double[] y, double[] z, int rows, int columns)->Surface3

Parameters: name: string, unitLabel: string, x: double[], y: double[], z: double[], rows: int, columns: int


Public signature
export function renderScientificFieldSvg(SceneDocument scene, SvgTheme theme) -> string

Parameters: scene: SceneDocument, theme: SvgTheme


Public signature
export function renderSurfaceSvg(string title, string xLabel, string yLabel, string zLabel, Surface3 surface, ScalarField3 field, int width, int height, SvgTheme theme)->string

Parameters: title: string, xLabel: string, yLabel: string, zLabel: string, surface: Surface3, field: ScalarField3, width: int, height: int, theme: SvgTheme


Public signature
export function renderSvg(Scene scene, SvgTheme theme)->string

Parameters: scene: Scene, theme: SvgTheme


Public signature
export function sampleCount(Scene scene) -> int

Parameters: scene: Scene


Public signature
export function scalarField3(string name, string unitLabel, Point3[] positions, double[] values)->ScalarField3

Parameters: name: string, unitLabel: string, positions: Point3[], values: double[]


Public signature
export record ScalarField3(public string name, public string unitLabel, public Point3[] positions, public double[] values)

Parameters: name: string, unitLabel: string, positions: Point3[], values: double[]


Public signature
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


Public signature
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


Public signature
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


Public signature
export function series(string name, string unitLabel, Point[] points) -> Series

Parameters: name: string, unitLabel: string, points: Point[]


Public signature
export record Series(public string name, public string unitLabel, public Point[] points)

Parameters: name: string, unitLabel: string, points: Point[]


Public signature
export function series3(string name, string unitLabel, Point3[] points)->Series3

Parameters: name: string, unitLabel: string, points: Point3[]


Public signature
export record Series3(public string name, public string unitLabel, public Point3[] points)

Parameters: name: string, unitLabel: string, points: Point3[]


Public signature
export function surface(string name, string unitLabel, Point3[] vertices, Triangle[] triangles)->Surface3

Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]


Public signature
export record Surface3(public string name, public string unitLabel, public Point3[] vertices, public Triangle[] triangles)

Parameters: name: string, unitLabel: string, vertices: Point3[], triangles: Triangle[]


Public signature
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


Public signature
export function tensorField3(string name, string unitLabel, TensorSample3[] samples)->TensorField3

Parameters: name: string, unitLabel: string, samples: TensorSample3[]


Public signature
export record TensorField3(public string name, public string unitLabel, public TensorSample3[] samples)

Parameters: name: string, unitLabel: string, samples: TensorSample3[]


Public signature
export record TensorSample3(public Point3 position, public double[] components)

Parameters: position: Point3, components: double[]


Public signature
export function triangle(int first, int second, int third)->Triangle

Parameters: first: int, second: int, third: int


Public signature
export record Triangle(public int first, public int second, public int third)

Parameters: first: int, second: int, third: int


Public signature
export function trisurf(string name, string unitLabel, double[] x, double[] y, double[] z, Triangle[] triangles)->Surface3

Parameters: name: string, unitLabel: string, x: double[], y: double[], z: double[], triangles: Triangle[]


Public signature
export function uncertainPoint(double x, double y, double lower, double upper) -> Point

Parameters: x: double, y: double, lower: double, upper: double


Public signature
export function validateSceneDocument(SceneDocument scene) -> SceneValidation

Parameters: scene: SceneDocument


Public signature
export function vectorField3(string name, string unitLabel, VectorGlyph3[] glyphs)->VectorField3

Parameters: name: string, unitLabel: string, glyphs: VectorGlyph3[]


Public signature
export record VectorField3(public string name, public string unitLabel, public VectorGlyph3[] glyphs)

Parameters: name: string, unitLabel: string, glyphs: VectorGlyph3[]


Public signature
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.