gardener, Interface administrators, Administrators
1,546
edits
Changes
new
<cd:commandgroup name="setuplayer" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setuplayer</tt> is used to set th eoptions for a layer.
</cd:shortdesc>
<cd:variants>
<cd:command category="background" file="pack-lyr.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-layer.xml" level="style" name="setuplayer" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc>Name of the layer</cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="state">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="start"></cd:constant>
<cd:constant type="stop"></cd:constant>
<cd:constant type="continue"></cd:constant>
<cd:constant type="next"></cd:constant>
<cd:constant type="repeat"></cd:constant>
</cd:parameter>
<cd:parameter name="option">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="test"></cd:constant>
</cd:parameter>
<cd:parameter name="page">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="width">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="region">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="rotation">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="inner"></cd:constant>
<cd:constant type="outer"></cd:constant>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="position">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="overlay"></cd:constant>
</cd:parameter>
<cd:parameter name="hoffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="max"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="voffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="max"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="offset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="dx">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="dy">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="sx">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="sy">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="x">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="y">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="corner">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="left"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant default="yes" type="top"></cd:constant>
<cd:constant type="bottom"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="grid"></cd:constant>
<cd:constant type="left"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="top"></cd:constant>
<cd:constant type="bottom"></cd:constant>
<cd:constant type="line"></cd:constant>
<cd:constant type="l"></cd:constant>
<cd:constant type="c"></cd:constant>
<cd:constant type="r"></cd:constant>
<cd:constant type="m"></cd:constant>
<cd:constant type="t"></cd:constant>
<cd:constant type="b"></cd:constant>
<cd:constant type="g"></cd:constant>
</cd:parameter>
<cd:parameter name="line">
<cd:paramdoc>placement of elements in a virtual column grid (see {{cmd|setuplayout}}</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="column">
<cd:paramdoc>placement of elements in a virtual column grid (see {{cmd|setuplayout}}</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="direction">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="normal"></cd:constant>
<cd:constant type="reverse"></cd:constant>
</cd:parameter>
<cd:parameter name="doublesided">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="method">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant default="yes" type="overlay"></cd:constant>
</cd:parameter>
<cd:parameter name="repeat">
<cd:paramdoc>repeat on all pages?</cd:paramdoc>
<cd:constant type="yes"></cd:constant>
</cd:parameter>
<cd:parameter name="preset">
<cd:paramdoc>placement preset</cd:paramdoc>
<cd:constant type="lefttop"></cd:constant>
<cd:constant type="righttop"></cd:constant>
<cd:constant type="leftbottom"></cd:constant>
<cd:constant type="rightbottom"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="middletop"></cd:constant>
<cd:constant type="middlebottom"></cd:constant>
<cd:constant type="middleleft"></cd:constant>
<cd:constant type="middleright"></cd:constant>
<cd:constant type="lefttopleft"></cd:constant>
<cd:constant type="lefttopright"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definelayer" originator="system"></cd:commandref>
<cd:source file="pack-lyr.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Background"></cd:wikipage>
<cd:wikipage page="Layers"></cd:wikipage>
<cd:commandref name="setlayer"></cd:commandref>
<cd:commandref name="definelayer"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setuplayer</tt> is used to set th eoptions for a layer.
</cd:shortdesc>
<cd:variants>
<cd:command category="background" file="pack-lyr.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-layer.xml" level="style" name="setuplayer" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc>Name of the layer</cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="state">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="start"></cd:constant>
<cd:constant type="stop"></cd:constant>
<cd:constant type="continue"></cd:constant>
<cd:constant type="next"></cd:constant>
<cd:constant type="repeat"></cd:constant>
</cd:parameter>
<cd:parameter name="option">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="test"></cd:constant>
</cd:parameter>
<cd:parameter name="page">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="width">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="region">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="rotation">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="left"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="inner"></cd:constant>
<cd:constant type="outer"></cd:constant>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="position">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="overlay"></cd:constant>
</cd:parameter>
<cd:parameter name="hoffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="max"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="voffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="max"></cd:constant>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="offset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="dx">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="dy">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="sx">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="sy">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="x">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="y">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="corner">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="left"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant default="yes" type="top"></cd:constant>
<cd:constant type="bottom"></cd:constant>
</cd:parameter>
<cd:parameter name="location">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="grid"></cd:constant>
<cd:constant type="left"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="right"></cd:constant>
<cd:constant type="top"></cd:constant>
<cd:constant type="bottom"></cd:constant>
<cd:constant type="line"></cd:constant>
<cd:constant type="l"></cd:constant>
<cd:constant type="c"></cd:constant>
<cd:constant type="r"></cd:constant>
<cd:constant type="m"></cd:constant>
<cd:constant type="t"></cd:constant>
<cd:constant type="b"></cd:constant>
<cd:constant type="g"></cd:constant>
</cd:parameter>
<cd:parameter name="line">
<cd:paramdoc>placement of elements in a virtual column grid (see {{cmd|setuplayout}}</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="column">
<cd:paramdoc>placement of elements in a virtual column grid (see {{cmd|setuplayout}}</cd:paramdoc>
<cd:constant type="cd:number"></cd:constant>
</cd:parameter>
<cd:parameter name="direction">
<cd:paramdoc></cd:paramdoc>
<cd:constant default="yes" type="normal"></cd:constant>
<cd:constant type="reverse"></cd:constant>
</cd:parameter>
<cd:parameter name="doublesided">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="method">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="fit"></cd:constant>
<cd:constant default="yes" type="overlay"></cd:constant>
</cd:parameter>
<cd:parameter name="repeat">
<cd:paramdoc>repeat on all pages?</cd:paramdoc>
<cd:constant type="yes"></cd:constant>
</cd:parameter>
<cd:parameter name="preset">
<cd:paramdoc>placement preset</cd:paramdoc>
<cd:constant type="lefttop"></cd:constant>
<cd:constant type="righttop"></cd:constant>
<cd:constant type="leftbottom"></cd:constant>
<cd:constant type="rightbottom"></cd:constant>
<cd:constant type="middle"></cd:constant>
<cd:constant type="middletop"></cd:constant>
<cd:constant type="middlebottom"></cd:constant>
<cd:constant type="middleleft"></cd:constant>
<cd:constant type="middleright"></cd:constant>
<cd:constant type="lefttopleft"></cd:constant>
<cd:constant type="lefttopright"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="definelayer" originator="system"></cd:commandref>
<cd:source file="pack-lyr.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Background"></cd:wikipage>
<cd:wikipage page="Layers"></cd:wikipage>
<cd:commandref name="setlayer"></cd:commandref>
<cd:commandref name="definelayer"></cd:commandref></cd:seealso>
</cd:commandgroup>