Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • ActionsWidget
  • CallsWidget
  • ChartWidget
  • CommentsWidget
  • EmailsWidget
  • EventsWidget
  • InlineRelationshipsWidget
  • InlineTagsWidget
  • LoggedTimeWidget
  • PublisherWidget
  • QuotesWidget
  • SortableWidget
  • TransactionalViewWidget
  • TwitterFeedWidget
  • WebActivityWidget
  • WorkflowStageDetailsWidget
  • Overview
  • Package
  • Class
  • Tree

Class ChartWidget

CComponent
Extended by CBaseController
Extended by CWidget
Extended by X2Widget
Extended by SortableWidget
Extended by ChartWidget

Direct known subclasses

EventsChartProfileWidget, UsersChartProfileWidget
Abstract
Package: application\components\sortableWidget
Located at x2engine/protected/components/sortableWidget/ChartWidget.php
Methods summary
public
# getChartSettings( )
public array
# getViewFileParams( )

Magic getter. Returns an array of parameters which should be passed to the view file associated with this
widget.

Magic getter. Returns an array of parameters which should be passed to the view file associated with this widget.

Returns

array
The value stored in $_viewFileParams

Overrides

SortableWidget::getViewFileParams()
public static
# getJSONPropertiesStructure( )

overrides parent method

overrides parent method

Overrides

SortableWidget::getJSONPropertiesStructure()
public
# getChartSetting( string $settingName )

Parameters

$settingName
string
$settingName
public string
# getSetupScript( )

overrides parent method. A sub prototype of SortableWidget.js is instantiated.

overrides parent method. A sub prototype of SortableWidget.js is instantiated.

Returns

string
JS string which gets registered when widget content gets rendered

Overrides

SortableWidget::getSetupScript()
public
# getPackages( )

overrides parent method. Adds JS file necessary to run the setup script.

overrides parent method. Adds JS file necessary to run the setup script.

Overrides

SortableWidget::getPackages()
public
# renderChartSubtypeSelector( )

Render the chart subtype selector

Render the chart subtype selector

protected
# getJSSortableWidgetParams( )

Magic getter.

Magic getter.

Overrides

SortableWidget::getJSSortableWidgetParams()
protected array
# getTranslations( )

Returns

array
translations to pass to JS objects

Overrides

SortableWidget::getTranslations()
protected array
# getCss( )

overrides parent method. Returns chart specific css

overrides parent method. Returns chart specific css

Returns

array
key is the proposed name of the css string which should be passed as the first argument to yii's registerCss. The value is the css string.

Overrides

SortableWidget::getCss()
protected
# getStartEndTimestamp( mixed $defaultStartTs, mixed $defaultEndTs )

Returns an array containing a start and end timestamp. If a date range cookie is set, the timestamps get generated. Otherwise start and end timestamp cookies are used. Specified default timestamps will be used when cookies are not set.

Returns an array containing a start and end timestamp. If a date range cookie is set, the timestamps get generated. Otherwise start and end timestamp cookies are used. Specified default timestamps will be used when cookies are not set.

Methods inherited from SortableWidget
addError(), addPackage(), createSortableWidget(), deleteSortableWidget(), getCreatableWidgetOptions(), getJSInstanceName(), getJSONProperties(), getJSONProperty(), getMinimized(), getParentType(), getPathAlias(), getSettingsMenuContent(), getSettingsMenuContentDialogs(), getSettingsMenuContentEntries(), getSharedCss(), getSharedCssFileNames(), getSharedViewFile(), getWidgetContents(), getWidgetKey(), getWidgetLabel(), getWidgetProperties(), getWidgetProperty(), getWidgetSubtypeOptions(), getWidgetSubtypes(), hasError(), init(), instantiateWidget(), parseWidgetLayoutKey(), registerCss(), registerSharedCss(), renderCloseButton(), renderErrors(), renderMinimizeButton(), renderSettingsMenu(), renderWidget(), renderWidgetContents(), renderWidgetLabel(), run(), setJSONProperties(), setMinimized(), setPackages(), setSharedViewFile(), setSortOrder(), setWidgetProperties(), setWidgetProperty(), subtypeIsValid()
Methods inherited from X2Widget
__construct(), ajaxRender(), behaviors(), getModule(), renderFile(), setModule()
Methods inherited from CWidget
actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()
Methods inherited from CBaseController
beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderInternal(), widget()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Constants summary
integer SECPERDAY 86400
#
integer SECPERWEEK 604800
#
Constants inherited from SortableWidget
PROFILE_WIDGET_PATH_ALIAS, RECORD_VIEW_WIDGET_PATH_ALIAS
Properties summary
public string $template '<div class="submenu-title-bar widget-title-bar">{widgetLabel}{chartSubtypeSelector}{closeButton}{minimizeButton}{settingsMenu}</div>{widgetContents}'
#

A mixture of html and attributes inside curly braces. This gets used by renderWidget to render widget elements specified in child classes. As with X2GridView, each attribute inside curly braces should have a corresponding method called render<attribute_name>.

A mixture of html and attributes inside curly braces. This gets used by renderWidget to render widget elements specified in child classes. As with X2GridView, each attribute inside curly braces should have a corresponding method called render<attribute_name>.

public string $chartType
#

the type of chart (e.g. 'eventsChart', 'usersChart')

the type of chart (e.g. 'eventsChart', 'usersChart')

public string $viewFile '_chartWidget'
#

The name of the view file containing the widget contents

The name of the view file containing the widget contents

protected string $containerClass 'sortable-widget-container x2-layout-island sortable-chart-widget'
#

CSS class to be added to the container element

CSS class to be added to the container element

protected array $_translations
#

translations to be passed along with $_JSSortableWidgetParams to the JS Sortable
Widget class constructor

translations to be passed along with $_JSSortableWidgetParams to the JS Sortable Widget class constructor

Properties inherited from SortableWidget
$_JSSortableWidgetParams, $_css, $_packages, $_settingsFormFields, $_setupScript, $_sharedCss, $_sharedCssFileNames, $_sharedViewFile, $_viewFileParams, $canBeCreated, $canBeDeleted, $createByDefault, $defaultTitle, $info, $isAjaxRequest, $profile, $relabelingEnabled, $sortableWidgetJSClass, $widgetManager, $widgetType, $widgetUID
Properties inherited from X2Widget
$_module
Properties inherited from CWidget
$actionPrefix, $skin
Magic properties inherited from X2Widget
$module
Magic properties inherited from CWidget
$controller, $id, $owner, $viewPath
X2CRM Documentation API documentation generated by ApiGen 2.8.0