# Arbeta med Kst-skript

## Klasser i Kst-skript:

Arrow | Axis | AxisLabel
AxisTickLabel | BinnedMap | BorderedViewObject
Box | Collection | ColorSequence
CrossPowerSpectrum | Curve | CurveCollection
DataMatrix | DataObject | DataObjectCollection
DataSource | DataSourceCollection | DataVector
Debug | DebugLog | DebugLogEntry
Dir | Document | Ellipse
ELOG | Equation | EquationCollection
Extension | ExtensionCollection | File
Group | Histogram | HistogramCollection
Image | Kst | Label
Legend | Line | Matrix
MatrixCollection | Object | ObjectCollection
Picture | Plot | PlotCollection
PlotLabel | Plugin | PluginCollection
PluginIO | PluginIOCollection | PluginManager
PluginModule | PluginModuleCollection | Point
PowerSpectrum | PowerSpectrumCollection | Scalar
ScalarCollection | Size | Spectrogram
SpectrogramCollection | String | StringCollection
TimeInterpretation | Vector | VectorCollection
VectorView | ViewObject | ViewObjectCollection
Window | WindowCollection

## Klass: Arrow

Anpassningsbar grafisk pil.

Ärver: Line

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Arrow ( parent )

- Arrow ( fönster )

### Egenskaper:

- fromArrow

- toArrow

- fromArrowScaling

- toArrowScaling

###

#### Arrow ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya pilen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny pil och placerar den i vyobjektet parent.

#### Arrow ( Window window )

- Window window - Fönstret som den nya pilen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny pil och placerar den i fönstret window.

#### boolean fromArrow

Sant om pilen har en pil i sin startpunkt.

#### boolean toArrow

Sant om pilen har en pil i sin slutpunkt.

#### number fromArrowScaling

Skala storleken hos pilen i startpunkten.

#### number toArrowScaling

Skala storleken hos pilen i slutpunkten.

## Klass: Axis

En klass som representerar en diagramaxel.

### Metoder:

- scaleAuto ( )

- scaleAutoSpikeInsensitive ( )

- scaleExpression ( minExp, maxExp )

- scaleRange ( min, max )

### Egenskaper:

- log

- suppressed

- oppositeSuppressed

- offsetMode

- reversed

- majorGridLines

- minorGridLines

- transformation

- innerTicks

- outerTicks

- label

- type

- majorGridColor

- minorGridColor

- minorTickCount

- majorTickDensity

- scaleMode

- interpretation

- title

- tickLabel

###

#### void scaleAuto ( )

Ställer in skalningsläget till automatiskt.

#### void scaleAutoSpikeInsensitive ( )

Ställer in skalningsläget till automatiskt toppokänsligt.

#### void scaleExpression ( string minExp, string maxExp )

- string minExp - Uttrycket för skalans minimum.

- string maxExp - Uttrycket för skalans maximum.

Ställer in skalningsläget till uttryck.

#### void scaleRange ( number min, number max )

- number min - Värdet för skalans minimum.

- number max - Värdet för skalans maximum.

Ställer in skalningsläget till fast, och anger intervallet.

#### boolean log

Sant om axeln har logaritmisk skala.

#### boolean suppressed

Sant om axeln inte är visad.

#### boolean oppositeSuppressed

Sant om axeln på andra sidan inte är visad. (Högra X eller övre Y)

#### number offsetMode

Bas- och avståndsläge. Värdet måste vara något av:

- 0 - Automatisk

- 1 - På

- 2 - Av

. För bakåtkompatibilitet kan värdet också anges som Boolean, där sant motsvarar På och falskt motsvarar Automatisk.

#### boolean reversed

Sant om axeln är omvänd.

#### boolean majorGridLines

Sant om axel visar stora rutnätslinjer.

#### boolean minorGridLines

Sant om axel visar små rutnätslinjer.

#### string transformation

Axelns transformeringsuttryck.

#### boolean innerTicks

Sant om streckmarkeringar visas inne i diagrammet.

#### boolean outerTicks

Sant om streckmarkeringar visas utanför diagrammet.

#### string label

Axelns text.

#### string type [skrivskyddad]

Typ av axel - för närvarande X eller Y.

#### string majorGridColor

Färg för stora rutnätslinjer.

#### string minorGridColor

Färg för små rutnätslinjer.

#### number minorTickCount

Antal små streck mellan två stora streck. Specialvärdet -1 tvingar Kst att bestämma det automatiskt.

#### number majorTickDensity

Täthet av stora streckmarkeringar längs axeln. Värdet måste vara ett av:

- 0 - Grov

- 1 - Normal

- 2 - Fin

- 3 - Mycket fin

#### number scaleMode [skrivskyddad]

Typ av skalning som görs av axeln. Värdet är något av:

- 0 - Automatisk

- 1 - Alla kurvor (enligt mittpunkt)

- 2 - Fast

- 3 - Automatisk uppåt (skalar bara uppåt)

- 4 - Automatisk (okänslig för toppar)

- 5 - Automatisk (föråldrad, samma som 0)

- 6 - Uttrycksbaserad

#### TimeInterpretation interpretation [skrivskyddad]

Metoden som axeln tolkas med och som tider visas med.

#### AxisLabel title

Axelns text.

#### AxisTickLabel tickLabel

Axelns markeringstext.

## Klass: AxisLabel

En klass som representerar en diagramaxeltext.

### Egenskaper:

- text

- font

- fontSize

- type

###

#### string text

Innehåller textens innehåll. Det kan inkludera skalärreferenser på formen [skalärnamn] och viss grundläggande Latex.

#### string font

Används för att ange eller hämta aktuellt teckensnitt som används för texten.

#### number fontSize

Innehåller storleken hos teckensnittet som används för att skriva ut texten.

#### string type [skrivskyddad]

Typ av axel - för närvarande X eller Y.

## Klass: AxisTickLabel

En klass som representerar en diagramaxels streckmarkeringstext.

### Egenskaper:

- font

- fontSize

- rotation

- type

###

#### string font

Används för att ange eller hämta aktuellt teckensnitt som används för texten.

#### number fontSize

Innehåller storleken hos teckensnittet som används för att skriva ut texten.

#### number rotation

Innehåller textens rotationsvinkel. Rotationen är medurs från normal, och lagras i grader.

#### string type [skrivskyddad]

Typ av axel - för närvarande X eller Y.

## Klass: BinnedMap

Klassen representerar ett områdesavbildningsobjekt i Kst

Ärver: DataObject

### Konstruktorer:

- BinnedMap ( )

### Metoder:

- validate ( )

### Egenskaper:

- x

- y

- z

- binnedMap

- hitsMap

- xFrom

- xTo

- yFrom

- yTo

- nX

- nY

- autobin

- valid

###

#### BinnedMap ( )

Huvudkonstruktor för klassen BinnedMap.

#### void validate ( )

Validerar insticksprogrammet.

#### Vector x

Innehåller X-vektorn.

#### Vector y

Innehåller Y-vektorn.

#### Vector z

Innehåller Z-vektorn.

#### string binnedMap

Innehåller namnet på områdesavbildningens matris.

#### string hitsMap

Innehåller namnet på träffavbildningens matris.

#### Scalar xFrom

Innehåller X-vektorns från-värde.

#### Scalar xTo

Innehåller X-vektorns till-värde.

#### Scalar yFrom

Innehåller Y-vektorns från-värde.

#### Scalar yTo

Innehåller Y-vektorns till-värde.

#### Scalar nX

Innehåller antalet X-områden.

#### Scalar nY

Innehåller antalet Y-områden.

#### Scalar autobin

Innehåller inställningen av automatiska områden. Noll för inga automatiska områden, och skild från noll för automatiska områden.

#### boolean valid [skrivskyddad]

Returnerar sant om områdesavbildningens alla indata och utdata har blivit tilldelade.

## Klass: BorderedViewObject

Representerar något objekt i ett Kst-fönster. Detta är ett abstrakt objekt och kan inte instantieras direkt. Det har flera egenskaper som inte finns i vanliga ViewObjects inklusive marginaler, utfyllnad och en kant.

Ärver: ViewObject

Samlingsklass: ViewObjectCollection

### Egenskaper:

- padding

- margin

- borderWidth

- borderColor

###

#### number padding

Antal bildpunkter mellan kanten och innehållet.

#### number margin

Antal bildpunkter mellan objektets ytterkant och kanten.

#### number borderWidth

Kantens bredd i bildpunkter.

#### string borderColor

Kantens färg för det här objektet.

## Klass: Box

Anpassningsbar grafisk ruta.

Ärver: ViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Box ( parent )

- Box ( window )

### Egenskaper:

- xRound

- yRound

- borderWidth

- borderColor

###

#### Box ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya rutan ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny ruta och placerar den i vyobjektet parent.

#### Box ( Window window )

- Window window - Fönstret som den nya rutan ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny ruta och placerar den i fönstret window.

#### number xRound

Rundningen hos hörnen i X-led. Måste vara ett heltal mellan 0 och 99.

#### number yRound

Rundningen hos hörnen i Y-led. Måste vara ett heltal mellan 0 och 99.

#### number borderWidth

Kantens bredd i bildpunkter.

#### string borderColor

Kantens färg för det här objektet.

## Klass: Collection

Detta är den generella samlingsklassen som används av Kst för att lagra listor av objekt. Den beter sig i huvudsak som ett fält i Javascript. För närvarande är index skrivskyddade. Dessutom, om en samling är skrivskyddad, kastar ändringsmetoder undantag. Iteration ser ut ungefär så här:

                    for (i = 0; i < collection.length; ++i) {
                      // gör någonting med collection[i]
                    }

### Metoder:

- append ( newObj )

- prepend ( newObj )

- remove ( n )

- remove ( obj )

- clear ( )

### Egenskaper:

- length

- readOnly

###

#### void append ( Object newObj )

- Object newObj - Det nya objektet som ska läggas till sist i samlingen.

Lägger till ett nytt objekt i slutet av samlingen.

#### void prepend ( Object newObj )

- Object newObj - Det nya objektet som ska läggas till först i samlingen.

Lägger till ett nytt objekt i början av samlingen.

#### void remove ( number n )

- number n - Index för posten som ska tas bort.

Tar bort en post från samlingen.

#### void remove ( Object obj )

- Object obj - Objektet som ska tas bort.

Tar bort ett objekt från samlingen.

#### void clear ( )

Rensar samlingen och tar bort alla poster.

#### number length [skrivskyddad]

Antal objekt i samlingen. Objekt är ordnade från 0..(längd - 1), så det är enkelt att iterera.

#### boolean readOnly [skrivskyddad]

Sant om detta är en skrivskyddad samling.

## Klass: ColorSequence

Ger tillgång till färgsekvensen som används för att färglägga kurvor i Kst.

### Metoder:

- next ( [previous] )

- tooClose ( firstColor, secondColor )

###

#### string next ( [string previous] )

- string previous - Föregående färg i färgsekvensen du följer. Behövs inte. [valfri]

Returnerar nästa färg i färgsekvensen.

#### boolean tooClose ( string firstColor, string secondColor )

- string firstColor - Den första av två färger att jämföra.

- string secondColor - Den andra av två färger att jämföra.

Returnerar sant om färgerna är för nära varandra.

## Klass: CrossPowerSpectrum

Klassen representerar ett korseffektspektrumobjekt i Kst.

Ärver: DataObject

### Metoder:

- validate ( )

### Egenskaper:

- v1

- v2

- length

- sample

- real

- imaginary

- frequency

- valid

###

#### void validate ( )

Validerar insticksprogrammet.

#### Vector v1

Innehåller den första vektorn.

#### Vector v2

Innehåller den andra vektorn.

#### Scalar length

Innehåller bas-2 logaritmen av spektrogrammets längd. Ska vara ett heltal ≥ 2.

#### Scalar sample

Innehåller samplingsfrekvensen.

#### string real

Innehåller namnet på utdatavektorn som har realdelen av korseffektspektrat.

#### string imaginary

Innehåller namnet på utdatavektorn som har imaginärdelen av korseffektspektrat.

#### string frequency

Innehåller namnet på utdatavektorn som har frekvenserna av korseffektspektrat.

#### boolean valid [skrivskyddad]

Returnerar sant om korseffektspektrats alla indata och utdata har blivit tilldelade.

## Klass: Curve

Representerar en kurva skapad av en X- och en Y-vektor.

Ärver: DataObject

Samlingsklass: CurveCollection

### Konstruktorer:

- Curve ( x, y [, xError [, yError [, xMinusError [, yMinusError]]]] )

- Curve ( hs )

### Metoder:

- point ( index )

- xErrorPoint ( index )

- yErrorPoint ( index )

- xMinusErrorPoint ( index )

- yMinusErrorPoint ( index )

### Egenskaper:

- color

- xVector

- yVector

- xErrorVector

- yErrorVector

- xMinusErrorVector

- xMinusErrorVector

- yVectorOffset

- samplesPerFrame

- ignoreAutoScale

- hasPoints

- hasLines

- hasBars

- lineWidth

- pointStyle

- lineStyle

- barStyle

- pointDensity

- topLabel

- xLabel

- yLabel

- legendText

###

#### Curve ( Vector x, Vector y [, Vector xError [, Vector yError [, Vector xMinusError [, Vector yMinusError]]]] )

- Vector x - Kurvans X-vektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt.

- Vector y - Kurvans Y-vektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt.

- Vector xError - Kurvans X-felstapelvektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt. [valfri]

- Vector yError - Kurvans Y-felstapelvektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt. [valfri]

- Vector xMinusError - Kurvans negativa X-felstapelvektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt. [valfri]

- Vector yMinusError - Kurvans negativa Y-felstapelvektor. Kan anges som en sträng som innehåller taggnamnet på en befintlig vektor, eller som ett vektorobjekt. [valfri]

Huvudkonstruktor för klassen Curve. Att skapa en ny kurva lägger automatiskt till den i Ksts datasamling.

#### Curve ( Histogram hs )

- Histogram hs - Skapar en kurva från ett histogram.

Konstruktor för klassen Curve. Låter en kurva helt enkelt skapas från klassen Histogram.

#### Point point ( number index )

- number index - Index för punkten vars koordinater ska hämtas. Börjar på 0.

Hämta koordinaterna för en given punkt på kurvan. Returnerar en ogiltig punkt om det indexet inte finns.

#### number xErrorPoint ( number index )

- number index - Index för punkten vars koordinater ska hämtas. Börjar på 0.

Hämta koordinaterna för en given punkt på X-felstaplarna. Returnerar en ogiltig punkt om det indexet inte finns.

#### number yErrorPoint ( number index )

- number index - Index för punkten vars koordinater ska hämtas. Börjar på 0.

Hämta koordinaterna för en given punkt på Y-felstaplarna. Returnerar en ogiltig punkt om det indexet inte finns.

#### number xMinusErrorPoint ( number index )

- number index - Index för punkten vars koordinater ska hämtas. Börjar på 0.

Hämta koordinaterna för en given punkt på negativa X-felstaplarna. Returnerar en ogiltig punkt om det indexet inte finns.

#### number yMinusErrorPoint ( number index )

- number index - Index för punkten vars koordinater ska hämtas. Börjar på 0.

Hämta koordinaterna för en given punkt i Y minus felstaplar. Returnerar en ogiltig punkt om indexet inte finns.

#### string color

Kurvans färg. Lagras på formen "#RRGGBB" som hexadecimala värden. Egenskapen kan också ställas in med engelska strängar som "blue".

#### Vector xVector

Kurvans X-axelvektor.

#### Vector yVector

Kurvans Y-axelvektor.

#### Vector xErrorVector

Kurvans felvektor för X-axeln.

#### Vector yErrorVector

Kurvans felvektor för Y-axeln.

#### Vector xMinusErrorVector

Kurvans negativa felvektor för X-axeln.

#### Vector xMinusErrorVector

Kurvans negativa felvektor för X-axeln.

#### Scalar yVectorOffset

Förskjutningen som ska användas för Y-axelvektorn.

#### number samplesPerFrame [skrivskyddad]

Antal samplingar per post för kurvan.

#### boolean ignoreAutoScale

Om sant, ignorerar kurvan automatisk skalning.

#### boolean hasPoints

Om sant, ritas punkter för kurvan.

#### boolean hasLines

Om sant, ritas linjer för kurvan.

#### boolean hasBars

Om sant, ritas staplar för kurvan.

#### number lineWidth

Ställer in linjebredden för kurvan när linjer ritas.

#### number pointStyle

Ställer in punktstilen för kurvan när punkter ritas.

- 0 - Kors

- 1 - Ihålig ruta

- 2 - Ihålig cirkel

- 3 - Fylld cirkel

- 4 - Omvänd ihålig triangel

- 5 - Ihålig triangel

- 6 - Fylld ruta

- 7 - Plustecken

- 8 - Asterisk

- 9 - Omvänd fylld triangel

- 10 - Fylld triangel

- 11 - Ihålig romb

- 12 - Fylld romb

- 13 - Punkt

#### number lineStyle

Ställer in linjestilen för kurvan när linjer ritas.

- 0 - Heldragen

- 1 - Streckad

- 2 - Punkter

- 3 - Streck punkt

- 4 - Streck punkt punkt

#### number barStyle

Ställer in stapelstilen för kurvan när staplar ritas.

- 0 - Linjer

- 1 - Ifylld

#### number pointDensity

Ställer in punkttätheten för kurvan när punkter ritas.

- 0 - Rita alla punkter

- 1 - Hög täthet

- 2 - Normal täthet

- 3 - Låg täthet

#### string topLabel [skrivskyddad]

Rubrikförslag för kurvan.

#### string xLabel [skrivskyddad]

Förslag på X-axeltext för kurvan.

#### string yLabel [skrivskyddad]

Förslag på Y-axeltext för kurvan.

#### string legendText

Förklaringstexten som hör ihop med en kurva.

## Klass: CurveCollection

Ett fält av kurvor.

Ärver: Collection

###

## Klass: DataMatrix

Ett matrisobjekt laddat från en datakälla.

Ärver: Matrix

### Konstruktorer:

- DataMatrix ( source, field [, xStart, yStart, xN, yN [, skip [, ave]]] )

### Metoder:

- reload ( )

- changeFile ( source )

- change ( xStart, yStart, xCount, yCount [, skip [, ave]] )

### Egenskaper:

- valid

- skip

- boxcar

- xReadToEnd

- yReadToEnd

- xCountFromEnd

- yCountFromEnd

- skipLength

- field

- dataSource

###

#### DataMatrix ( DataSource source, string field [, number xStart, number yStart, number xN, number yN [, number skip [, boolean ave]]] )

- DataSource source - Datakällan som data ska laddas från. Det kan vara en sträng som innehåller webbadressen till datakällan att ladda. Om det är fallet, försöker den återanvända en befintlig instans av en datakälla, annars används ett nytt objekt som reservlösning. Den kan också anges som ett DataSource-objekt.

- string field - Fältet att ladda från källan.

- number xStart - X-posten att börja läsa från. [valfri]

- number yStart - Y-posten att börja läsa från.

- number xN - Antal x-poster att läsa.

- number yN - Antal y-poster att läsa.

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

#### void reload ( )

#### void changeFile ( DataSource source )

- DataSource source - Datakälla att byta till.

Byter denna DataMatrix till en annan DataSource.

#### void change ( number xStart, number yStart, number xCount, number yCount [, number skip [, boolean ave]] )

- number xStart - X-startposten.

- number yStart - Y-startposten.

- number xCount - Antal x-poster att läsa.

- number yCount - Antal y-poster att läsa.

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

Ändrar datasekvensen som läses in av matrisen.

#### boolean valid [skrivskyddad]

Sant om datamatrisen är giltig.

#### boolean skip [skrivskyddad]

Sant om matrisen ska hoppa över skipLength samplingar vid läsning från datakällan.

#### boolean boxcar [skrivskyddad]

Sant om matrisen ska lågpassfiltreras.

#### boolean xReadToEnd [skrivskyddad]

Om sant, läses matrisen till källans slut i X-dimensionen.

#### boolean yReadToEnd [skrivskyddad]

Om sant, läses matrisen till källans slut i Y-dimensionen.

#### boolean xCountFromEnd [skrivskyddad]

Om sant, läser matrisen bara ett maximalt antal samplingar från källans slut i X-dimensionen.

#### boolean yCountFromEnd [skrivskyddad]

Om sant, läser matrisen bara ett maximalt antal samplingar från källans slut i Y-dimensionen.

#### number skipLength [skrivskyddad]

Antal samplingar att hoppa över.

#### string field [skrivskyddad]

Fältet som läses från datakällan för att skapa matrisen.

#### DataSource dataSource [skrivskyddad]

Datakällans objekt som används av denna DataMatrix.

## Klass: DataObject

Den abstrakta basklassen för alla objekt i Kst.

Ärver: Object

Samlingsklass: DataObjectCollection

### Metoder:

- convertTo ( type )

### Egenskaper:

- type

###

#### DataObject convertTo ( string type )

- string type - Typen som objektet ska försöka konverteras till.

Försöker konvertera detta DataObject till en annan typ. Objektet måste vara härlett från typen på någon nivå. Null returneras om det inte är möjligt att konvertera till den begärda typen.

#### string type [skrivskyddad]

Typ av dataobjekt detta är.

## Klass: DataObjectCollection

Ett fält av dataobjekt.

Ärver: Collection

###

## Klass: DataSource

Ett objekt som representerar en datafil som Kst förstår.

Ärver: Object

Samlingsklass: DataSourceCollection

### Konstruktorer:

- DataSource ( url [, type] )

### Metoder:

- isValidField ( field )

- fieldList ( )

- reset ( )

- matrixList ( )

- samplesPerFrame ( field )

- frameCount ( [field] )

- setConfiguration ( setting, setting )

- configuration ( setting )

- units ( field )

### Egenskaper:

- valid

- empty

- completeFieldList

- fileName

- fileType

- source

- metaData

###

#### DataSource ( string url [, string type] )

- string url - Filnamn eller webbadress att ladda.

- string type - Namn på insticksprogram för datakällan som ska användas. [valfri]

Skapar ett nytt DataSource-objekt. Om webbadressen inte kan öppnas och läsas, kommer isValid att vara falsk.

#### boolean isValidField ( string field )

- string field - Ett fältnamn att kontrollera.

Returnerar om fältet är giltigt eller inte.

#### StringArray fieldList ( )

Skapar en lista med alla fält tillgängliga från källan.

#### void reset ( )

Återställer datakällan.

#### StringArray matrixList ( )

Skapar en lista av matriser tillgängliga från källan.

#### number samplesPerFrame ( string field )

- string field - Ett fältnamn som antal samplingar per post ska hämtas för. Det är samma för alla fält för vissa källor, men olika för andra.

Antal samplingar per post för fältet eller källan.

#### number frameCount ( [string field] )

- string field - Ett valfritt fältnamn som antal samplingar per post ska hämtas för. Det är samma för alla fält för vissa källor, men olika för andra. [valfri]

Hämtar antal poster från källan, eller det givna fältet om det specificeras.

#### boolean setConfiguration ( string setting, string setting )

- string setting - Anger inställningsnamnet vars värde ska tilldelas.

- string setting - Anger inställningens värde.

Tilldelar ett inställningsvärde för datakällan.

#### string configuration ( string setting )

- string setting - Anger inställningsnamnet vars värde ska hämtas.

Hämtar ett inställningsvärde för datakällan.

#### string units ( string field )

- string field - Anger fältnamnet vars enheter ska hämtas.

Hämtar enheterna som hör ihop med ett fält i datakällan.

#### boolean valid [skrivskyddad]

Sant om datakällan är giltig.

#### boolean empty [skrivskyddad]

Sant om datakällan är tom.

#### boolean completeFieldList [skrivskyddad]

Sant om fältlistan är fullständig.

#### string fileName [skrivskyddad]

Filens namn.

#### string fileType [skrivskyddad]

Typen (formatet) hos filen, såsom ASCII.

#### string source [skrivskyddad]

Datakällans namn.

#### StringArray metaData [skrivskyddad]

Eventuell metadata som hör ihop med datakällan. Det är ett associativt fält på formen metaData["nyckel"] = "värde".

## Klass: DataSourceCollection

Ett fält av datakällor.

Ärver: Collection

###

## Klass: DataVector

Ett vektorobjekt laddat från en datakälla.

Ärver: Vector

### Konstruktorer:

- DataVector ( source, field [, start [, n [, skip [, ave]]]] )

- DataVector ( source, field, typeStart, start, typeCount, count [, skip [, ave]] )

### Metoder:

- reload ( )

- changeFile ( source )

- changeFrames ( start, count [, skip [, ave]] )

- changeFramesByTime ( typeStart, start, typeCount, count [, skip [, ave]] )

### Egenskaper:

- valid

- skip

- boxcar

- readToEnd

- countFromEnd

- skipLength

- startFrame

- startFrameRequested

- frames

- framesRequested

- samplesPerFrame

- field

- dataSource

###

#### DataVector ( DataSource source, string field [, number start [, number n [, number skip [, boolean ave]]]] )

- DataSource source - Datakällan som data ska laddas från. Det kan vara en sträng som innehåller webbadressen till datakällan att ladda. Om det är fallet, försöker den återanvända en befintlig instans av en datakälla, annars används ett nytt objekt som reservlösning. Den kan också anges som ett DataSource-objekt.

- string field - Fältet att ladda från källan.

- number start - Posten att börja läsa från. [valfri]

- number n - Antal poster att läsa. [valfri]

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

#### DataVector ( DataSource source, string field, string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )

- DataSource source - Datakällan som data ska laddas från. Det kan vara en sträng som innehåller webbadressen till datakällan att ladda. Om det är fallet, försöker den återanvända en befintlig instans av en datakälla, annars används ett nytt objekt som reservlösning. Den kan också anges som ett DataSource-objekt.

- string field - Fältet att ladda från källan.

- string typeStart - Typen på värdet som anger startpositionen. Tillåtna värden är de följande:

  - ramar

  - datum

  - ms (millisekunder)

  - s (sekunder)

  - m (minuter)

  - t (timmar)

  - dagar

  - veckor

  - månader

  - år

  Datumposten använder formatet åååå:mm:dd:tt:mm.ss (t.ex. 2009:2:13:13:10.12). Om något av de inledande delarna utelämnas antas nuvarande år, månad och dag. Om året är mindre än 0, antas det vara angivet i förhållande till 1970 (t.ex. -10 blir 1980), annars om året är mindre än 100 antas det vara relativt till 2000 (t.ex. 9 blir 2009), annars används året som det anges.

- number start - Startposten, datum (ett strängargument) eller relativ tid.

- string typeCount - Typen på värdet som anger antalet

- number count - Antal poster eller tidslängd att läsa. De tillåtna värdena är följande:

  - frames

  - ms (millisekunder)

  - s (sekunder)

  - m (minuter)

  - h (timmar)

  - dagar

  - veckor

  - månader

  - år

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

#### void reload ( )

#### void changeFile ( DataSource source )

- DataSource source - Datakälla att byta till.

Byter denna DataVector till en annan DataSource.

#### void changeFrames ( number start, number count [, number skip [, boolean ave]] )

- number start - Startposten.

- number count - Antal poster att läsa.

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

Ändrar dataföljden som läses in av vektorn.

#### void changeFramesByTime ( string typeStart, number start, string typeCount, number count [, number skip [, boolean ave]] )

- string typeStart - Typen på värdet som anger startpositionen. Tillåtna värden är de följande:

  - ramar

  - datum

  - ms (millisekunder)

  - s (sekunder)

  - m (minuter)

  - t (timmar)

  - dagar

  - veckor

  - månader

  - år

  Datumposten använder formatet åååå:mm:dd:tt:mm.ss (t.ex. 2009:2:13:13:10.12). Om något av de inledande delarna utelämnas antas nuvarande år, månad och dag. Om året är mindre än 0, antas det vara angivet i förhållande till 1970 (t.ex. -10 blir 1980), annars om året är mindre än 100 antas det vara relativt till 2000 (t.ex. 9 blir 2009), annars används året som det anges.

- number start - Startposten, datum (ett strängargument) eller relativ tid.

- string typeCount - Typen på värdet som anger antalet

- number count - Antal poster eller tidslängd att läsa. De tillåtna värdena är följande:

  - frames

  - ms (millisekunder)

  - s (sekunder)

  - m (minuter)

  - h (timmar)

  - dagar

  - veckor

  - månader

  - år

- number skip - Antal samplingar att hoppa över. [valfri]

- boolean ave - Ange som sann för att utföra lågpassfiltrering. [valfri]

Ändrar dataföljden som läses in av vektorn.

#### boolean valid [skrivskyddad]

Sant om datavektorn är giltig.

#### boolean skip [skrivskyddad]

Sant om vektorn ska hoppa över skipLength samplingar vid läsning från datakällan.

#### boolean boxcar [skrivskyddad]

Sant om vektorn ska lågpassfiltreras.

#### boolean readToEnd [skrivskyddad]

Om sant, läses vektorn till källans slut.

#### boolean countFromEnd [skrivskyddad]

Om sant, läser vektorn bara ett maximalt antal samplingar från källans slut.

#### number skipLength [skrivskyddad]

Antal samplingar att hoppa över.

#### number startFrame [skrivskyddad]

Startpostens nummer.

#### number startFrameRequested [skrivskyddad]

Det begärda startnumret för posten. Kanske inte är den verkliga startposten.

#### number frames [skrivskyddad]

Antal poster att läsa från källan.

#### number framesRequested [skrivskyddad]

Antal poster som begärs ska läsas från källan. Kanske inte är antal verkliga poster.

#### number samplesPerFrame [skrivskyddad]

Antal samplingar per post för tillhörande datakälla.

#### string field [skrivskyddad]

Fältet som läses in från datakällan för att skapa vektorn.

#### DataSource dataSource [skrivskyddad]

Datakällans objekt som används av denna DataVector.

## Klass: Debug

En referens till delsystemet för felsökning och loggning i Kst.

### Metoder:

- warning ( message )

- error ( message )

- notice ( message )

- debug ( message )

- clear ( )

- clearNewError ( )

### Egenskaper:

- log

- newError

- version

- revision

###

#### void warning ( string message )

- string message -

Loggar ett varningsmeddelande i Ksts logg.

#### void error ( string message )

- string message -

Loggar ett felmeddelande i Ksts logg.

#### void notice ( string message )

- string message -

Loggar en anmärkning i Ksts logg.

#### void debug ( string message )

- string message -

Loggar ett felsökningsmeddelande i Ksts logg.

#### void clear ( )

Rensar Ksts logg.

#### void clearNewError ( )

Rensar flaggan för nytt fel.

#### DebugLog log [skrivskyddad]

Ger tillgång till innehållet i Ksts logg.

#### boolean newError [skrivskyddad]

Returnerar värdet på flaggan för nytt fel.

#### string version [skrivskyddad]

Returnerar Ksts version.

#### string revision [skrivskyddad]

Returnerar Ksts revision.

## Klass: DebugLog

En referens till Ksts felsökningslogg. Objektet är ett fält med posterna i felsökningsloggen. Den kan inte ändras. Fältets längd är antalet poster, och varje post är ett DebugLogEntry-objekt.

### Egenskaper:

- length

- text

- lengthNotices

- textNotices

- lengthWarnings

- textWarnings

- lengthErrors

- textErrors

- lengthDebugs

- textDebugs

###

#### number length [skrivskyddad]

Antal poster i loggen.

#### string text [skrivskyddad]

Textinnehållet i loggen som en enda stor sträng med returtecken mellan posterna.

#### number lengthNotices [skrivskyddad]

Antal anmärkningar i loggen.

#### string textNotices [skrivskyddad]

Textinnehållet i loggens anmärkningar som en enda stor sträng med returtecken mellan posterna.

#### number lengthWarnings [skrivskyddad]

Antal varningar i loggen.

#### string textWarnings [skrivskyddad]

Textinnehållet i loggens varningar som en enda stor sträng med returtecken mellan posterna.

#### number lengthErrors [skrivskyddad]

Antal fel i loggen.

#### string textErrors [skrivskyddad]

Textinnehållet i loggens fel som en enda stor sträng med returtecken mellan posterna.

#### number lengthDebugs [skrivskyddad]

Antal felsökningsmeddelanden i loggen.

#### string textDebugs [skrivskyddad]

Textinnehållet i loggens felsökningsmeddelanden som en enda stor sträng med returtecken mellan posterna.

## Klass: DebugLogEntry

En post i felsökningsloggen i Kst.

### Egenskaper:

- text

- date

- level

###

#### string text [skrivskyddad]

Innehåller postens text.

#### date date [skrivskyddad]

Innehåller postens tidstämpel.

#### string level [skrivskyddad]

Innehåller postens loggnivå.

- N - Anmärkning

- D - Felsökning

- W - Varning

- E - Fel

- Ett enstaka mellanslag ' ' anger en okänd posttyp.

## Klass: Dir

Ett objekt som representerar en katalog.

### Konstruktorer:

- Dir ( name )

### Metoder:

- fileList ( nameFilters )

- dirList ( nameFilters )

### Egenskaper:

- path

###

#### Dir ( string name )

- string name - Katalogens namn.

Skapar en katalog i den angivna katalogen.

#### StringArray fileList ( string nameFilters )

- string nameFilters - Anger namnfiltren.

Returnerar en lista med filer i katalogen som matchar angivna namnfilter.

#### StringArray dirList ( string nameFilters )

- string nameFilters - Anger namnfiltren.

Returnerar en lista med underkataloger i katalogen som matchar de angivna namnfiltren.

#### string path

Katalogens sökväg.

## Klass: Document

En pekare till ett Kst-dokument. Oftast kommer man åt det med det globala Kst-objektet viaKst.document.

### Metoder:

- save ( [filename] )

- clear ( )

- load ( filename )

### Egenskaper:

- text

- namn

- modified

###

#### void save ( [string filename] )

- string filename - Ett valfritt filnamn att spara som. Om det inte tillhandahålls, sparas i aktuellt filnamn, eller så blir användaren tillfrågad. [valfri]

Sparar aktuell Kst-session på disk.

#### void clear ( )

Rensar aktuell Kst-session och startar en ny.

#### boolean load ( string filename )

- string filename - Filnamnet på en Kst-fil att ladda.

Laddar en ny Kst-fil i Kst.

#### string text [skrivskyddad]

XML-texten för aktuell session på formen av en Kst-fil.

#### string name

Den aktuella Kst-sessionens filnamn.

#### boolean modified

Sant om dokumentet har ändrats men inte sparats.

## Klass: Ellipse

Anpassningsbar grafisk ellips.

Ärver: ViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Ellipse ( parent )

- Ellipse ( window )

### Egenskaper:

- borderWidth

- borderColor

###

#### Ellipse ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya ellipsen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny ellips och placerar den i vyobjektet parent.

#### Ellipse ( Window window )

- Window window - Fönstret som den nya ellipsen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny ellips och placerar den i fönstret window.

#### number borderWidth

Bredden på ellipsens kant.

#### string borderColor

Färgen på ellipsens kant.

## Klass: ELOG

Ett objekt som representerar ett gränssnitt till en ELOG-server.

### Konstruktorer:

- ELOG ( )

### Metoder:

- submit ( )

- addAttachment ( attachment )

- clearAttachments ( )

- addAttribute ( attribute, attributeValue )

- removeAttribute ( attribute )

- clearAttributes ( )

### Egenskaper:

- hostname

- port

- logbook

- username

- password

- writePassword

- text

- encodedHTML

- suppressEmailNotification

- includeCapture

- captureWidth

- captureHeight

- includeConfiguration

- includeDebugInfo

###

#### ELOG ( )

Gränssnitt till en ELOG-server.

#### void submit ( )

Skickar in ELOG-posten.

#### void addAttachment ( string attachment )

- string attachment - Bilagans namn.

Lägger till en bilaga till ELOG-posten.

#### void clearAttachments ( )

Rensar listan med bilagor till ELOG-posten.

#### void addAttribute ( string attribute, string attributeValue )

- string attribute - Namn på egenskapen som ska läggas till i ELOG-posten.

- string attributeValue - Värdet för egenskapen som ska läggas till i ELOG-posten.

Lägger till en egenskap i ELOG-posten.

#### void removeAttribute ( string attribute )

- string attribute - Namn på egenskapen som ska tas bort från ELOG-posten.

Tar bort en egenskap från ELOG-posten.

#### void clearAttributes ( )

Rensar listan med egenskaper i ELOG-posten.

#### string hostname

ELOG-serverns värddatornamn.

#### number port

ELOG-serverns portnummer.

#### string logbook

En webblogg som görs tillgänglig av ELOG-servern.

#### string username

Användarnamn.

#### string password

Lösenord.

#### string writePassword

Skrivlösenordet.

#### string text

Text.

#### boolean encodedHTML

Meddelandet är kodat med HTML.

#### boolean suppressEmailNotification

Om sant, sker ingen underrättelse via e-post.

#### boolean includeCapture

Om sant ingår en skärmbild av Kst-sessionen i ELOG-posten.

#### number captureWidth

Bredden på skärmbilden som ska ingå i ELOG-posten.

#### number captureHeight

Höjden på skärmbilden som ska ingå i ELOG-posten.

#### boolean includeConfiguration

Om sant ingår Kst-sessionens nuvarande status i ELOG-posten.

#### boolean includeDebugInfo

Om sant ingår nuvarande felsökningsinformation från Kst i ELOG-posten.

## Klass: Equation

Objektet representerar ett ekvationsobjekt i Kst. Det tolkas med Ksts interna ekvationstolk, och inte Javascript-tolken. Det bör vara väsentligt snabbare än Javascript-tolken.

Ärver: DataObject

Samlingsklass: EquationCollection

### Konstruktorer:

- Equation ( equation, xVector [, interpolate] )

- Equation ( equation, x0, x1, n )

### Egenskaper:

- equation

- valid

- xVector

- yVector

###

#### Equation ( string equation, Vector xVector [, boolean interpolate] )

- string equation - Ekvationstexten som ska tolkas.

- Vector xVector - X-axelvektorn (indatavektorn) att använda. Den symboliska variabeln x representerar värdet för aktuellt index i vektorn. En textsträng som representerar namnet på en befintlig vektor kan också användas här.

- boolean interpolate - Om sant, interpolerar ekvationstolken till vektorn med högst upplösning. Det är det normala beteendet. [valfri]

Standardkonstruktorn för att skapa ett ekvationsobjekt.

#### Equation ( string equation, number x0, number x1, number n )

- string equation - Ekvationstexten som ska tolkas.

- number x0 - Det första värdet i den skapade X (indata)-vektorn.

- number x1 - Det sista värdet i den skapade X (indata)-vektorn.

- number n - Antalet värdet i den skapade indata-vektorn.

En hjälpkonstruktor som implicit skapar en X-vektor.

#### string equation

Ekvationens text. Se Ksts dokumentation för mer information om vad den interna ekvationstolken stöder.

#### boolean valid [skrivskyddad]

Sant om ekvationsobjektet är giltigt. Om falskt, ska alla värden som erhålls från Y-vektorn anses vara meningslösa.

#### Vector xVector [skrivskyddad]

Ekvationens X-vektor (indatavektor).

#### Vector yVector [skrivskyddad]

Ekvationens Y-vektor (utdatavektor).

## Klass: EquationCollection

Ett fält av ekvationer.

Ärver: Collection

###

## Klass: Extension

En klass som representerar en utökning i Kst.

Samlingsklass: ExtensionCollection

### Metoder:

- load ( )

- unload ( )

### Egenskaper:

- namn

- loaded

###

#### boolean load ( )

Laddar utökning i Kst.

#### void unload ( )

Laddar ur utökningen om den är laddad.

#### string name [skrivskyddad]

Utökningens namn.

#### boolean loaded [skrivskyddad]

Sant om utökningen för närvarande är laddad.

## Klass: ExtensionCollection

Ett fält av Kst-utökningsobjekt.

Ärver: Collection

###

## Klass: File

Ett objekt som representerar en fil.

### Konstruktorer:

- File ( name )

### Metoder:

- open ( )

- close ( )

- readLine ( [length] )

### Egenskaper:

- namn

- size

- exists

###

#### File ( string name )

- string name - Namn på filen som ska öppnas.

Skapar en fil med angivet namn.

#### void open ( )

Öppnar filen.

#### void close ( )

Stänger filen.

#### string readLine ( [number length] )

- number length - Maximal längd på strängen som returneras [valfri]

Läser en rad från filen.

#### string name

Filens namn.

#### number size

Filens storlek.

#### boolean exists

Sant om den bakomliggande filen finns.

## Klass: Group

Anpassningsbart grafiskt gruppobjekt.

Ärver: ViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Group ( parent )

- Group ( window )

### Metoder:

- append ( newObj )

- prepend ( newObj )

- ungroup ( )

###

#### Group ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya pilen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny pil och placerar den i vyobjektet parent.

#### Group ( Window window )

- Window window - Fönstret som den nya pilen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny pil och placerar den i fönstret window.

#### void append ( Object newObj )

- Object newObj - Det nya objektet som ska läggas till sist i samlingen.

Lägger till ett nytt objekt i slutet av samlingen.

#### void prepend ( Object newObj )

- Object newObj - Det nya objektet som ska läggas till först i samlingen.

Lägger till ett nytt objekt i början av samlingen.

#### void ungroup ( )

Tar bort alla objekt från samlingen.

## Klass: Histogram

En klass som representerar ett histogramobjekt i Kst.

Ärver: DataObject

Samlingsklass: HistogramCollection

### Konstruktorer:

- Histogram ( vector [, xMin [, xMax [, bins]]] )

### Metoder:

- setVector ( vector )

- setRange ( from, to )

### Egenskaper:

- realTimeAutoBin

- normalization

- bins

- xMin

- xMax

- xVector

- yVector

###

#### Histogram ( Vector vector [, number xMin [, number xMax [, number bins]]] )

- Vector vector - Indatavektorn för histogrammet. Kan också anges med tagName för en befintlig vektor.

- number xMin - Det minimala X-värdet. Förvalt värde är -10. [valfri]

- number xMax - Det maximala X-värdet. Förvalt värde är 10. [valfri]

- number bins - Antal områden att använda. Förvalt värde är 60. [valfri]

Skapar ett nytt histogram med de definierade egenskaperna.

#### void setVector ( Vector vector )

- Vector vector - Vektorn som histogrammet ska använda sig av.

Anger indatavektorn för histogrammet.

#### void setRange ( number from, number to )

- number from - Startvärde för X.

- number to - Slutvärde för X.

Anger X-intervall för histogrammet.

#### boolean realTimeAutoBin

Om sant, skapar histogrammet automatiskt områden i realtid.

#### number normalization

Anger Y-axelns normalisering.

- 0 - Tal i område

- 1 - Procent i område

- 2 - Bråk i område

- 3 - Toppområde = 1.0

#### number bins

Antal områden i histogrammet.

#### number xMin [skrivskyddad]

Det minimala X-värdet för histogrammet.

#### number xMax [skrivskyddad]

Det maximala X-värdet för histogrammet.

#### Vector xVector [skrivskyddad]

X-axelvektorn som skapats av histogrammet.

#### Vector yVector [skrivskyddad]

Y-axelvektorn som skapats av histogrammet.

## Klass: HistogramCollection

Ett fält av histogram.

Ärver: Collection

###

## Klass: Image

Ett bildobjekt skapat från en matris.

Ärver: DataObject

### Konstruktorer:

- Image ( matrix )

### Metoder:

- minMaxThreshold ( )

- smartThreshold ( )

### Egenskaper:

- matrix

- map

- palette

- lowerThreshold

- upperThreshold

- autoThreshold

- numContours

- contourWeight

- color

###

#### Image ( Matrix matrix )

- Matrix matrix - Bildens matris. KanKan anges som en sträng som innehåller taggnamnet på en befintlig matris, eller som ett matrisobjekt.

Huvudkonstruktor för klassen Image. Att skapa en ny bild lägger automatiskt till den i Ksts datasamling.

#### void minMaxThreshold ( )

Ställer in trösklarna till aktuellt minimum och maximum för tillhörande matris.

#### void smartThreshold ( )

Ställer in trösklarna till automatiskt beräknade smarta värden baserat på aktuella värden i tillhörande matris.

#### Matrix matrix

Matrisen som hör ihop med bilden.

#### number map

Bildens avbildningstyp.

- 0 - Färgavbildning

- 1 - Konturavbildning

- 2 - Färg- och konturavbildning

#### string palette

Namn på paletten som hör ihop med bildens färger.

#### number lowerThreshold

Den undre tröskeln som hör ihop med avbildningen.

#### number upperThreshold

Den övre tröskeln som hör ihop med avbildningen.

#### boolean autoThreshold

Om sant, är automatiska trösklar aktiverade.

#### number numContours

Antal konturnivåer om konturavbildning är aktiverad.

#### number contourWeight

Linjebredden som används för att rita konturavbildningen, om konturavbildningen är aktiverad. Värdet -1 kan användas för variabel konturbredd.

#### string color

Konturernas färg. Lagras på formen "#RRGGBB" som hexadecimala värden. Egenskapen kan också anges med engelska strängar, såsom "blue".

## Klass: Kst

Det globala Kst-objektet. Man kommer åt det som Kst och det kan inte instantieras om.

### Metoder:

- loadScript ( fileName )

- resetInterpreter ( )

- waitForUpdate ( )

- purge ( )

- advance ( )

- back ( )

- writeHistory ( filename )

- clearHistory ( )

- addToOutput ( output )

### Egenskaper:

- dataSources

- scalars

- strings

- vectors

- matrices

- windows

- objects

- colors

- extensions

- document

- pluginManager

- gui

###

#### boolean loadScript ( string fileName )

- string fileName - Filen som skriptet ska laddas från.

Laddar en skriptfil från disk och kör den.

#### void resetInterpreter ( )

Återställer tolken av Kst-skript. Alla variabler går förlorade.

#### void waitForUpdate ( )

Väntar på nästa uppdateringsvarv för att göra färdigt.

#### void purge ( )

Rensar oanvända objekt i Kst. Har samma beteende som knappen Rensa i datahanteringen.

#### void advance ( )

Gå vidare en skärm.

#### void back ( )

Gå tillbaka en skärm.

#### void writeHistory ( string filename )

- string filename - Filnamnet på filen att spara kommandohistoriken i.

Sparar kommandohistoriken i en fil.

#### void clearHistory ( )

Rensar kommandohistoriken.

#### void addToOutput ( string output )

- string output - Sträng att lägga till i utdata.

Lägger till i utdata skapad av ett funktionsanrop.

#### DataSourceCollection dataSources [skrivskyddad]

Listan över alla laddade datakällor.

#### ScalarCollection scalars [skrivskyddad]

Listan över alla skalärer i Kst.

#### StringCollection strings [skrivskyddad]

Listan över alla strängar i Kst.

#### VectorCollection vectors [skrivskyddad]

Listan över alla vektorer i Kst.

#### MatrixCollection matrices [skrivskyddad]

Listan över alla matriser i Kst.

#### WindowCollection windows [skrivskyddad]

Listan över alla Kst-fönster i processen.

#### DataObjectCollection objects [skrivskyddad]

Listan över alla dataobjekt i Kst.

#### ColorSequence colors [skrivskyddad]

En referens till färgsekvensen i Kst med sin nuvarande status.

#### ExtensionCollection extensions [skrivskyddad]

Listan över alla utökningar som Kst hittar är installerade på systemet.

#### Document document [skrivskyddad]

Ett objekt som ger tillgång till det aktuella Kst-dokumentet tillsammans med diverse hjälpfunktioner.

#### PluginManager pluginManager [skrivskyddad]

En referens till delsystemet för instickshantering i Kst.

#### QWidget gui [skrivskyddad]

En referens till Ksts grafiska användargränssnitt. Det är implementerat med hjälp av KJSEmbed. Det grafiska användargränssnittet är dynamiskt, och kan ändras mellan utgåvor eller till och med medan Kst kör.

## Klass: Label

En textrubrik.

Ärver: BorderedViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Label ( parent )

- Label ( window )

### Metoder:

- adjustSizeForText ( )

### Egenskaper:

- text

- font

- fontSize

- rotation

- dataPrecision

- interpreted

- scalarReplacement

- autoResize [föråldrad]

###

#### Label ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya texten ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny text och placerar den i vyobjektet parent.

#### Label ( Window window )

- Window window - Fönstret som den nya texten ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny text och placerar den i fönstret window.

#### void adjustSizeForText ( )

Justera textens storlek så att den passar innehållet.

#### string text

Innehåller textens värde. Det kan inkludera returtecken (\n), skalärreferenser på formen [skalärnamn], och en del grundläggande Latex.

#### string font

Används för att ange eller hämta aktuellt teckensnitt som används för texten.

#### number fontSize

Innehåller storleken hos teckensnittet som används för att skriva ut texten.

#### number rotation

Innehåller textens rotationsvinkel. Rotationen är medurs från normal, och lagras i grader.

#### number dataPrecision

Innehåller precision i antal siffror som datavärden visas med i texten. Begränsat till ett värde mellan 0 och 16.

#### boolean interpreted

Bestämmer om textens innehåll ska tolkas för att ersätta Latex-liknande konstruktioner. Normalvärdet är sant.

#### boolean scalarReplacement

Bestämmer om textens innehåll ska tolkas för att ersätta konstruktioner med variabelreferenser. Normalvärdet är sant.

#### boolean autoResize [föråldrad]

Ändrar automatiskt texten så att den exakt passar innehållet. Kan orsaka en viss förflyttning av texten. Den ändrar inte automatiskt storlek om användaren ändrar dess storlek för hand via storleksegenskapen eller i layoutläge.

## Klass: Legend

Förklaringen för ett diagram.

Ärver: BorderedViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Legend ( parent )

- Legend ( window )

### Metoder:

- addCurve ( curve )

- removeCurve ( curve )

### Egenskaper:

- font

- fontSize

- textColor

- vertical

- curves

- title

###

#### Legend ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya förklaringen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny förklaring och placerar den i vyobjektet parent.

#### Legend ( Window window )

- Window window - Fönstret som den nya förklaringen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny förklaring och placerar den i fönstret window.

#### void addCurve ( string curve )

- string curve - Kurvan att lägga till. Det kan antingen vara kurvans namn eller en referens till kurvan.

Lägger till kurvan i förklaringen.

- Kastar: TypeError - Kastar undantaget om kurvan inte kunde hittas.

#### void removeCurve ( string curve )

- string curve - Kurvan som ska tas bort. Det kan antingen vara kurvans namn eller en referens till kurvan.

Tar bort kurvan från förklaringen.

- Kastar: TypeError - Kastar undantaget om kurvan inte kunde hittas.

#### string font

Används för att ange eller hämta aktuellt teckensnitt som används för texten.

#### number fontSize

Innehåller storleken hos teckensnittet som används för att skriva ut texten.

#### string textColor

Innehåller textfärgen som används för att rita förklaringen.

#### boolean vertical

Sant om förklaringens poster visas vertikalt.

#### CurveCollection curves [skrivskyddad]

Listan över kurvor som visas i förklaringen.

#### string title

Förklaringens rubrik.

## Klass: Line

Anpassningsbar grafisk linje.

Ärver: ViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Line ( parent )

- Line ( window )

### Egenskaper:

- from

- to

- width

- capStyle

- lineStyle

###

#### Line ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya linjen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny linje och placerar den i vyobjektet parent.

#### Line ( Window window )

- Window window - Fönstret som den nya linjen ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny linje och placerar den i fönstret window.

#### Point from

Linjens startpunkt.

#### Point to

Linjens slutpunkt.

#### number width

Linjens bredd.

#### number capStyle

Linjens ändstil.

- 0 - Platt, kan inte täcka linjens ändar (förval)

- 1 - Ruta, kan fortsätta förbi linjens ändar

- 2 - Rundad

#### number lineStyle

Linjens stil.

- 0 - Heldragen linje (förval)

- 1 - Streckad linje

- 2 - Punktlinje

- 3 - Streck punkt-linje

- 4 - Streck punkt punkt-linje

## Klass: Matrix

Representerar en matris av godtycklig typ i Kst. Vissa matriser kan redigeras, medan andra inte kan det.

Ärver: Object

Samlingsklass: MatrixCollection

### Konstruktorer:

- Matrix ( )

### Metoder:

- resize ( columns, rows )

- zero ( )

- value ( column, row )

- setValue ( column, row, value )

- update ( )

### Egenskaper:

- editable

- min

- max

- mean

- numNew

- rows

- columns

###

#### Matrix ( )

Standardkonstruktor som skapar en tom matris.

#### void resize ( number columns, number rows )

- number columns - Det nya antalet rader i matrisen. Ska vara ≥ 1.

- number rows - Det nya antalet kolumner i matrisen. Ska vara ≥ 1.

Ändrar matrisens storlek.

- Kastar: GeneralError - Kastar undantaget om matrisen inte kan redigeras.

#### void zero ( )

Sätter alla värden i matrisen till noll.

- Kastar: GeneralError - Kastar undantaget om matrisen inte kan redigeras.

#### number value ( number column, number row )

- number column - Kolumnindex för matrispositionen som ska läsas.

- number row - Radindex för matrispositionen som ska läsas.

Hämtar värdet i en matris för givna kolumn- och radindex.

- Kastar: GeneralError - Kastar undantaget om index är utanför intervallet.

#### void setValue ( number column, number row, number value )

- number column - Kolumnindex för matrispositionen som ska tilldelas.

- number row - Radindex för matrispositionen som ska tilldelas.

- number value - Värdet som den angivna matrispositionen ska tilldelas.

Tilldelar värdet i en matris för givna kolumn- och radindex.

- Kastar: GeneralError - Kastar undantaget om matrisen inte kan redigeras eller index är utanför intervallet.

#### void update ( )

Uppdaterar statistiska värden som hör ihop med en matris.

- Kastar: GeneralError - Kastar undantaget om matrisen inte kan redigeras.

#### number editable [skrivskyddad]

Sant om matrisen kan redigeras av användaren. Det bör kontrolleras innan man försöker ändra matrisen på något sätt.

#### number min [skrivskyddad]

Värdet på den minsta samplingen i matrisen.

#### number max [skrivskyddad]

Värdet på den största samplingen i matrisen.

#### number mean [skrivskyddad]

Medelvärdet av alla samplingar i matrisen.

#### number numNew [skrivskyddad]

Antal nya samplingar.

#### number rows [skrivskyddad]

Antal rader i matrisen.

#### number columns [skrivskyddad]

Antal kolumner i matrisen.

## Klass: MatrixCollection

Ett fält av matriser.

Ärver: Collection

###

## Klass: Object

Representerar vilket objekt som helst i Kst. Detta är ett abstrakt objekt och kan inte instantieras direkt.

Samlingsklass: ObjectCollection

### Egenskaper:

- tagName

- fullTagName

###

#### string tagName

En unik identifierar för dataobjektet.

#### string fullTagName [skrivskyddad]

En unik sammanhangsrelaterad identifierar för dataobjektet, avgränsad med [...].

## Klass: ObjectCollection

Ett fält av objekt. Det kan innehålla alla objekt som ärver Object, men de är bara omedelbart åtkomliga i sin rena basklassform.

Ärver: Collection

###

## Klass: Picture

Anpassningsbart grafiskt bildobjekt.

Ärver: BorderedViewObject

Samlingsklass: ViewObjectCollection

### Konstruktorer:

- Picture ( parent )

- Picture ( window )

### Metoder:

- load ( url )

### Egenskaper:

- image

- url

- refreshTimer

###

#### Picture ( ViewObject parent )

- ViewObject parent - Överliggande objekt som den nya bilden ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt ViewObject.

Skapar en ny bild och placerar den i vyobjektet parent.

#### Picture ( Window window )

- Window window - Fönstret som den nya bilden ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar en ny bild och placerar den i fönstret window.

#### boolean load ( string url )

- string url - Webbadressen som bilden hämtas från.

Ladda en bild från en given webbadress. Returnerar sant om det lyckas.

#### Image image

Den obehandlade bilden som visas. Du kan göra en kopia av den, behandla den, och därefter sätta tillbaka den för att ändra bilden.

#### string url [skrivskyddad]

Bildens webbadress om den laddades från en fil och inte har ändrats.

#### number refreshTimer

En tidtagning för att automatiskt uppdatera bilden. Värdet 0 betyder att tidtagningen är inaktiv. Enheten är sekunder.

## Klass: Plot

Klassen representerar ett diagram i Kst.

Ärver: BorderedViewObject

Samlingsklass: PlotCollection

### Konstruktorer:

- Plot ( window )

### Metoder:

- createLegend ( )

### Egenskaper:

- curves

- legend

- topLabel

- xAxis

- yAxis

- title

- tied

###

#### Plot ( Window window )

- Window window - Fönstret som det nya diagrammet ska placeras i. Kan också vara en sträng som innehåller namnet på ett befintligt fönster.

Skapar ett nytt diagram och placerar det i fönstret window.

#### Legend createLegend ( )

Skapar en förklaring för diagrammet. Om en förklaring redan finns, så returneras den.

#### CurveCollection curves [skrivskyddad]

En lista över alla kurvor som används av diagrammet.

#### Legend legend [skrivskyddad]

Förklaringen för diagrammet. Kan vara null.

#### string topLabel

Diagrammets rubrik.

#### Axis xAxis [skrivskyddad]

X-axeln för diagrammet.

#### Axis yAxis [skrivskyddad]

Y-axeln för diagrammet.

#### PlotLabel title [skrivskyddad]

Diagrammets rubrik.

#### boolean tied

Sant om diagrammets zoomläge är bundet.

## Klass: PlotCollection

Ett fält av diagram.

Ärver: Collection

###

## Klass: PlotLabel

En klass som representerar en diagramrubrik.

### Egenskaper:

- text

- font

- fontSize

- justification

- dataPrecision

###

#### string text

Innehåller textens värde. Det kan inkludera returtecken (\n), skalärreferenser på formen [skalärnamn], och en del grundläggande Latex.

#### string font

Används för att ange eller hämta aktuellt teckensnitt som används för texten.

#### number fontSize

Innehåller storleken hos teckensnittet som används för att skriva ut texten.

#### number justification

Textens horisontella justering. Detta är ett bitfält. Värdena är följande:

- 0 - Ingen justering

- 1 - Justera vänster och uppåt

- 2 - Justera höger och neråt

- 3 - Justera till mitten

#### number dataPrecision

Innehåller precision i antal siffror som datavärden visas med i texten. Begränsat till ett värde mellan 0 och 16.

## Klass: Plugin

Klassen representerar ett datainsticksprogram i Kst. Den kan instantieras för att skapa en ny instans av ett insticksprogram i Ksts datasamling.

Ärver: DataObject

Samlingsklass: PluginCollection

### Konstruktorer:

- Plugin ( [module] )

### Metoder:

- setInput ( index, input )

- validate ( )

### Egenskaper:

- inputs

- outputs

- module

- lastError

- valid

###

#### Plugin ( [PluginModule module] )

- PluginModule module - Insticksmodul att använda för det här insticksprogrammet. [valfri]

Huvudkonstruktor för klassen Plugin. Nya insticksprogram är oftast ogiltiga innan diverse egenskaper har ställts in.

#### void setInput ( number index, Object input )

- number index - eller namn på indata-argumentet som ska tilldelas.

- Object input - argument.

Tilldelar indata-argumentet för angivet index eller namn.

#### void validate ( )

Validerar insticksprogrammet.

#### ObjectCollection inputs

Listan med insticksprogrammets indata.

#### ObjectCollection outputs

Listan med insticksprogrammets utdata.

#### PluginModule module

Biblioteket eller modulen som används för databehandling av det här insticksobjektet.

#### string lastError [skrivskyddad]

En sträng som innehåller information om det senaste felet som uppstod när insticksprogrammet kördes.

#### boolean valid [skrivskyddad]

Sant om insticksobjektet är giltigt. Om falskt, finns det troligen en felaktig inställning någonstans som måste rättas innan det kan användas. Vissa fel inkluderar ogiltig indata eller utdata, eller en ogiltig eller saknad insticksmodul.

## Klass: PluginCollection

Ett fält av insticksprogram.

Ärver: Collection

###

## Klass: PluginIO

Ett objekt som representerar indata eller utdata för en given insticksmodul.

Samlingsklass: PluginIOCollection

### Egenskaper:

- namn

- type

- subType

- typeObject

- description

- defaultValue

###

#### string name [skrivskyddad]

Namn på indata eller utdata.

#### string type [skrivskyddad]

Datatyp för indata eller utdata.

#### string subType [skrivskyddad]

Deltypen för indata eller utdata, om den behövs. Till exempel kan en tabell ha deltypen float.

#### string typeObject [skrivskyddad]

Objekttypen för indata eller utdata. Resultatet är något av:

- Vector

- Scalar

- String

- Unknown - feltillstånd

#### string description [skrivskyddad]

En beskrivning av betydelsen av indata eller utdata.

#### string defaultValue [skrivskyddad]

Förvalt värde för indata eller utdata, om angivet av insticksprogrammet.

## Klass: PluginIOCollection

Ett fält av indata eller utdata från ett insticksprogram

Ärver: Collection

###

## Klass: PluginManager

En referens till delsystemet för instickshantering i Kst.

### Konstruktorer:

- PluginManager ( )

### Egenskaper:

- modules

###

#### PluginManager ( )

Skapar en ny PluginManager som refererar till Ksts hantering av insticksprogram.

#### PluginModuleCollection modules [skrivskyddad]

Ett lista med alla tillgängliga insticksmoduler.

## Klass: PluginModule

Representerar en insticksmodul i Kst. Det är inte en instans av ett insticksprogram, utan en referens till själva insticksprogrammet. Den används oftast för att instantiera ett insticksobjekt.

Samlingsklass: PluginModuleCollection

### Egenskaper:

- usesLocalData

- isFit

- isFilter

- namn

- readableName

- author

- description

- version

- inputs

- outputs

###

#### boolean usesLocalData [skrivskyddad]

Om sant, utnyttjar insticksprogrammet lokal bestående lagring.

#### boolean isFit [skrivskyddad]

Om sant är insticksprogrammet anpassning fit for a kurva.

#### boolean isFilter [skrivskyddad]

Om sant är insticksprogrammet ett filter för en vektor.

#### string name [skrivskyddad]

Representerar insticksprogrammets korta namn.

#### string readableName [skrivskyddad]

Innehåller ett långt namn på insticksprogrammet lämpligt att visa i ett användargränssnitt.

#### string author [skrivskyddad]

Innehåller namn på insticksprogrammets upphovsman.

#### string description [skrivskyddad]

Innehåller en textbeskrivning av vad insticksprogrammet är och/eller gör.

#### string version [skrivskyddad]

Innehåller insticksprogrammets versionsnummer eller -sträng.

#### PluginIOCollection inputs [skrivskyddad]

En lista över insticksprogrammets alla indata.

#### PluginIOCollection outputs [skrivskyddad]

En lista över insticksprogrammets alla utdata.

## Klass: PluginModuleCollection

Ett fält av insticksmoduler.

Ärver: Collection

###

## Klass: Point

Representerar en kartesisk koordinat på formen (x,y).

### Konstruktorer:

- Point ( )

- Point ( x, y )

### Egenskaper:

- x

- y

###

#### Point ( )

Skapar ett nytt punktobjekt med värdet (0.0, 0.0).

#### Point ( number x, number y )

- number x - X-värdet.

- number y - Y-värdet.

Skapar ett nytt punktobjekt med värdet (x, y).

#### number x

X-koordinatens värde.

#### number y

Y-koordinatens värde.

## Klass: PowerSpectrum

Klassen representerar ett effektspektrumobjekt (PSD) i Kst.

Ärver: DataObject

Samlingsklass: PowerSpectrumCollection

### Konstruktorer:

- PowerSpectrum ( vector, freq [, average [, len [, apodize [, removeMean]]]] )

### Egenskaper:

- vector

- length

- output

- removeMean

- average

- apodize

- apodizeFn

- frequency

- xVector

- yVector

- vUnits

- rUnits

- interpolateHoles

###

#### PowerSpectrum ( Vector vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )

- Vector vector - Vektorn att använda som indata till effektspektrat.

- number freq - Effektspektrats frekvens.

- boolean average - [valfri]

- number len - Bas-2 logaritmen av spektrogrammets längd. Ska vara ett heltal ≥ 4.

- boolean apodize - Om sant, tas grova diskontinuiteter bort. [valfri]

- boolean removeMean - Sant om medelvärdet först ska tas bort innan transformen utförs. [valfri]

Skapar ett nytt effektspektrumobjekt (PSD) i Kst. Enheterna är normalt V och Hz.

#### Vector vector

Indatavektorn för effektspektrat.

#### number length

Innehåller bas-2 logaritmen för längden att använda för interfolierad medelvärdesberäkning. Ska vara ett heltal ≥ 4.

#### number output

normaliseringen av transformen:

- 0 - spektral amplitudtäthet

- 1 - spektral effekttäthet

- 2 - amplitudspektrum

- 3 - effektspektrum

#### boolean removeMean

Sant om medelvärdet först ska tas bort innan transformen utförs.

#### boolean average

Sant om effektspektrat ska beräknas genom att använda ett interfolierat medelvärde.

#### boolean apodize

Om sant, tas grova diskontinuiteter bort.

#### number apodizeFn

Apodiseringsfunktion att använda i fallet då apodize är sant:

- 0 - förval

- 1 - bartlett

- 2 - blackman

- 3 - connes

- 4 - cosinus

- 5 - gaussisk

- 6 - hamming

- 7 - hann

- 8 - welch

- 9 - likformig

#### number frequency

Innehåller effektspektrats samplingsfrekvens.

#### Vector xVector [skrivskyddad]

X-axelvektorn för effektspektrat.

#### Vector yVector [skrivskyddad]

Y-axelvektorn för effektspektrat.

#### string vUnits

En sträng som innehåller vektorns enhet.

#### string rUnits

En sträng som innehåller frekvensens enhet.

#### boolean interpolateHoles

Sant om transformen automatiskt ska interpolera saknade datavärden.

## Klass: PowerSpectrumCollection

Ett fält av effekspektra.

Ärver: Collection

###

## Klass: Scalar

Representerar ett skalärt värde (ett tal) i Kst.

Ärver: Object

Samlingsklass: ScalarCollection

### Konstruktorer:

- Scalar ( )

- Scalar ( värde )

### Egenskaper:

- värde

###

#### Scalar ( )

Standardkonstruktor. Skapar en ny skalär med värdet 0.0.

#### Scalar ( number value )

- number value -

Skapar en ny skalär med angivet värde.

#### number value

Används för att komma åt eller ändra en skalärs värde.

## Klass: ScalarCollection

Ett fält av skalärer.

Ärver: Collection

###

## Klass: Size

Representerar en tvådimensionell storlek på formen (w, h).

### Konstruktorer:

- Size ( )

- Size ( w, h )

### Egenskaper:

- w

- h

###

#### Size ( )

Skapar ett nytt storleksobjekt med värdet (0.0, 0.0).

#### Size ( number w, number h )

- number w - Bredden.

- number h - Höjden.

Skapar ett nytt storleksobjekt med värdet (0.0, 0.0).

#### number w

Bredden.

#### number h

Höjden.

## Klass: Spectrogram

Klassen representerar ett spektrogramobjekt (CSD) i Kst.

Ärver: DataObject

Samlingsklass: SpectrogramCollection

### Konstruktorer:

- Spectrogram ( vector, freq [, average [, len [, apodize [, removeMean]]]] )

### Egenskaper:

- vector

- length

- output

- removeMean

- average

- apodize

- apodizeFn

- frequency

- matrix

- vUnits

- rUnits

- windowSize

- interpolateHoles

###

#### Spectrogram ( Vector vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )

- Vector vector - Vektorn att använda som indata till spektrogrammet.

- number freq - Spektrogrammets frekvens.

- boolean average - [valfri]

- number len - Bas-2 logaritmen av spektrogrammets längd. Ska vara ett heltal ≥ 4.

- boolean apodize - Om sant, tas grova diskontinuiteter bort. [valfri]

- boolean removeMean - Sant om medelvärdet först ska tas bort innan transformen utförs. [valfri]

Skapar ett nytt effektspektrumobjekt (PSD) i Kst. Enheterna är normalt V och Hz.

#### Vector vector

Indatavektorn för spektrogrammet.

#### number length

Innehåller bas-2 logaritmen av spektrogrammets längd. Ska vara ett heltal ≥ 4.

#### number output

normaliseringen av transformen:

- 0 - spektral amplitudtäthet

- 1 - spektral effekttäthet

- 2 - amplitudspektrum

- 3 - effektspektrum

#### boolean removeMean

Sant om medelvärdet först ska tas bort innan transformen utförs.

#### number average

#### boolean apodize

Om sant, tas grova diskontinuiteter bort.

#### number apodizeFn

Apodiseringsfunktion att använda i fallet då apodize är sant:

- 0 - förval

- 1 - bartlett

- 2 - blackman

- 3 - connes

- 4 - cosinus

- 5 - gaussisk

- 6 - hamming

- 7 - hann

- 8 - welch

- 9 - likformig

#### number frequency

Innehåller spektrogrammets samplingsfrekvens.

#### Matrix matrix [skrivskyddad]

Spektrogrammets matris.

#### string vUnits

En sträng som innehåller vektorns enhet.

#### string rUnits

En sträng som innehåller frekvensens enhet.

#### number windowSize

Spektrogrammets fönsterstorlek.

#### boolean interpolateHoles

Sant om transformen automatiskt ska interpolera saknade datavärden.

## Klass: SpectrogramCollection

Ett fält av spektrogram.

Ärver: Collection

###

## Klass: String

Representerar en sträng i Kst. Observera att det inte motsvarar en sträng i Javascript, och kan inte direkt utbytas mot en sådan. En Kst-sträng är ett objekt som är internt i Kst, och är föremål för schemaläggning för uppdatering, delning och andra hanteringssätt i Ksts kärna. Dock kan strängens innehåll behandlas med stränghanteringsfunktioner i Javascript.

Ärver: Object

Samlingsklass: StringCollection

### Konstruktorer:

- String ( )

### Egenskaper:

- värde

###

#### String ( )

Standardkonstruktor - skapar en tom String.

#### string value

Strängens värde.

## Klass: StringCollection

Ett fält av Kst-strängar.

Ärver: Collection

###

## Klass: TimeInterpretation

En klass som representerar en tidstolkning. Den används för att konvertera värden från en uppsättning enheter för att visas med en annan.

### Egenskaper:

- active

- axisType

- input

- output

###

#### boolean active

Sant om axeln tolkas.

#### string axisType [skrivskyddad]

Typ av axel som tolkningen gäller.

#### number input

Indataformatet för tolkning. Måste vara ett av:

- 0 - Standard C-tid

- 1 - TAI

- 2 - JD

- 3 - MJD

- 4 - RJD

- 5 - JY

- 6 - TAI (ns)

- 7 - TAI (2^-16 s)

#### number output

Formatet som tolkningen ska konverteras till. Måste vara ett av:

- 0 - DD/MM/ÅÅ TT:MM:SS

- 1 - ÅÅ/MM/DD TT:MM:SS

- 2 - JD

- 3 - MJD

- 4 - RJD

- 5 - JY

- 6 - Lokalt kort datum

- 7 - Lokalt långt datum

## Klass: Vector

Representerar en vektor av godtycklig typ i Kst. Vissa vektorer kan redigeras, medan andra inte kan det. Klassen beter sig precis som ett fält i Javascript, men har ytterligare egenskaper och metoder.

Ärver: Object

Samlingsklass: VectorCollection

### Konstruktorer:

- Vector ( )

- Vector ( fält )

### Metoder:

- resize ( size )

- interpolate ( i, n )

- zero ( )

- update ( )

- valueAt ( index )

### Egenskaper:

- length

- min

- max

- mean

- numNew

- numShifted

- editable

- numNaN

- array

###

#### Vector ( )

Standardkonstruktor - skapar en tom, redigerbar Vector.

#### Vector ( Array array )

- Array array - Fältet som ska kopieras.

Skapar en vektor som är en kopia av ett fält.

#### void resize ( number size )

- number size - Vektorns nya storlek. Ska vara ≥ 2.

Ändrar vektorns storlek.

- Kastar: GeneralError - Kastar undantaget om vektorn inte kan redigeras.

#### number interpolate ( number i, number n )

- number i - Samplingsnummer vars interpolerade värde ska erhållas.

- number n - Antal samplingar att interpolera till.

Interpolerar vektorn till n samplingar och returnerar det interpolerade värdet av samling i.

#### void zero ( )

Sätter alla värden i vektorn till noll.

- Kastar: GeneralError - Kastar undantaget om vektorn inte kan redigeras.

#### void update ( )

Uppdaterar statistiska värden som hör ihop med en vektor.

- Kastar: GeneralError - Kastar undantaget om vektorn inte kan redigeras.

#### void valueAt ( number index )

- number index - Samplingsnummer vars värde ska hämtas. Ett negativt värde -n returnera den n:te samplingen från vektorns slut..

Returnerar värdet på angivet index.

#### number length [skrivskyddad]

Antal samplingar i vektorn.

#### number min [skrivskyddad]

Värdet på den minsta samplingen i vektorn.

#### number max [skrivskyddad]

Värdet på den största samplingen i vektorn.

#### number mean [skrivskyddad]

Medelvärdet av alla samplingar i vektorn.

#### number numNew [skrivskyddad]

#### number numShifted [skrivskyddad]

#### number editable [skrivskyddad]

Sant om vektorn kan redigeras av användaren. Det bör kontrolleras innan man försöker ändra en vektor på något sätt.

#### number numNaN [skrivskyddad]

Antal NaN-värden i vektorn.

#### Array array [skrivskyddad]

Vektorn som ett fält.

## Klass: VectorCollection

Ett fält av vektorer.

Ärver: Collection

###

## Klass: VectorView

Representerar en vectorView.

Ärver: DataObject

### Konstruktorer:

- VectorView ( x, y )

### Egenskaper:

- xVector

- yVector

- flagVector

- xMin

- xMax

- yMin

- yMax

- useXMin

- useXMax

- useYMin

- useYMax

- interpolateTo

###

#### VectorView ( Vector x, Vector y )

- Vector x - X-vektorn.

- Vector y - Y-vektorn.

Skapar en ny vektorvy med den givna X-vektorn och Y-vektorn.

#### Vector xVector

x-vektorn.

#### Vector yVector

Y-vektorn

#### Vector flagVector

Flagg-vektorn. Punkter som motsvarar värden skilda från noll i flaggvektorn tas bort från utdatavektorerna.

#### Scalar xMin

Värdet på det minimala x-värdet i vyområdet.

#### Scalar xMax

Värdet på det maximala x-värdet i vyområdet.

#### Scalar yMin

Värdet på det minimala y-värdet i vyområdet.

#### Scalar yMax

Värdet på det maximala y-värdet i vyområdet.

#### boolean useXMin

Om sant respekteras det minimala X-värdet.

#### boolean useXMax

Om sant respekteras det maximala X-värdet.

#### boolean useYMin

Om sant respekteras det minimala Y-värdet.

#### boolean useYMax

Om sant respekteras det maximala Y-värdet.

#### number interpolateTo

Värdet på det maximala y-värdet i vyområdet. Måste vara ett av:

- 0 - interpolera till X-vektorn

- 1 - interpolera till Y-vektorn

- 3 - interpolera till den högupplösande vektorn

- 3 - interpolera till den lågupplösande vektorn

## Klass: ViewObject

Representera ett godtyckligt objekt i ett Kst-fönster. Detta är ett abstrakt objekt och kan inte instantieras direkt.

Ärver: Object

Samlingsklass: ViewObjectCollection

### Metoder:

- resize ( size )

- move ( pos )

- findChild ( pos )

- convertTo ( type )

- raiseToTop ( )

- lowerToBottom ( )

- raise ( )

- lower ( )

- remove ( )

### Egenskaper:

- position

- size

- transparent

- onGrid

- columns

- color

- backgroundColor

- maximized

- minimumSize

- type

- children

###

#### ViewObject resize ( Size size )

- Size size - Objektets nya storlek.

Ändrar objektets storlek till angiven storlek, om möjligt.

#### ViewObject move ( Point pos )

- Point pos - Positionen som objektet ska flyttas till.

Flyttar objektet till en ny position, om möjligt.

#### ViewObject findChild ( Point pos )

- Point pos - Den relativa positionen att söka.

Hittar det översta underliggande objektet till vyn på angiven position. Returnerar null om det inte finns något underliggande objekt där.

#### ViewObject convertTo ( string type )

- string type - Typen som objektet ska försöka konverteras till.

Försöker konvertera detta ViewObject till en annan typ. Objektet måste vara härlett från typen på någon nivå. Null returneras om det inte är möjligt att konvertera till den begärda typen.

#### void raiseToTop ( )

Höjer objektet högst upp i z-ordningen.

#### void lowerToBottom ( )

Sänker objektet längst ner i z-ordningen.

#### void raise ( )

Höjer objektet en position i z-ordningen.

#### void lower ( )

Sänker objektet en position i z-ordningen.

#### void remove ( )

Tar bort objektet.

#### Point position

Objektets plats i förhållande till överliggande objekt.

#### Size size

Objektets storlek i bildpunkter.

#### boolean transparent

Sant om objektet är genomskinligt. Alla objekt stöder inte genomskinlighet.

#### boolean onGrid

Sant om underliggande objekt till det här objektet är på ett rutnät.

#### number columns

Antal kolumner som underliggande objekt är organiserade i. Om värdet ändras, tilldelas onGrid sant.

#### string color

Objektets förgrundsfärg.

#### string backgroundColor

Objektets bakgrundsfärg.

#### boolean maximized

Om sant, maximeras objektet i förhållande till överliggande objekt. Det är ett tillfälligt tillstånd där diagrammet använder allt tillgängligt utrymme i det överliggande objektet, men kan återställas till normal storlek igen.

#### Size minimumSize [skrivskyddad]

Vyobjektets minimala storlek.

#### string type [skrivskyddad]

En sträng som innehåller vyobjektets typ.

#### ViewObjectCollection children [skrivskyddad]

Listan av alla underliggande objekt till detta vyobjekt i Z-ordning från det som är längst bak till det som är överst. Detta är en referens till en samling som kan ändras, men som inte kan tilldelas.

## Klass: ViewObjectCollection

Ett fält av vyobjekt.

Ärver: Collection

###

## Klass: Window

Ett objekt som representerar en referens till ett fönster eller en flik i Kst.

Samlingsklass: WindowCollection

### Konstruktorer:

- Window ( [name] )

### Metoder:

- repaint ( )

- close ( )

### Egenskaper:

- namn

- plots

- view

- columns

###

#### Window ( [string name] )

- string name - Ett namn på det nya fönstret. [valfri]

Skapar ett nytt fönster och objekt som refererar till det.

#### void repaint ( )

Ritar om fönstret.

#### void close ( )

Stänger fönstret.

#### string name

Namnet på fönstret som objektet hör till.

#### PlotCollection plots

Listan med diagram som finns i det här fönstret, utplattad.

#### ViewObject view

Vyobjektet för det här fönstret.

#### number columns

Antal kolumner som underliggande objekt är organiserade i. Om värdet ändras, tilldelas onGrid sant.

## Klass: WindowCollection

Ett fält av Kst-fönster.

Ärver: Collection

###