Egenskaper för element i insticksprogram

Alla layoutelement och alla aktiva element innehåller följande egenskaper, som kan kommas åt via"elementnamnets_id.egenskapens_namn":

visible

Om elementet i det grafiska användargränssnittet är synligt eller inte (Boolean)

enabled

Om elementet i det grafiska användargränssnittet är aktiverat eller inte (Boolean)

required

Om elementet i det grafiska användargränssnittet krävs (innehålla en giltig inställning) eller inte. Observera att alla element som är inaktiverade eller dolda också implicit inte krävs (Boolean).

Förutom det här, har vissa element ytterligare egenskaper som man kan ansluta till. De flesta aktiva element har också en "förvald" egenskap vars värde returneras av anrop till getBoolean, getString, getList("..."), om ingen specifik egenskap, som beskrivs nedan, namnges.

<text>

Förvald egenskap är text

text

Texten som visas (text)

<varselector>

Ingen förvald egenskap

selected

Objekten som för närvarande är markerade. Troligen vill man inte använda det. Används internt (RObject)

root

Rotobjekt eller överliggande objekt för de objekt som erbjuds för urval (RObject)

<varslot>

Förvald egenskap är "available"

available

Alla objekt som finns i denna varslot (RObject)

selected

De objekt av alla i en varslot som för närvarande är markerade. Troligen vill man inte använda det. Används internt (RObject)

source

En kopia av objekten som är markerade i motsvarande varselector. Troligen vill man inte använda det. Används internt (RObject)

<valueselector>

Förvald egenskap är "selected"

selected

Strängarna som för närvarande är markerade. Modifierare "labeled" för att hämta motsvarande beteckningar. I en <valueselector> vill man troligtvis inte använda det direkt (bara i en <select>) (läs och skriv, stränglista).

available

Listan med strängvärden att välja mellan (läs/skriv StringList)

labels

Beteckningar att visa för strängvärdena (läs/skriv StringList)

<valueslot>

Samma som <varslot>, men egenskaperna är stränglistor istället för RObjects.

<radio>

Förvald egenskap är "string"

string

Värdet på alternativet som för närvarande är valt (sträng)

number

Nummer för alternativet som för närvarande är markerat (alternativ numreras uppifrån och ner med början på 0) (heltal)

<dropdown>

Samma som <radio>

<select>

Samma som <valueselector>

<option>

Ingen förvald egenskap. Den enda egenskapen är "enabled", och den är för närvarande inte tillgänglig för alternativ inne i <select> eller <valueselector>. Egenskaperna "visible" eller "required" finns inte för <option>.

enabled

Om det här enskilda alternativet ska aktiveras eller inaktiveras. I de flesta fall aktiverar eller inaktiverar man alla alternativknapparna, <radio<, eller kombinationsrutan, <dropdown<, istället. Men det kan användas för att dynamiskt ställa in aktiveringstillståndet för ett enskilt alternativ inne i en <radio< eller <dropdown< (Boolean).

<checkbox>

Förvald egenskap är "state.labeled", vilket betyder att värdena angivna av egenskaperna value och value_unchecked returneras, inte kryssrutans visade beteckning.

state

Kryssrutans tillstånd (på eller av). Observera att användbara modifierare av egenskapen (som för alla Booleska egenskaper) är "not" och "numeric" (se egenskapers typer). Dock är det ofta mest användbart att ansluta till egenskapen utan modifierare, dvs. "checkbox_id.state", vilket returnerar kryssrutans tillstånd på ett format användbart för användning i en villkorssats (0 eller 1) (Boolean).

<frame>

Förvald egenskap är "checked", om och endast om ramen är markeringsbar. För ramar som inte är markeringsbara finns ingen förvald egenskap.

checked

Bara tillgänglig för markeringsbara ramar: kryssrutans tillstånd (på eller av). Observera att användbara modifierare av egenskapen (som för alla Booleska egenskaper) är "not" och "numeric" (se egenskapers typer) (Boolean).

<input>

Förvald egenskap är "text"

text

Aktuell text i inmatningsfältet (sträng)

<matrix>

Förvald egenskap är "cbind".

rows

Antal rader i matrisen (heltal). Om matrisen tillåter användaren att lägga till och ta bort rader, ska egenskapen behandlas som skrivskyddad. Annars ändras matrisens storlek om den ändras.

columns

Antal kolumner i matrisen (heltal). Om matrisen tillåter användaren att lägga till och ta bort kolumner, ska egenskapen behandlas som skrivskyddad. Annars ändras matrisens storlek om den ändras.

tsv

Data i matrisen på tsv-format (sträng, läs-skriv). Observera att jämfört med den vanliga tsv-layouten, är kolumner, inte rader, åtskilda med nyradstecken, och celler inom en kolumn är åtskilda av tabulatortecken.

0,1,2...

Data från en enskild kolumn (0 för vänstra kolumnen). getValue() eller getString() returnerar den som en enda sträng, åtskild av "\n". Dock är det rekommenderade sättet att hämta den att använda getList(), som returnerar kolumnen som ett strängfält.

row.0,row.1,row.2...

Data från en enskild rad (0 för översta raden). getValue() eller getString() returnerar den som en enda sträng, åtskild av "\n". Dock är det rekommenderade sättet att hämta den att använda getList(), som returnerar raden som ett strängfält.

cbind

Data på ett format lämpligt för att klistra in i R, omgivet av en cbind-sats (sträng, skrivskyddad).

<optionset>

Ingen förvald egenskap.

row_count

Antal objekt i optionset (heltal). Skrivskyddad.

current_row

Objekt som för närvarande är aktivt i ett optionset (heltal). -1 för inget aktivt objekt. Läs- och skrivbar.

optioncolumn_ids

För varje <optioncolumn> som definieras, skapas en "string list"-egenskap med angivet id.

<browser>

Förvald egenskap är "selection"

selection

Aktuell text (markerat filnamn) i bläddraren (sträng)

<saveobject>

Förvald egenskap är "selection"

selection

Det markerade objektets fullständiga namn (sträng, skrivskyddad: för att tilldela det programmatiskt, använd "parent" och "objectname").

parent

Det markerade objektets överliggande objekt. Det är alltid ett befintligt R-objekt av en typ som kan innehålla andra objekt (t.ex. en lista eller data.frame). När det är satt till en tom sträng eller ett ogiltigt objekt, antas ".GlobalEnv" (RObject)

objectname

Det markerade objektets grundnamn, dvs. strängen som matas in av användaren (ändrat till ett giltigt R-namn, vid behov) (sträng)

active

Endast för markeringsbara saveobjekts: Om objektet är markerad eller aktiverat. Alltid sant för ej markeringsbara saveobjects (Boolean)

<spinbox>

Förvald egenskap är antingen "int" eller "real.formatted" beroende på nummerrutans läge

int

Heltalsvärde som nummerrutan innehåller, eller närmaste heltal för reellt läge (heltal)

real

Reellt värde som nummerrutan innehåller (och heltal, om i heltalsläge) (reell)

<formula>

Förvald egenskap är "model"

model

Den aktuella modellsträngen (sträng)

table

Den data.frame som innehåller nödvändiga variabler. Om bara variabler från en data.frame används, returneras namnet på denna data.frame. Annars konstrueras en ny data.frame efter behov (sträng)

labels

Om variabler från flera data.frames är inblandade, kan deras namn bli omvandlade (exempelvis om båda data.frames innehåller en variabel som heter "x"). Returnerar en lista med de omvandlade namnen som index och den beskrivande beteckningen som värde (sträng)

fixed_factors

De förbestämda faktorerna. Troligen vill man inte använda det. Används internt (RObject)

dependent

Den eller de beroende variablerna. Troligen vill man inte använda det. Används internt (RObject)

<embed>

Ingen förvald egenskap

code

Koden som skapas av det inbäddade insticksprogrammet (code)

<preview>

Förvald egenskap är "state"

state

Om förhandsgranskningsrutan är markerad (inte nödvändigtvis om förhandsgranskningen redan har visats) (Boolean)

<convert>

Elementet (som används i sektionen <logic>) är speciell på det sättet att den tekniskt sett är en egenskap, istället för att bara innehålla en eller flera egenskaper. Den är av typen Boolean. Observera att användbara modifierare av egenskapen (som för alla Booleska egenskaper) är "not" och "numeric" (se egenskapers typer).

<switch>

Elementet (som används i sektionen <logic>) är speciell på det sättet att den tekniskt sett är en (sträng-) egenskap, istället för att bara innehålla en eller flera egenskaper. Den gör det möjligt att byta mellan olika målegenskaper beroende på värdet av en villkorsegenskap, eller för att ändra avbildning av villkorsegenskapens värden. Alla modifierare som anges skickas till målegenskaperna. Sålunda kan t.ex. modifieraren "shortname" också användas i omkopplaren, om alla målegenskaper är RObject-egenskaper. Om målegenskaperna har olika typer kan dock användning av modifierare orsaka fel. För förbestämda värden, fixed_value, bortses tyst från eventuella modifierare. Observera att målegenskaper, vid åtkomst via en omkopplare, alltid är skrivskyddade.