3,899
edits
Changes
Jump to navigation
Jump to search
Created page with "Documentation for \basegrid"
<cd:commandgroup name="basegrid" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The command <tt>\basegrid</tt> displays an empty grid.
</cd:shortdesc>
<cd:variants>
<cd:command category="graphics" file="meta-grd.mkiv" interfacedate="2019-11-19T09:54" interfacefile="i-grid.xml" level="document" name="basegrid" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="nx">
<cd:paramdoc>number of columns</cd:paramdoc>
<cd:constant type="cd:number">10 = default</cd:constant>
</cd:parameter>
<cd:parameter name="ny">
<cd:paramdoc>number of rows</cd:paramdoc>
<cd:constant type="cd:number">10 = default</cd:constant>
</cd:parameter>
<cd:parameter name="dx">
<cd:paramdoc>width of cells (uses <cd:iref name="unit"/>).
</cd:paramdoc>
<cd:constant type="cd:number">0.5 = default
</cd:constant>
</cd:parameter>
<cd:parameter name="dy">
<cd:paramdoc>heigth of cells (uses <cd:iref name="unit"/>)
</cd:paramdoc>
<cd:constant type="cd:number">0.5 = default
</cd:constant>
</cd:parameter>
<cd:parameter name="factor">
<cd:paramdoc>scale factor</cd:paramdoc>
<cd:constant type="cd:number">1 = natural size (default)</cd:constant>
</cd:parameter>
<cd:parameter name="scale">
<cd:paramdoc>scale factor</cd:paramdoc>
<cd:constant type="cd:number">1 = natural size (default)</cd:constant>
</cd:parameter>
<cd:parameter name="xstep">
<cd:paramdoc>put labels on the bottom every xstep column line marker</cd:paramdoc>
<cd:constant type="cd:number">default = empty (no labels)</cd:constant>
</cd:parameter>
<cd:parameter name="ystep">
<cd:paramdoc>put labels on the left every ystep row marker (starts at bottom)</cd:paramdoc>
<cd:constant type="cd:number">default = empty (no labels)</cd:constant>
</cd:parameter>
<cd:parameter name="offset">
<cd:paramdoc>label offset, positive values move toward grid center</cd:paramdoc>
<cd:constant type="cd:dimension">0.25\exheight = default</cd:constant>
</cd:parameter>
<cd:parameter name="xoffset">
<cd:paramdoc>label offset for row markers ("moves in x direction")</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="yoffset">
<cd:paramdoc>label offset for column markers ("moves in y direction")</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="align">
<cd:paramdoc>centers on middle of cell.
{{bug|produces an error with LMTX 2020.06.30}}</cd:paramdoc>
<cd:constant type="middle"></cd:constant>
</cd:parameter>
<cd:parameter name="unit">
<cd:paramdoc>dimension to use for <cd:iref name="dx"/> and <cd:iref name="dy"/></cd:paramdoc>
<cd:constant default="yes" type="cm"></cd:constant>
<cd:constant type="mm"></cd:constant>
<cd:constant type="in"></cd:constant>
<cd:constant type="pc"></cd:constant>
<cd:constant type="pt"></cd:constant>
<cd:constant type="bp"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>style for grid labels</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc>color for grid labels</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="rulecolor">
<cd:paramdoc>color for grid lines</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="rulethickness">
<cd:paramdoc>thickness of grid lines</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>The command <tt>\basegrid</tt> displays an empty grid with optional labelling of grid lines.</cd:description>
<cd:examples><cd:example title=""><context source="yes">
\basegrid[nx=4,ny=3]
</context>
</cd:example><cd:example title=""><context source="yes">
\basegrid[dy=1,dx=1,unit=in,
xstep=3,ystep=1,scale=.25,
style=bold,color=blue,offset=-.5\exheight,
rulecolor=red]
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="meta-grd.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage></cd:seealso>
</cd:commandgroup>
<cd:shortdesc>The command <tt>\basegrid</tt> displays an empty grid.
</cd:shortdesc>
<cd:variants>
<cd:command category="graphics" file="meta-grd.mkiv" interfacedate="2019-11-19T09:54" interfacefile="i-grid.xml" level="document" name="basegrid" variantnumber="1">
<cd:arguments>
<cd:assignments list="yes" optional="yes" ordinal="1">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="nx">
<cd:paramdoc>number of columns</cd:paramdoc>
<cd:constant type="cd:number">10 = default</cd:constant>
</cd:parameter>
<cd:parameter name="ny">
<cd:paramdoc>number of rows</cd:paramdoc>
<cd:constant type="cd:number">10 = default</cd:constant>
</cd:parameter>
<cd:parameter name="dx">
<cd:paramdoc>width of cells (uses <cd:iref name="unit"/>).
</cd:paramdoc>
<cd:constant type="cd:number">0.5 = default
</cd:constant>
</cd:parameter>
<cd:parameter name="dy">
<cd:paramdoc>heigth of cells (uses <cd:iref name="unit"/>)
</cd:paramdoc>
<cd:constant type="cd:number">0.5 = default
</cd:constant>
</cd:parameter>
<cd:parameter name="factor">
<cd:paramdoc>scale factor</cd:paramdoc>
<cd:constant type="cd:number">1 = natural size (default)</cd:constant>
</cd:parameter>
<cd:parameter name="scale">
<cd:paramdoc>scale factor</cd:paramdoc>
<cd:constant type="cd:number">1 = natural size (default)</cd:constant>
</cd:parameter>
<cd:parameter name="xstep">
<cd:paramdoc>put labels on the bottom every xstep column line marker</cd:paramdoc>
<cd:constant type="cd:number">default = empty (no labels)</cd:constant>
</cd:parameter>
<cd:parameter name="ystep">
<cd:paramdoc>put labels on the left every ystep row marker (starts at bottom)</cd:paramdoc>
<cd:constant type="cd:number">default = empty (no labels)</cd:constant>
</cd:parameter>
<cd:parameter name="offset">
<cd:paramdoc>label offset, positive values move toward grid center</cd:paramdoc>
<cd:constant type="cd:dimension">0.25\exheight = default</cd:constant>
</cd:parameter>
<cd:parameter name="xoffset">
<cd:paramdoc>label offset for row markers ("moves in x direction")</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="yoffset">
<cd:paramdoc>label offset for column markers ("moves in y direction")</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="align">
<cd:paramdoc>centers on middle of cell.
{{bug|produces an error with LMTX 2020.06.30}}</cd:paramdoc>
<cd:constant type="middle"></cd:constant>
</cd:parameter>
<cd:parameter name="unit">
<cd:paramdoc>dimension to use for <cd:iref name="dx"/> and <cd:iref name="dy"/></cd:paramdoc>
<cd:constant default="yes" type="cm"></cd:constant>
<cd:constant type="mm"></cd:constant>
<cd:constant type="in"></cd:constant>
<cd:constant type="pc"></cd:constant>
<cd:constant type="pt"></cd:constant>
<cd:constant type="bp"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>style for grid labels</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc>color for grid labels</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="rulecolor">
<cd:paramdoc>color for grid lines</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="rulethickness">
<cd:paramdoc>thickness of grid lines</cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>The command <tt>\basegrid</tt> displays an empty grid with optional labelling of grid lines.</cd:description>
<cd:examples><cd:example title=""><context source="yes">
\basegrid[nx=4,ny=3]
</context>
</cd:example><cd:example title=""><context source="yes">
\basegrid[dy=1,dx=1,unit=in,
xstep=3,ystep=1,scale=.25,
style=bold,color=blue,offset=-.5\exheight,
rulecolor=red]
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="meta-grd.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Graphics"></cd:wikipage></cd:seealso>
</cd:commandgroup>
