Simantics/Chart module documentation

Creates a new Chart to the default Charts folder under the given Model parameter. Returns the created Chart.

The chart group will be named "Chart" with a possible added numeric suffix to make the name locally unique.

Inputs:

1. a model as Resource

Output: created chart as Resource

Example: Create a chart to an active model and rename it "My Chart"

import "Simantics/Chart"
import "Simantics/Entity"

my_model = currentModel
my_chart = createChart my_model // The name of the chart is by default Chart #, where # is the next unused number.

rename my_chart "My Chart"

Use createNamedChart to create a chart with a specific name directly.

Creates a new Chart under the specified chart group. Returns the created chart group.

The chart group will be named "Chart Group" with a possible added numeric suffix to make the name locally unique.

Inputs:

1. a chart group as Resource

Output: created chart as Resource

Example: Create a chart group to an active model and also two charts within this chart group.

import "Simantics/Chart"
import "Simantics/DB"

my_model = currentModel
my_chart_group = createChartGroup my_model
my_chart_1 = createChartInGroup my_chart_group
my_chart_2 = createChartInGroup my_chart_group

Creates a new ChartGroup under the given Model or ChartGroup with the specified proposed name. Returns the created ChartGroup Resource.

Inputs:

1. parent model or chart group as Resource under which to create the new chart group
2. proposed name for the chart group. The chart group will be numerically suffixed to make its name locally unique under the specified parent resource, if necessary.

Output: created chart group as Resource

Example: create a chart under an active model with name "My Chart"

import "Simantics/Chart"
import "Simantics/DB"

my_model = currentModel
my_chart_group = createNamedChart my_model "My Chart"

Browses the given Model for its Charts and then returns them in a list.

Inputs:

1. a model as Resource

Output: a list of chart Resources contained by the specified model

Example: The model contains two charts, called "Chart" and "Chart 2". This example collects the chart Resources and returns a list of the names of the charts.

import "Simantics/Chart"
import "Simantics/DB"

my_chart_list = chartsOf currentModel // get the charts in the current active model
map nameOf my_chart_list    // Converts the list of Resources to a list of Strings.

// Returns: ["Chart 2", "Chart"]

Browses starting from the given Model or Chart Group using the specified name path to find a chart.

The function will fail with an exception in all error cases:

• path does not exist
• found child is not a chart

Inputs:

1. starting point model or chart group Resource
2. name path of chart to lookup under

Output: the chart designated by list of the Chart Resources.

Example: The model contains two charts, called "Chart" and "Chart 2". This example retrieves the Resource of "Chart 2".

import "Simantics/Chart"
import "Simantics/DB"

my_chart2 = chartByPath currentModel ["Chart 2"]

Creates a new chartItem with the given Variable to the given Chart and returns the created ChartItem. New Subscription item is created at the same time to the default subscription folder.

Inputs:

1. a chart as Resource
2. a property reference as a Variable

Output: created Chart Item as Resource

Links the given Subscription to the given chart and returns the created ChartItem.

Inputs:

1. Resource of a subscription item
2. Resource of a chart

Output: created Chart Item

adjustChartItem specification chartItem

adjusts the specified chart item resource configuration based on the given specifications.

The following specs are available:

• ChartItemIndex index sets the chart item index that can be configured through the model browser context menu.
• ChartItemAutoYScale sets the chart item to use automatic Y-axis scaling based on visible data.
• ChartItemManualYScale min max sets the chart item to use manual Y-axis scaling with the given min and max values.
• ChartItemLineWidth width sets the chart item line width
• ChartItemLineColor color sets the chart item line color specified as
• ChartItemVisible to mark the chart item visible
• ChartItemHidden to mark the chart item hidden

Example:

adjustChartItem [ChartItemLineWidth 2.0, ChartItemManualYScale 0.0 100.0] aChartItem

chartItemsOf chart

Returns all items of the specified chart.

chartItemByIndex chart 1

Returns the chart item with the specified positional index or fails with an exception.

chartItemByLabel chart "subscription item label"

Returns the chart item that is linked to a subscription item with the specified label or fails with an exception.

Specifications that can be given to adjustChartItem to modify the configuration of a chart item.

Creates a new ChartGroup under the given Model or ChartGroup. Returns the created ChartGroup Resource.

Inputs:*

1. a model or a chart group as Resource

Output: created chart group as Resource

Example: create a chart group to an active model.

import "Simantics/Chart"
import "Simantics/DB"

my_model = currentModel
my_chart_group = createChartGroup my_model

Creates a new ChartGroup under the given Model or ChartGroup with the specified proposed name. Returns the created ChartGroup Resource.

Inputs:

1. parent model or chart group as Resource under which to create the new chart group
2. proposed name for the chart group. The chart group will be numerically suffixed to make its name locally unique under the specified parent resource, if necessary.

Output: created chart group as Resource

Example: create a chart group to an active model.

import "Simantics/Chart"
import "Simantics/DB"

my_model = currentModel
my_chart_group = createNamedChartGroup my_model "My Chart Group"

Browses the given Model or Chart Group using the specified name path to find a chart group.

The function will fail with an exception in all error cases:

• path does not exist
• found child is not a chart group

Inputs:

1. starting point model or chart group Resource
2. name path of a chart group under the model

Output: The resulting a list whose elements are chart Resources.

Example: The currently active model contains a chart group called "Chart Group". This example retrieves the Resource of "Chart 2".

import "Simantics/Chart"
import "Simantics/DB"

my_chart2 = chartGroupByPath currentModel ["Chart Group"]

Example of construction:

plan = CSVExportPlan {
    startTime = 0.0,
    timeStep = 1.0,
    decimalSeparator = decimalSeparatorFromString ".",
    columnSeparator = columnSeparatorFromString ",",
    resample = True,
    samplingMode = exportInterpolationFromString "lerp",
    timeDigits = 7,
    floatDigits = 9,
    doubleDigits = 15
}

Example of construction:

plan = SubscriptionCSVExportPlan {
    modelName = "Model",
    filePath = "D:/folder/output.csv",
    subscriptionNames = ["Default"],
    exportPlan = CSVExportPlan {
        startTime = 0.0,
        timeStep = 1.0,
        decimalSeparator = decimalSeparatorFromString ".",
        columnSeparator = columnSeparatorFromString ",",
        resample = True,
        samplingMode = exportInterpolationFromString "lerp",
        timeDigits = 7,
        floatDigits = 9,
        doubleDigits = 15
    }
}

Exports subscription data as CSV values in a similar manner as the CSV Exporter provided by the user interface.

The produced export will be encoded using the system default encoding which is initialized from the java.encoding JVM system property. You can use java -XshowSettings:all -version to see the default settings for any JVM.

Example of usage:

exportSubscriptionsCSV SubscriptionCSVExportPlan {
    modelName = "Model",
    filePath = "D:/folder/output.csv",
    subscriptionNames = ["Default"],
    exportPlan = CSVExportPlan {
        startTime = 0.0,
        timeStep = 1.0,
        decimalSeparator = decimalSeparatorFromString ".",
        columnSeparator = columnSeparatorFromString ",",
        resample = True,
        samplingMode = exportInterpolationFromString "lerp",
        timeDigits = 7,
        floatDigits = 9,
        doubleDigits = 15
    }
}

Exports subscription data as CSV values similarly to exportSubscriptionsCSV but requires also explicitly specifying the output CSV text encoding.

Some usual encodings include:

• "UTF-8"
• "US-ASCII"
• "x-UTF-16LE-BOM"
  • Excel-compatible 16-bit unicode text

but any other JVM-supported character set name can be provided as well.

Possible arguments are:

• ","
  • Comma
• "\t"
  • Tabulator
• ";"
  • Semicolon
• ":"
  • Colon
• " "
  • Space

Possible arguments are:

• "."
  • Dot
• ","
  • Comma

Possible arguments values are:

• lerp
  • Linear Interpolation
• previous
  • Previous Sample