21

Now I have googling this a lot, but I cant seem to find what I am looking for. I am not talking about the options object that does drop down menus, I am talking about seeing stuff like 

options.remove, options.enable, options.instance,

To be honest, I am not sure if the code I am trying to figure out already created some object called "options" or if its a pre-built javascript object. It lights up purple in my dreamweaver editor so I have a feeling its a pre-built object. I am new, sorry.

anthonypliu
  • 12,179
  • 28
  • 92
  • 154

4 Answers4

29

An options object is an object passed into a method (usually a method that builds a jQuery widget, or similar) which provides configuration info.

An options object is usually declared using object literal notation:

var options = {
 width: '325px',
 height: '100px'
};

The options that are valid depend on the method or widget that you are calling. There is nothing 'special' about an options object that makes it different from any other javascript object. The object literal syntax above gives the same result as:

var options = new Object();
options.width = '325px';
options.height = '100px';

Example:

$( ".selector" ).datepicker({ disabled: true });
//create a jQuery datepicker widget on the HTML elements matched by ".selector",
//using the option: disabled=true
RMorrisey
  • 7,637
  • 9
  • 53
  • 71
  • @anthonypliu: if this response answered your question, you can accept it by clicking the "tick" image under the number to the top left. – nickf Jun 22 '10 at 01:55
7

There is no standard, universal object called options.

Most likely what's meant is that the library you're using happens to have a variable named options that has properties like remove, enable, and instance.

It's fairly common for library functions to take an options argument specifying... well... options — that is, supplementary settings the function can exploit. In cases where there are many variables you may want to set, a single object with those properties is cleaner than a function that takes a hundred ordered arguments.

VoteyDisciple
  • 37,319
  • 5
  • 97
  • 97
3

It is probably just a variable that the script created to hold a bunch of values.

var myoptions = new Object();    
myoptions.done = 1;
myoptions.welcome = 'Hello Dave'
myoptions.error = "I'm sorry dave, I can't do that".
ChaosPandion
  • 77,506
  • 18
  • 119
  • 157
Aaron Butacov
  • 32,415
  • 8
  • 47
  • 61
0

I would guess that the options object is just JSON. It is created from

{ "options": { "remove": true, "enable": false, "instance": object }

That is how most Javascript libraries load/set options. You can reference the objects properties just like you are doing in the question.

jhleath
  • 784
  • 1
  • 8
  • 18