Appendix A. Referens

Typer av egenskaper och modifierare

På några ställen i den här introduktionen har vi talat om egenskaper hos element i det grafiska användargränssnittet eller annars. I själva verket finns det flera olika typer av egenskaper. Oftast behöver man inte bekymra sig om det, eftersom man kan använda sunt förnuft för att ansluta vilken egenskap som helst till vilken annan egenskap som helst. Dock finns det internt olika typer av egenskaper. När det har betydelse är när vissa särskilda värden hämtas i JS-mallen. I satser som getString ("id")/getBoolean ("id")/getList ("id") kan man också ange vissa så kallade modifierare på följande sätt: getString ("id.modifierare"). En modifierare påverkar på vilket sätt värdet skrivs ut. Läs vidare för listan över egenskaper, och de modifierare som var och en tillhandahåller.

Strängegenskaper

Den enklaste typen av egenskap, som helt enkelt används för att innehålla ett textstycke. Modifierare:

Ingen modifierare ("")

Strängen som den definierades eller tilldelades.

quoted

Strängen i citerad form (lämplig att skicka till R som tecken).

Booleska egenskaper

Egenskaperna kan antingen vara på eller av, sanna eller falska. Exempelvis egenskaper skapade av <convert>-taggar, samt egenskapen som följer en <checkbox> (se nedan). Följande värden returneras enligt angiven modifierare:

Ingen modifierare ("")

Normalt returnerar egenskapen 1 om den är sann, och 0 annars. Det rekommenderade sättet att hämta Booleska värden är att använda getBoolean(). Observera att för getString() returneras strängen "0" när egenskapen är falsk. Strängen kan utvärderas som sann, inte falsk, i JS.

"labeled"

Returnerar strängen "true" när sann, "false" när falsk, eller de egna strängarna som har angivits (typiskt i en <checkbox>).

"true"

Returnerar strängen som om egenskapen var sann, även om den är falsk

"false"

Returnerar strängen som om egenskapen var falsk, även om den är sann

"not"

Returnerar i själva verket en annan Boolesk egenskap, som är det omvända av den nuvarande (dvs. falsk om sann, sann om falsk)

"numeric"

Föråldrad, tillhandahålls för bakåtkompatibilitet. Samma som ingen modifierare "". Returnera "1" om egenskapen är sann, eller "0" om den är falsk.

Heltalsegenskaper

En egenskap konstruerad för att innehålla ett heltalsvärde (men returnerar förstås ändå en sträng med numeriska tecken i JS-mallen). Den accepterar inga modifierare. Används i <spinbox> (se nedan)

Egenskaper för reella tal

En egenskap konstruerad för att innehålla ett reellt numeriskt värde (men returnerar förstås ändå en sträng med numeriska tecken i JS-mallen). Används i <spinbox> (se nedan)

Ingen modifierare ("")

För getValue() / getString() returneras samman som "formatted". I framtida versioner kommer det att vara möjligt att erhålla en numerisk representation istället.

"formatted"

Returnerar det formaterade talet (som en sträng).

RObject-egenskaper

En egenskap konstruerad för urval av ett eller flera R-objekt. Används mest framträdande i varselector och varslot. Följande värden returneras enligt angiven modifierare:

Ingen modifierare ("")

Normalt returnerar egenskapen det valda objektets fullständiga namn. Om mer än ett objekt är valt, skiljs objektnamnen åt av radbrytningar ("\n").

"shortname"

Som ovan, men returnerar bara korta namn på objekten. Exempelvis skulle ett objekt inne i en lista bara ges namnet det har inne i listan, utan listans namn.

"label"

Som ovan, men returnerar objektens RKWard beteckningar (om ingen beteckning är tillgänglig, är det samma sak som "shortname").

Egenskaper för stränglistor

Egenskapen innehåller en lista med strängar.

Ingen modifierare ("")

För getValue()/getString(), returneras alla strängar åtskilda av "\n". Eventuella "\n"-tecken i varje objekt hanteras som litteralen "\\n". Dock är den rekommenderade användningen att hämta värdet med getList() istället, som returnerar ett fält av strängar.

"joined"

Returnerar listan som en enda sträng, med objekten sammanfogade av "\n". I motsats till ingen modifierare (""), ändras inte de individuella strängarna.

Kodegenskaper

En egenskap som hålls av insticksprogram som genererade kod. Den är viktig för inbäddning av insticksprogram, för att kunna inbädda koden som genereras av det inbäddade insticksprogrammet i koden som genereras av det inbäddande (toppnivå) insticksprogrammet. Följande värden returneras enligt angiven modifierare:

Ingen modifierare ("")

Returnerar den fullständiga koden, dvs. sektionerna "preprocess", "calculate", "printout" (men inte "preview") konkatenerade i en sträng.

"preprocess"

Returnerar bara kodens förbehandlingssektion preprocess

"calculate"

Returnerar bara kodens beräkningssektion calculate

"printout"

Returnerar bara kodens utskriftssektion printout

"preview"

Returnerar kodens förhandsgranskningssektion preview