THIS IS DOCUMENTATION FOR AN OBSOLETE PRODUCT.
SEE THE DOCUMENTATION CENTER FOR THE LATEST INFORMATION.

DOCUMENTATION CENTER SEARCH

New to Mathematica? Find your learning path »

Mathematica > Core Language > Package Development > Options Management > OptionsPattern >

BUILT-IN MATHEMATICA SYMBOL

Tutorials »|See Also »|More About »

OptionsPattern

is a pattern object that represents a collection of options given as rules, where the values of the options can be accessed using OptionValue.

OptionsPattern[f]
takes default option values from Options[f].

OptionsPattern

uses an explicit list of default option values.

MORE INFORMATION

OptionsPattern matches any sequence or nested list of rules, specified with or .

In OptionsPattern the can be either heads or explicit rules . Each head is treated as the list of rules obtained from Options.

OptionsPattern uses the default options of the nearest enclosing function.

OptionsPattern includes no default options.

EXAMPLES

CLOSE ALL

Basic Examples (3)

Define default option values for the function

Define

, allowing options to be given:

Use

with an explicit option setting:

Use

with options taken to have their default values:

Define default option values for this assignment without explicitly setting up Options

Take default option values from Plot:

Use the defaults from Plot:

Override one of the defaults from Plot:

Define default option values for the function

In[1]:=

Define

, allowing options to be given:

In[2]:=

Use

with an explicit option setting:

In[3]:=

Out[3]=

Use

with options taken to have their default values:

In[4]:=

Out[4]=

Define default option values for this assignment without explicitly setting up Options

In[1]:=

In[2]:=

Out[2]=

Take default option values from Plot:

In[1]:=

Use the defaults from Plot:

In[2]:=

Out[2]=

Override one of the defaults from Plot:

In[3]:=

Out[3]=

Scope (1)

Properties & Relations (1)