Please enable JavaScript to view this site.

Knowledge Base

Navigation: Scripting Language

Alphabetical list of all script commands

We've made some changes. Use 'Ctrl-F5' to clear your browser cache.
Scroll Prev Top Next More

List of all script commands in alphabetical order. Script commands such as "?" and "+" are at the bottom.

 

A

abs

acos

add2drect

add2dpoly

add2visualizer

addabsorbing

addanalysisgroup

addanalysisprop

addanalysisresult

addattribute

addbandstructuremonitor

addbc (deprecated, see other add boundary conditions command, such as addvoltagebc)

addbulkgen

addchargemesh

addchargemonitor

addchargesolver

addcircle

addcontact (deprecated, see addelectricalcontact)

addconvectionbc

addctmaterialproperty

addcustom

addcustomdoping (deprecated, see addimportdoping)

adddeltachargesource

addelectricalcontact

addemabsorptionmonitor

addemfieldmonitor

addemfieldtimemonitor

addemmaterialproperty

adddevice

adddgtdmesh

adddgtdsolver

adddiffusion

addimplant

adddipole

adddope

addeffectiveindex

addefieldmonitor

addeigenmode (deprecated, see addfde)

addelectricalcontact

addelement

addeme

addemeindex

addemeport

addemeprofile

addfde

addfdtd

addfeemsolver

addfeemmesh

addgaussian

addgridattribute

addgroup

addheatfluxbc

addheatfluxmonitor

addheatmesh

addheatsolver

addhtmaterialproperty

addimport

addimportdope

addimportedsource

addimportgen

addimportheat

addimporttemperature

addindex

addjfluxmonitor

addjob

addlayer

addlayerbuilder

addmaterial

addmaterialproperties

addimportnk

addmesh

addmeshconstraint (deprecated)

addmode

addmodeexpansion

addmodelmaterial

addmodesource

addmovie

addobject

addparameter

addpath

addpec

addperiodic

addplane

addplanarsolid

addpmc

addpml

addpoly

addpower

addport (INTERCONNECT)

addport (FDTD Solutions)

addprofile

addpropagator (deprecated, see addvarfdtd)

addproperty

addpyramid

addradiationbc

addrect

addresource

addring

addsimulationregion

addsphere

addstructuregroup

addsurface

addsurfacerecombinationbc

addsweep

addsweepparameter

addsweepresult

addtemperaturebc

addtemperaturemonitor

addtfsf

addthermalinsulatingbc

addthermalpowerbc

addtime

addtogroup

addtolibrary

addtriangle

adduniformheat

adduserprop

addvarfdtd

addvoltagebc

addwaveguide

all

almostequal

amax

amin

analysis

and

angle

annotateproperty

any

appopen

appclose

appevalscript

appgetvar

arrayperiodicdata

asapexport

asapimport

asapload

asin

assert (deprecated)

atan

atan2

autoarrange

autosaveoff

autosaveon

 

B

bar

besseli

besselj

besselk

bessely

bestoverlap

bestoverlap2

break

 

C

cd

ceil

cell

centroid

chebin

chebpol

chebpol1

checkout

chol

chpts

clear

clearanalysis

cleardataset

cleardcard

clearjobs

clearmodedata

clearlogwindow

clearpath

clearportmodedata

clearsourcedata

cloneportdata

closeall

closesession

colormatch

colormatchfunction

colormatchuv

colormatchxy

comments

conj

connect

constructgeneratormatrix

convertnportsparametersweep

copy

copydcard

copymaterial

copysweep

copytoclipboard

corrcoef

corrtransf

cos

coupling

cov

cp

createbeam

createcompound

createpropertydependency (deprecated)

createsphericalsurface

cross

ctranspose

currentfilename

currentscriptname

customlibrary

cwnorm

czt

 

D

dcht

debug

decompose (deprecated)

del

delete

deleteall

deleteallbc (deprecated, see delete)

deletebc (deprecated, see delete)

deletematerial

deleteresource

deletesweep

designmode

dipolepower

dir

disconnect

dot

 

E

eig

emepropagate

emesweep

encryptscript

endl

erf

erfc

erfcinv

erfinv

eval

evalremote

Escape key

exist

exit

exp

expand

expand2

exportcsvresults

exportfigure

exporthtml

exportimage

exportlib

exportnetlist

exportschematic

exportsweep

extractstructure

eye

 

F

farfield2d

farfield2dintegrate

farfield3d

farfield3dintegrate

farfieldangle

farfieldexact

farfieldexact2d

farfieldexact3d

farfieldfilter

farfieldpolar2d

farfieldpolar3d

farfieldsettings

farfieldspherical

farfieldux

farfielduy

farfieldvector2d

farfieldvector3d

feval

fft

fftk

fftw

filebasename

filedirectory

fileexists

fileexpand

fileextension

fileopendialog

filesavedialog

find

findmodes

findpeaks

findresonances

findproperty

findpropertyvalue

findstring

finite

fitnormpdf

fitpearson4pdf

flip

flipelement

floor

for

format

framerate

frequencysweep

 

G

gdsaddcircle

gdsaddpoly

gdsaddrect

gdsaddref

gdsbegincell

gdsclose

gdsendcell

gdsimport

gdsopen

get

getactivesolver

getanalysis

getasapdata (deprecated)

getattribute

getbc (deprecated, see get)

getcelllist

getcommands

getcompositionfraction (deprecated, see get)

getcontact (deprecated, see get)

getdata

getdgtdindex

geteigensolver

getelectric

getemeanalysis

getemesweep

getfdtdindex

getfdtdsurfaceconductivity

getfield

getglobal (deprecated)

getglobalmonitor

getglobalsource

getindex

getlayerlist

getmagnetic

getmaterial

getmeshcontours

getmodeindex

getmonitorframe

getmonitorwaveform

getname

getnamed

getnamednumber

getnumber

getnumericalpermittivity

getparameter

getpath

getperiodicity

getports

getposition

getrectangle

getremotedata

getresource

getresult

getresultdata

getsetting

getsolver

getsourceangle

getsourcedirection

getsurfaceconductivity

getsweep

getsweepdata

getsweepresult

getvalue

getview

global

grating

gratingangle

gratingbloch1

gratingbloch2

gratingm

gratingn

gratingordercount

gratingorders

gratingperiod1

gratingperiod2

gratingpolar

gratingprojection

gratingu1

gratingu2

gratingvector

groupscope

 

H

h5info

h5read

h5readattr

havedata

haveproperty

haveresult

havesweepdata

havesweepresult

help

hide

hidecategory

hideproperty

histc

histogram

historyoff

historyon

holdoff

holdon

 

I

icht

if

imag

image

implantkurtosis

implantlateralscatter

implantrange

implantskewness

implantstraggle

importbinary

importbinaryobfuscated

importbinary2

importcsvlc

importdataset

importdoping (deprecated, see tecplotread)

importnetlist

importnk

importnkobfuscated

importnk2

importschematic

importsurface

importsurface2

inpoly

insert

insertsweep

installdesignkit

integrate

integrate2

interp

interptet

interptri

inv

invfft

iscell

isfield

ispropertyactive

isstruct

issweep

 

J

 

K

killwizard

 

L

layoutmode

legend

length

library

linecross

lineintersect

linspace

listjobs

load

loadcustom

loaddata

loaddesignkit

loadelement

loadgdsfile

loadsweep

log

log10

logmessage

lognrnd

lookupappend

lookupclose

lookupopen

lookupread

lookupreadnportsparameter

lookupreadtable

lookupreadvalue

lookupwrite

lower

ls

lum2mat (deprecated)

lumapi.close

lumapi.evalScript

lumapi.getVar

lumapi.open

lumapi.putDouble

lumapi.putList

lumapi.putMatrix

lumapi.putString

lumapi.putStruct

 

M

mapfind

materialexists

matlab

matlabget

matlabload

matlabput

matlabsave

matlabsavelegacy

matrix

matrixdataset

max

mcfit

mczfit

mean

mesh

meshgrid3dx

meshgrid3dy

meshgrid3dz

meshgrid4d

meshgridx

meshgridy

message

mie3d

mie3ds12

min

mod

monitors (deprecated)

move

mult

mv

 

N

near2far

new

new2d (deprecated)

new3d (deprecated)

newmode (deprecated, see newproject)

newproject

newwizard

newwizardpage

nonorm

norm

normpdf

now

num2str

nummodes

 

O

ones

opensession

operatingsystem

optimizeposition

or

orbit

overlap

 

P

packagedesignkit

parsebackannotation

parsewaveguidebackannotation

pastefromclipboard

pastesweep

pause

pearson4pdf

permute

pinch

plot

plotxy

polar

polar2

polarimage

polyand

polyarea

polydft

polydiff

polygrow

polyfit

polyintersect

polyor

polyxor

precision

propagate

popportdata

popportframe

portdatasize

probe

prod

protectproperty

pushportdata

pushportframe

putremotedata

pwd

 

Q

quadtri

quadtet

 

R

rand

randmatrix

randn

randnmatrix

randreset

read

readdata

readnportsparameterat

readstltriangles

real

rectilineardataset

redo

redraw

redrawmode

redrawoff

redrawon

refresh

reloaddesignkit

removecostom

removedesignkit

removeexpansion

removeport

removepropertydependency (deprecated)

removesweepparameter

removesweepresult

renameport

replace

replacelibrary

replacestring

reshape

rm

rotateelement

round

run

Run script

runanalysis

runfinalize

runinitialize

runjobs

runoptimization

runparallel

runsetup

runstep

runsweep

runwizard

 

S

save

saveelement

savedata

savedcard

savesweep

scorrcoef

scriptautorun

select

selectall

selectfigure

selectmode

selectpartial

set

setactivesolver

setanalysis

setbc (deprecated, see set)

setcompositionfraction (deprecated, see set)

setconnectionrouting

setcontact (deprecated, see set)

seteigensolver

setemeanalysis

setexpansion

setexpression

setfield

setfir

setglobal (deprecated)

setglobalmonitor

setglobalsource

seticon

setlayer

setmaterial

setname

setnamed

setparallel (deprecated)

setplot

setposition

setpsfoutput

setrectangle

setresource

setresult

setsetting

setsparameter

setsourcesignal

setsweep

setvalue

setview

shiftselect

shiftselectpartial

show

showdata (deprecated)

sign

simulation

simulationdiverged

sin

size

skewness (deprecated)

smithchart

solar

sort

sortmap

sourceintensity

sourceintensity_avg

sourceintensity_pavg

sourcenorm

sourcenorm2_avg

sourcenorm2_pavg

sourcepower

sourcepower_avg

sourcepower_pavg

sources (deprecated)

spline

splitstring

sqrt

sroughness

stackrt

stackfield

stackdipole

stackpurcell

std

stepimport

stlimport

struct

structures (deprecated)

str2num

substring

sum

svd

switchtodesign

switchtolayout

system

 

T

tan

tecplotread

toscript

touchstoneload

transmission

transmission_avg

transmission_pavg

transpose

try

 

U

unfoldsymmetricdata

undo

unique

uniquevertices

unselectall

unstructureddataset

unwrap

updatemodes

updateportmodes

updatesourcemode

upper

 

V

validate

validateall

var

vectorplot

version

versionfile

visualize

vtksave

 

W

waituntildone

which

wizarddata

wizardgetdata

wizardoption

wizardwidget

workspace

write

 

X

 

Y

 

Z

zeros

 

Non alphanumeric script commands

.

+

-

*

/

^

==

!=

>=

<=

>

<

|

?

:

&

!

~

=

[]

%

"

'

#

Copyright Lumerical Inc. | Privacy | Site Map