GData JavaScript Client 2.2

Class google.gdata.analytics.Segment

Object
   |
   +--google.gdata.analytics.Segment

class google.gdata.analytics.Segment


Describes a segment.
Defined in gdata.js


Field Summary
 Object $definitionClass_
          
 Object $propertiesClass_
          
 {string|undefined} id
          Id of the segment.
 {string|undefined} name
          Name of the segment.
 
Constructor Summary
google.gdata.analytics.Segment(<Object> opt_params)
            Constructs a segment using an object parameter whose property names match the setter method to use for each property.
 
Method Summary
 void addProperty(<google.gdata.analytics.Property|Object> property)
           Adds a new property.
 google.gdata.analytics.Definition|undefined getDefinition()
           Returns the definition.
 string|undefined getId()
           Returns the id of the segment.
 string|undefined getName()
           Returns the name of the segment.
 Array.<google.gdata.analytics.Property> getProperties()
           Returns the properties.
 void setDefinition(<google.gdata.analytics.Definition|Object|undefined> definition)
           Sets the definition.
 void setId(<string|undefined> id)
           Sets the id of the segment.
 void setName(<string|undefined> name)
           Sets the name of the segment.
 void setProperties(<Array.<google.gdata.analytics.Property>|Array.<Object>|undefined> properties)
           Sets the properties.

Field Detail

$definitionClass_

Object $definitionClass_

$propertiesClass_

Object $propertiesClass_

id

{string|undefined} id

name

{string|undefined} name

Constructor Detail

google.gdata.analytics.Segment

google.gdata.analytics.Segment(<Object> opt_params)

Method Detail

addProperty

void addProperty(<google.gdata.analytics.Property|Object> property)

getDefinition

google.gdata.analytics.Definition|undefined getDefinition()

getId

string|undefined getId()

getName

string|undefined getName()

getProperties

Array.<google.gdata.analytics.Property> getProperties()

setDefinition

void setDefinition(<google.gdata.analytics.Definition|Object|undefined> definition)

setId

void setId(<string|undefined> id)

setName

void setName(<string|undefined> name)

setProperties

void setProperties(<Array.<google.gdata.analytics.Property>|Array.<Object>|undefined> properties)

GData JavaScript Client 2.2

Documentation generated by JSDoc on Mon Dec 14 15:04:11 2009