ig.excel.DataBarConditionalFormat

Exposes properties which displays data bars in a WorksheetCell based on the cell's value as relative to the associated range.

Remarks

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • axisColor

    .axisColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the color of the axis.

  • axisColor

    .axisColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the color of the axis.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • axisPosition

    .axisPosition( );
    Return Type:
    ig.excel.DataBarAxisPosition
    Return Type Description:
    Returns a DataBarAxisPosition.

    Returns a DataBarAxisPosition value which determines whether an axis is displayed.

  • axisPosition

    .axisPosition( value:ig.excel.DataBarAxisPosition );
    Return Type:
    ig.excel.DataBarAxisPosition
    Return Type Description:
    Returns a DataBarAxisPosition.

    Sets a DataBarAxisPosition value which determines whether an axis is displayed.

    • value
    • Type:ig.excel.DataBarAxisPosition
  • barBorderColor

    .barBorderColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the border color of the data bar.

  • barBorderColor

    .barBorderColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the border color of the data bar.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • barColor

    .barColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the fill color of the data bar.

  • barColor

    .barColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the fill color of the data bar.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • barFillType

    .barFillType( );
    Return Type:
    ig.excel.DataBarFillType
    Return Type Description:
    Returns a DataBarFillType.

    Returns a DataBarFillType value which determines whether the data bar is filled with a solid color or a gradient.

  • barFillType

    .barFillType( value:ig.excel.DataBarFillType );
    Return Type:
    ig.excel.DataBarFillType
    Return Type Description:
    Returns a DataBarFillType.

    Sets a DataBarFillType value which determines whether the data bar is filled with a solid color or a gradient.

    • value
    • Type:ig.excel.DataBarFillType
  • direction

    .direction( );
    Return Type:
    ig.excel.DataBarDirection
    Return Type Description:
    Returns a DataBarDirection.

    Returns a DataBarDirection value which determines the direction in which the data bar extends.

  • direction

    .direction( value:ig.excel.DataBarDirection );
    Return Type:
    ig.excel.DataBarDirection
    Return Type Description:
    Returns a DataBarDirection.

    Sets a DataBarDirection value which determines the direction in which the data bar extends.

    • value
    • Type:ig.excel.DataBarDirection
  • fillPercentMax

    .fillPercentMax( );

    Returns an integer value which determines the length of the longest data bar, expressed as a percentage of the cell's width.

  • fillPercentMax

    .fillPercentMax( value:number );

    Sets an integer value which determines the length of the longest data bar, expressed as a percentage of the cell's width.

    • value
    • Type:number
  • fillPercentMin

    .fillPercentMin( );

    Returns an integer value which determines the length of the shortest data bar, expressed as a percentage of the cell's width.

  • fillPercentMin

    .fillPercentMin( value:number );

    Sets an integer value which determines the length of the shortest data bar, expressed as a percentage of the cell's width.

    • value
    • Type:number
  • maxPoint

    .maxPoint( );
    Return Type:
    ig.excel.ConditionValue
    Return Type Description:
    Returns a ConditionValue.

    Returns a value which determines the manner in which the longest bar is evaluated for this condition.

    Remarks

    The following values are not supported for the ConditionValue.valueType property, and will cause an exception to be thrown:

    • LowestValue
    • AutomaticMinimum
    • None

  • minPoint

    .minPoint( );
    Return Type:
    ig.excel.ConditionValue
    Return Type Description:
    Returns a ConditionValue.

    Returns a value which determines the manner in which the shortest bar is evaluated for this condition.

    Remarks

    The following values are not supported for the ConditionValue.valueType property, and will cause an exception to be thrown:

    • HighestValue
    • AutomaticMaximum
    • None

  • negativeBarFormat

    .negativeBarFormat( );
    Return Type:
    ig.excel.NegativeBarFormat
    Return Type Description:
    Returns a NegativeBarFormat.

    Returns a DataBarConditionalFormat.negativeBarFormat object which defines the visual attributes of negative-value data bars.

  • showBorder

    .showBorder( );

    Returns a boolean value indicating whether borders are displayed for both negative-value and positive-value databars.

  • showBorder

    .showBorder( value:boolean );

    Sets a boolean value indicating whether borders are displayed for both negative-value and positive-value databars.

    • value
    • Type:boolean
  • showValue

    .showValue( );

    Returns a boolean value indicating whether the cell value is shown along with the data bar.

    Remarks

    By default, the cell value is displayed along with the databar; use this property to prevent the cell value from appearing.

  • showValue

    .showValue( value:boolean );

    Sets a boolean value indicating whether the cell value is shown along with the data bar.

    • value
    • Type:boolean

    Remarks

    By default, the cell value is displayed along with the databar; use this property to prevent the cell value from appearing.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.