Client- Side API Reference / c1 Module
c1 Module
File
c1.js
Module
c1

Defines the C1 controls, associated functions and classes.

Methods

documentReady

documentReady(callback: Function): void

Specify a function to execute when the DOM is fully loaded.

Parameters
  • callback: Function

    A function to execute after the DOM is ready.

Returns
void

getExtender

getExtender(owner: Control, id: string): Object

Gets the extender with specified owner and id.

Parameters
Returns
Object

getExtenders

getExtenders(owner: Control, type?: any): Object[]

Gets the extenders with specified owner and type.

For example, below code is used for getting all LineMarker extenders from the chart1 which is an instance of FlexChart.

var lineMarkers = c1.getExtenders(chart1, wijmo.chart.LineMarker);

Note: if type is not passed, this returns all extenders under the owner.

Parameters
  • owner: Control

    The Control who has the extender.

  • type: any Optional

    The extender's type. It is optional.

Returns
Object[]

getService

getService(id: string): Object

Gets the service instance according to the specified key. Till now two kinds of services could be returned: RemoteCollectionView and PivotEngine.

For example:

// gets the CollectionView object which id is 'collectionview1'.
var cv = c1.getService('collectionview1');
Parameters
Returns
Object