HelpTableTemplate

A template that customizes generated help tables.

see: createHelpTable

Hierarchy

HelpTableTemplate

Index

Properties

Optional abbreviationOverrides

abbreviationOverrides: object

If set, the value of any property names matching the API name of a command will be substituted for that command's default abbreviation.

see: View.abbreviationMap

Type declaration

FourierTransform:
Lagrange1stDerivative:
Lagrange2ndDerivative:
Lagrange3rdDerivative:
LaplaceTransform:
LaplacianOperator:
Leibniz1stDerivative:
Leibniz2ndDerivative:
LeibnizNthDerivative:
Newton1stDerivative:
Newton2ndDerivative:
PlanckConstant:
absoluteValue:
actinium:
alephNumber:
aluminium:
americium:
angle:
angleBrackets:
antimony:
antimuon:
antineutrino:
antineutron:
antiproton:
antitauon:
approximatelyEqualTo:
aqueousState:
arcFromPoints:
arccosecant:
arccosine:
arccotangent:
arcminutes:
arcsecant:
arcseconds:
arcsine:
arctangent:
areaHyperbolicCosecant:
areaHyperbolicCosine:
areaHyperbolicCotangent:
areaHyperbolicSecant:
areaHyperbolicSine:
areaHyperbolicTangent:
argon:
argumentOf:
arsenic:
astatine:
asymptoticallyEqualTo:
backwardDelete:
backwardEnter:
barium:
because:
berkelium:
beryllium:
bethNumber:
big:
big_O:
big_Omega:
big_Theta:
binaryLogarithm:
binomialCoefficient:
bismuth:
black:
blue:
bohrium:
booleanFalse:
booleanTrue:
boron:
braceOver:
braceUnder:
brackets:
bromine:
brown:
cadmium:
cagedAtom:
calcium:
calculate:
calculateOnNewLine:
californium:
carbon:
ceiling:
cerium:
cesium:
changeAccentToAcute:
changeAccentToBar:
changeAccentToBreve:
changeAccentToCheck:
changeAccentToDot:
changeAccentToDots:
changeAccentToGrave:
changeAccentToHat:
changeAccentToTilde:
changeIn:
changeToElement:
changeToIsotope:
changeTypeToMatrix:
changeTypeToPoint:
changeTypeToScalar:
changeTypeToSet:
changeTypeToString:
changeTypeToTensor:
changeTypeToVector:
chlorine:
chromium:
circle:
closedInterval:
cobalt:
combinations:
combinationsWithRepetitions:
complexConjugate:
complexNumbers:
compositeFunction:
conditionalProbability:
congruentModulo:
congruentTo:
conjunction:
contains:
contourIntegral:
contradiction:
convolution:
coordinatePlane:
copernicium:
copper:
coproduct:
copy:
copyToCell1:
copyToCell10:
copyToCell2:
copyToCell3:
copyToCell4:
copyToCell5:
copyToCell6:
copyToCell7:
copyToCell8:
copyToCell9:
correspondsTo:
cosecant:
cosine:
cotangent:
crystallineState:
cubeRoot:
curium:
cut:
darkGrey:
darmstadtium:
dataTable:
decimalLogarithm:
definedToBeEqualTo:
degrees:
degreesCelsius:
degreesFahrenheit:
delOperator:
deleteSelection:
determinant:
determinantMatrix:
deuterium:
diagonalEllipsis:
directProduct:
directSum:
disjunction:
distanceFunction:
divergenceOf:
dividedBy:
divides:
doesNotContain:
doesNotDivide:
doesNotPrecede:
doesNotPrecedeOrEqual:
doesNotSucceed:
doesNotSucceedOrEqual:
doesNotYield:
dollars:
doubleIntegral:
dubnium:
duplicateLine:
dysprosium:
einsteinium:
electron:
elementOf:
ellipsis:
emptySet:
endOfProof:
entails:
equalTo:
equationAddition:
equationSteps:
equilibrium:
equivalentTo:
erbium:
europium:
euros:
evaluateFunction:
exclusiveDisjunction:
expandAbbreviation:
factorial:
fallingFactorial:
fermium:
fillInTheBlankBox:
flerovium:
floor:
fluorine:
forAll:
forwardDelete:
forwardEnter:
fraction:
fractionalPartOf:
francium:
function:
gadolinium:
gallium:
gasProduced:
gaseousState:
genericOperator:
genericOperator2:
germanium:
gold:
gradientOf:
greaterThan:
greaterThanOrApproximately:
greaterThanOrEqualTo:
greatestCommonDivisor:
green:
grey:
grid:
hafnium:
hassium:
helium:
hermitianConjugate:
holmium:
hydrogen:
hyperbolicCosecant:
hyperbolicCosine:
hyperbolicCotangent:
hyperbolicSecant:
hyperbolicSine:
hyperbolicTangent:
identicalTo:
identifier:
imaginaryPart:
imaginaryUnit:
implies:
impossibleOp:
indigo:
indium:
infinity:
integerNumbers:
integerPartOf:
integral:
intersection:
inverse:
iodine:
iridium:
iron:
isAssigned:
joinLines:
krypton:
lambdaAbstraction:
lanthanum:
lawrencium:
lead:
leastCommonMultiple:
leaveBraces:
leaveBrackets:
leaveParentheses:
leftHalfOpenInterval:
lessThan:
lessThanOrApproximately:
lessThanOrEqualTo:
lightGrey:
lime:
limit:
lineFromPoints:
lineJoiningBackwardDelete:
lineJoiningForwardDelete:
lineSegmentFromPoints:
liquidState:
lithium:
livermorium:
logarithm:
lutetium:
magnesium:
manganese:
mapsTo:
matrix:
matrixElement:
maximumOf:
measureFunction:
measuredAngle:
meitnerium:
mendelevium:
mercury:
minimumOf:
minus:
minusOrPlus:
molybdenum:
moscovium:
moveDown:
moveLeft:
moveLeftFast:
moveLeftInField:
moveLineDown:
moveLineUp:
moveRight:
moveRightFast:
moveRightInField:
moveToDocumentEnd:
moveToDocumentStart:
moveToFieldEnd:
moveToFieldStart:
moveToLineEnd:
moveToLineStart:
moveUp:
muchGreaterThan:
muchLessThan:
muon:
muonAntineutrino:
muonNeutrino:
naryConjunction:
naryDisjunction:
naryIntersection:
naryUnion:
naturalFraction:
naturalLogarithm:
naturalLogarithmBase:
naturalNumbers:
necessarily:
negation:
neodymium:
neon:
neptunium:
neutrino:
neutron:
nickel:
nihonium:
niobium:
nitrogen:
noOp:
nobelium:
noncapturingSubstitution:
normalSubgroup:
normalSubgroupOrEqual:
notANormalSubgroup:
notAStrictSubset:
notAStrictSuperset:
notASubset:
notASuperset:
notAnElementOf:
notAsymptoticallyEqualTo:
notCongruentModulo:
notEqualTo:
notGreaterThan:
notGreaterThanOrEqualTo:
notIdenticalTo:
notLessThan:
notLessThanOrEqualTo:
notParallelTo:
numberLine:
oganesson:
openInterval:
orange:
osmium:
oxygen:
palladium:
parallelTo:
parentheses:
partial1stDerivative:
partial2ndDerivative:
partial2ndDerivativeCross:
partialNthDerivative:
paste:
pasteFromCell1:
pasteFromCell10:
pasteFromCell2:
pasteFromCell3:
pasteFromCell4:
pasteFromCell5:
pasteFromCell6:
pasteFromCell7:
pasteFromCell8:
pasteFromCell9:
percent:
permutations:
permutationsWithRepetitions:
perpendicularTo:
phosphorus:
pi:
piecewiseFunction:
pink:
platinum:
plus:
plusOrMinus:
plutonium:
polonium:
positron:
possibly:
potassium:
poundsSterling:
powerSet:
praseodymium:
precedes:
precedesOrEqualTo:
precipitateProduced:
primeNumbers:
print:
probability:
product:
promethium:
proportionalTo:
protactinium:
proton:
provable:
pullInFromLeft:
pullInFromRight:
purple:
pushOutToLeft:
pushOutToRight:
questionedEqualTo:
radium:
radon:
randomNumber:
rank:
ratio:
rationalNumbers:
rayFromPoints:
realNumbers:
realPart:
red:
redo:
reduced_PlanckConstant:
relationalJoin:
relationalProjection:
relationalRenaming:
relationalSelection:
remainderAfterDivision:
removeAccent:
rhenium:
rhodium:
rightHalfOpenInterval:
risingFactorial:
roentgenium:
root:
rotationOf:
round:
rubidium:
ruthenium:
rutherfordium:
samarium:
scandium:
seaborgium:
secant:
selectLeft:
selectLeftFast:
selectLess:
selectLine:
selectMore:
selectNumber:
selectRight:
selectRightFast:
selectToFieldEnd:
selectToFieldStart:
selenium:
semidirectProduct:
separator:
setBuilder:
setDifference:
setLiteral:
showAbbreviationCompletions:
signum:
silicon:
silver:
similarTo:
sine:
slashDivides:
small:
smallO:
smallOmega:
sodium:
solidState:
sphericalAngle:
splitLine:
splitText:
spoilerBox:
square:
squareRoot:
strictSubset:
strictSuperset:
stringLiteral:
strontium:
subscriptIndex:
subset:
succeeds:
succeedsOrEqualTo:
sulfur:
summation:
superset:
symmetricDifference:
takeReciprocal:
tangent:
tantalum:
tauAntineutrino:
tauNeutrino:
tauon:
tautology:
teal:
technetium:
tellurium:
tendsTo:
tennessine:
terbium:
text:
textAnnotation:
thallium:
thereExists:
thereExistsOne:
therefore:
thorium:
thoron:
thulium:
timesCross:
timesDot:
tin:
titanium:
toThePower:
trace:
transpose:
triangle:
tripleIntegral:
tritium:
tungsten:
undo:
union:
unit:
universalSet:
ununennium:
unwrap:
unwrapAndSelect:
uranium:
vanadium:
verticalEllipsis:
waveOperator:
white:
wreathProduct:
xenon:
yellow:
yields:
yieldsBothDirections:
yieldsNetBackward:
yieldsWithCatalyst:
yieldsWithHeat:
yieldsWithLight:
ytterbium:
yttrium:
zeroVector:
zinc:
zirconium:

Optional exclude

exclude: string[]

Any sections or commands whose API name is an element of this array will be excluded from the resulting table.

Optional gestureOverrides

gestureOverrides: object

If set, the value of any property names matching the API name of a command will be substituted for that command's default gesture.

see: View.gestureMap

Type declaration

FourierTransform:
Lagrange1stDerivative:
Lagrange2ndDerivative:
Lagrange3rdDerivative:
LaplaceTransform:
LaplacianOperator:
Leibniz1stDerivative:
Leibniz2ndDerivative:
LeibnizNthDerivative:
Newton1stDerivative:
Newton2ndDerivative:
PlanckConstant:
absoluteValue:
actinium:
alephNumber:
aluminium:
americium:
angle:
angleBrackets:
antimony:
antimuon:
antineutrino:
antineutron:
antiproton:
antitauon:
approximatelyEqualTo:
aqueousState:
arcFromPoints:
arccosecant:
arccosine:
arccotangent:
arcminutes:
arcsecant:
arcseconds:
arcsine:
arctangent:
areaHyperbolicCosecant:
areaHyperbolicCosine:
areaHyperbolicCotangent:
areaHyperbolicSecant:
areaHyperbolicSine:
areaHyperbolicTangent:
argon:
argumentOf:
arsenic:
astatine:
asymptoticallyEqualTo:
backwardDelete:
backwardEnter:
barium:
because:
berkelium:
beryllium:
bethNumber:
big:
big_O:
big_Omega:
big_Theta:
binaryLogarithm:
binomialCoefficient:
bismuth:
black:
blue:
bohrium:
booleanFalse:
booleanTrue:
boron:
braceOver:
braceUnder:
brackets:
bromine:
brown:
cadmium:
cagedAtom:
calcium:
calculate:
calculateOnNewLine:
californium:
carbon:
ceiling:
cerium:
cesium:
changeAccentToAcute:
changeAccentToBar:
changeAccentToBreve:
changeAccentToCheck:
changeAccentToDot:
changeAccentToDots:
changeAccentToGrave:
changeAccentToHat:
changeAccentToTilde:
changeIn:
changeToElement:
changeToIsotope:
changeTypeToMatrix:
changeTypeToPoint:
changeTypeToScalar:
changeTypeToSet:
changeTypeToString:
changeTypeToTensor:
changeTypeToVector:
chlorine:
chromium:
circle:
closedInterval:
cobalt:
combinations:
combinationsWithRepetitions:
complexConjugate:
complexNumbers:
compositeFunction:
conditionalProbability:
congruentModulo:
congruentTo:
conjunction:
contains:
contourIntegral:
contradiction:
convolution:
coordinatePlane:
copernicium:
copper:
coproduct:
copy:
copyToCell1:
copyToCell10:
copyToCell2:
copyToCell3:
copyToCell4:
copyToCell5:
copyToCell6:
copyToCell7:
copyToCell8:
copyToCell9:
correspondsTo:
cosecant:
cosine:
cotangent:
crystallineState:
cubeRoot:
curium:
cut:
darkGrey:
darmstadtium:
dataTable:
decimalLogarithm:
definedToBeEqualTo:
degrees:
degreesCelsius:
degreesFahrenheit:
delOperator:
deleteSelection:
determinant:
determinantMatrix:
deuterium:
diagonalEllipsis:
directProduct:
directSum:
disjunction:
distanceFunction:
divergenceOf:
dividedBy:
divides:
doesNotContain:
doesNotDivide:
doesNotPrecede:
doesNotPrecedeOrEqual:
doesNotSucceed:
doesNotSucceedOrEqual:
doesNotYield:
dollars:
doubleIntegral:
dubnium:
duplicateLine:
dysprosium:
einsteinium:
electron:
elementOf:
ellipsis:
emptySet:
endOfProof:
entails:
equalTo:
equationAddition:
equationSteps:
equilibrium:
equivalentTo:
erbium:
europium:
euros:
evaluateFunction:
exclusiveDisjunction:
expandAbbreviation:
factorial:
fallingFactorial:
fermium:
fillInTheBlankBox:
flerovium:
floor:
fluorine:
forAll:
forwardDelete:
forwardEnter:
fraction:
fractionalPartOf:
francium:
function:
gadolinium:
gallium:
gasProduced:
gaseousState:
genericOperator:
genericOperator2:
germanium:
gold:
gradientOf:
greaterThan:
greaterThanOrApproximately:
greaterThanOrEqualTo:
greatestCommonDivisor:
green:
grey:
grid:
hafnium:
hassium:
helium:
hermitianConjugate:
holmium:
hydrogen:
hyperbolicCosecant:
hyperbolicCosine:
hyperbolicCotangent:
hyperbolicSecant:
hyperbolicSine:
hyperbolicTangent:
identicalTo:
identifier:
imaginaryPart:
imaginaryUnit:
implies:
impossibleOp:
indigo:
indium:
infinity:
integerNumbers:
integerPartOf:
integral:
intersection:
inverse:
iodine:
iridium:
iron:
isAssigned:
joinLines:
krypton:
lambdaAbstraction:
lanthanum:
lawrencium:
lead:
leastCommonMultiple:
leaveBraces:
leaveBrackets:
leaveParentheses:
leftHalfOpenInterval:
lessThan:
lessThanOrApproximately:
lessThanOrEqualTo:
lightGrey:
lime:
limit:
lineFromPoints:
lineJoiningBackwardDelete:
lineJoiningForwardDelete:
lineSegmentFromPoints:
liquidState:
lithium:
livermorium:
logarithm:
lutetium:
magnesium:
manganese:
mapsTo:
matrix:
matrixElement:
maximumOf:
measureFunction:
measuredAngle:
meitnerium:
mendelevium:
mercury:
minimumOf:
minus:
minusOrPlus:
molybdenum:
moscovium:
moveDown:
moveLeft:
moveLeftFast:
moveLeftInField:
moveLineDown:
moveLineUp:
moveRight:
moveRightFast:
moveRightInField:
moveToDocumentEnd:
moveToDocumentStart:
moveToFieldEnd:
moveToFieldStart:
moveToLineEnd:
moveToLineStart:
moveUp:
muchGreaterThan:
muchLessThan:
muon:
muonAntineutrino:
muonNeutrino:
naryConjunction:
naryDisjunction:
naryIntersection:
naryUnion:
naturalFraction:
naturalLogarithm:
naturalLogarithmBase:
naturalNumbers:
necessarily:
negation:
neodymium:
neon:
neptunium:
neutrino:
neutron:
nickel:
nihonium:
niobium:
nitrogen:
noOp:
nobelium:
noncapturingSubstitution:
normalSubgroup:
normalSubgroupOrEqual:
notANormalSubgroup:
notAStrictSubset:
notAStrictSuperset:
notASubset:
notASuperset:
notAnElementOf:
notAsymptoticallyEqualTo:
notCongruentModulo:
notEqualTo:
notGreaterThan:
notGreaterThanOrEqualTo:
notIdenticalTo:
notLessThan:
notLessThanOrEqualTo:
notParallelTo:
numberLine:
oganesson:
openInterval:
orange:
osmium:
oxygen:
palladium:
parallelTo:
parentheses:
partial1stDerivative:
partial2ndDerivative:
partial2ndDerivativeCross:
partialNthDerivative:
paste:
pasteFromCell1:
pasteFromCell10:
pasteFromCell2:
pasteFromCell3:
pasteFromCell4:
pasteFromCell5:
pasteFromCell6:
pasteFromCell7:
pasteFromCell8:
pasteFromCell9:
percent:
permutations:
permutationsWithRepetitions:
perpendicularTo:
phosphorus:
pi:
piecewiseFunction:
pink:
platinum:
plus:
plusOrMinus:
plutonium:
polonium:
positron:
possibly:
potassium:
poundsSterling:
powerSet:
praseodymium:
precedes:
precedesOrEqualTo:
precipitateProduced:
primeNumbers:
print:
probability:
product:
promethium:
proportionalTo:
protactinium:
proton:
provable:
pullInFromLeft:
pullInFromRight:
purple:
pushOutToLeft:
pushOutToRight:
questionedEqualTo:
radium:
radon:
randomNumber:
rank:
ratio:
rationalNumbers:
rayFromPoints:
realNumbers:
realPart:
red:
redo:
reduced_PlanckConstant:
relationalJoin:
relationalProjection:
relationalRenaming:
relationalSelection:
remainderAfterDivision:
removeAccent:
rhenium:
rhodium:
rightHalfOpenInterval:
risingFactorial:
roentgenium:
root:
rotationOf:
round:
rubidium:
ruthenium:
rutherfordium:
samarium:
scandium:
seaborgium:
secant:
selectLeft:
selectLeftFast:
selectLess:
selectLine:
selectMore:
selectNumber:
selectRight:
selectRightFast:
selectToFieldEnd:
selectToFieldStart:
selenium:
semidirectProduct:
separator:
setBuilder:
setDifference:
setLiteral:
showAbbreviationCompletions:
signum:
silicon:
silver:
similarTo:
sine:
slashDivides:
small:
smallO:
smallOmega:
sodium:
solidState:
sphericalAngle:
splitLine:
splitText:
spoilerBox:
square:
squareRoot:
strictSubset:
strictSuperset:
stringLiteral:
strontium:
subscriptIndex:
subset:
succeeds:
succeedsOrEqualTo:
sulfur:
summation:
superset:
symmetricDifference:
takeReciprocal:
tangent:
tantalum:
tauAntineutrino:
tauNeutrino:
tauon:
tautology:
teal:
technetium:
tellurium:
tendsTo:
tennessine:
terbium:
text:
textAnnotation:
thallium:
thereExists:
thereExistsOne:
therefore:
thorium:
thoron:
thulium:
timesCross:
timesDot:
tin:
titanium:
toThePower:
trace:
transpose:
triangle:
tripleIntegral:
tritium:
tungsten:
undo:
union:
unit:
universalSet:
ununennium:
unwrap:
unwrapAndSelect:
uranium:
vanadium:
verticalEllipsis:
waveOperator:
white:
wreathProduct:
xenon:
yellow:
yields:
yieldsBothDirections:
yieldsNetBackward:
yieldsWithCatalyst:
yieldsWithHeat:
yieldsWithLight:
ytterbium:
yttrium:
zeroVector:
zinc:
zirconium:

Optional idPrefix

idPrefix: string

If set, then each command's section of the table will have an ID that consists of this prefix concatenated with the command's API name. Setting this will allow linking to individual sections and commands in the resulting table. For example, if this is set to the empty string "", then linking to the fragment identifier #squareRoot would take the reader to the square root command. If null, then no IDs are generated. The default is null.

Optional platform

platform: "chromeos" | "linux" | "mac" | "win"

If set, help content is generated for the specified platform. The default is to target the platform that the app is running on.

Optional searchable

searchable: boolean

If true, then header will include a search field that can be used to search the table content by hiding rows that do not match the search term. The default is true. This option has no effect if showHeader is false.

Optional sections

sections: HelpTableSectionTemplate[]

An array of custom sections to be inserted into the table.

Optional showApiNames

showApiNames: boolean

If true, each command listed in the help table will include the string used to apply that command in API calls.

see: Editor.apply
see: EditorCommand

Optional showHeader

showHeader: boolean

If true, the table includes a header describing each column. The default is true.

Hierarchy

Index

Properties

Properties

Optional abbreviationOverrides

Type declaration

FourierTransform:

Lagrange1stDerivative:

Lagrange2ndDerivative:

Lagrange3rdDerivative:

LaplaceTransform:

LaplacianOperator:

Leibniz1stDerivative:

Leibniz2ndDerivative:

LeibnizNthDerivative:

Newton1stDerivative:

Newton2ndDerivative:

PlanckConstant:

absoluteValue:

actinium:

alephNumber:

aluminium:

americium:

angle:

angleBrackets:

antimony:

antimuon:

antineutrino:

antineutron:

antiproton:

antitauon:

approximatelyEqualTo:

aqueousState:

arcFromPoints:

arccosecant:

arccosine:

arccotangent:

arcminutes:

arcsecant:

arcseconds:

arcsine:

arctangent:

areaHyperbolicCosecant:

areaHyperbolicCosine:

areaHyperbolicCotangent:

areaHyperbolicSecant:

areaHyperbolicSine:

areaHyperbolicTangent:

argon:

argumentOf:

arsenic:

astatine:

asymptoticallyEqualTo:

backwardDelete:

backwardEnter:

barium:

because:

berkelium:

beryllium:

bethNumber:

big:

big_O:

big_Omega:

big_Theta:

binaryLogarithm:

binomialCoefficient:

bismuth:

black:

blue:

bohrium:

booleanFalse:

booleanTrue:

boron:

braceOver:

braceUnder:

brackets:

bromine:

brown:

cadmium:

cagedAtom: