rubyXL 3.4.25 → 3.4.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.circleci/config.yml +24 -13
- data/.rubocop.yml +124 -0
- data/CHANGELOG.md +12 -0
- data/Gemfile +4 -2
- data/README.rdoc +24 -8
- data/VERSION +1 -1
- data/lib/rubyXL/convenience_methods/cell.rb +8 -7
- data/lib/rubyXL/convenience_methods/color.rb +6 -6
- data/lib/rubyXL/convenience_methods/workbook.rb +7 -7
- data/lib/rubyXL/convenience_methods/worksheet.rb +26 -6
- data/lib/rubyXL/objects/border.rb +6 -1
- data/lib/rubyXL/objects/cell_style.rb +1 -0
- data/lib/rubyXL/objects/color.rb +1 -1
- data/lib/rubyXL/objects/column_range.rb +16 -12
- data/lib/rubyXL/objects/document_properties.rb +1 -0
- data/lib/rubyXL/objects/external_links.rb +8 -0
- data/lib/rubyXL/objects/ooxml_object.rb +21 -17
- data/lib/rubyXL/objects/query_table.rb +4 -2
- data/lib/rubyXL/objects/reference.rb +56 -20
- data/lib/rubyXL/objects/relationships.rb +1 -1
- data/lib/rubyXL/objects/root.rb +1 -1
- data/lib/rubyXL/objects/shared_strings.rb +1 -1
- data/lib/rubyXL/objects/sheet_data.rb +11 -6
- data/lib/rubyXL/objects/storage.rb +6 -1
- data/lib/rubyXL/objects/stylesheet.rb +2 -3
- data/lib/rubyXL/objects/text.rb +3 -3
- data/lib/rubyXL/objects/theme.rb +15 -17
- data/lib/rubyXL/objects/workbook.rb +17 -9
- data/lib/rubyXL/objects/worksheet.rb +2 -2
- data/lib/rubyXL/worksheet.rb +11 -3
- data/rdoc/README_rdoc.html +536 -147
- data/rdoc/RubyXL/AExtension.html +605 -85
- data/rdoc/RubyXL/AExtensionStorageArea.html +493 -47
- data/rdoc/RubyXL/ActiveX.html +574 -74
- data/rdoc/RubyXL/ActiveXBinary.html +503 -49
- data/rdoc/RubyXL/AdjustHandleList.html +487 -47
- data/rdoc/RubyXL/Alignment.html +487 -47
- data/rdoc/RubyXL/AlternateContent.html +493 -47
- data/rdoc/RubyXL/AlternateUrls.html +539 -0
- data/rdoc/RubyXL/Authors.html +487 -47
- data/rdoc/RubyXL/AutoFilter.html +487 -47
- data/rdoc/RubyXL/AutoFilterColumn.html +487 -47
- data/rdoc/RubyXL/BinaryImageFile.html +510 -50
- data/rdoc/RubyXL/BodyProperties.html +487 -47
- data/rdoc/RubyXL/BooleanNode.html +493 -47
- data/rdoc/RubyXL/BooleanValue.html +493 -47
- data/rdoc/RubyXL/Border.html +640 -97
- data/rdoc/RubyXL/BorderEdge.html +578 -78
- data/rdoc/RubyXL/Borders.html +540 -68
- data/rdoc/RubyXL/Break.html +487 -47
- data/rdoc/RubyXL/BreakList.html +487 -47
- data/rdoc/RubyXL/CT_AdjPoint2D.html +487 -47
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +487 -47
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +487 -47
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +487 -47
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +487 -47
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +487 -47
- data/rdoc/RubyXL/CT_Backdrop.html +487 -47
- data/rdoc/RubyXL/CT_Bevel.html +487 -47
- data/rdoc/RubyXL/CT_BiLevelEffect.html +487 -47
- data/rdoc/RubyXL/CT_BlendEffect.html +487 -47
- data/rdoc/RubyXL/CT_Blip.html +487 -47
- data/rdoc/RubyXL/CT_BlipFillProperties.html +487 -47
- data/rdoc/RubyXL/CT_BlurEffect.html +487 -47
- data/rdoc/RubyXL/CT_Camera.html +487 -47
- data/rdoc/RubyXL/CT_Color.html +487 -47
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +487 -47
- data/rdoc/RubyXL/CT_ColorMapping.html +487 -47
- data/rdoc/RubyXL/CT_ColorScheme.html +487 -47
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +487 -47
- data/rdoc/RubyXL/CT_ConnectionSite.html +487 -47
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +487 -47
- data/rdoc/RubyXL/CT_DashStop.html +487 -47
- data/rdoc/RubyXL/CT_DashStopList.html +487 -47
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +487 -47
- data/rdoc/RubyXL/CT_DuotoneEffect.html +487 -47
- data/rdoc/RubyXL/CT_EffectContainer.html +487 -47
- data/rdoc/RubyXL/CT_EffectList.html +487 -47
- data/rdoc/RubyXL/CT_EffectReference.html +487 -47
- data/rdoc/RubyXL/CT_EffectStyleItem.html +487 -47
- data/rdoc/RubyXL/CT_EffectStyleList.html +487 -47
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +487 -47
- data/rdoc/RubyXL/CT_FillEffect.html +487 -47
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +487 -47
- data/rdoc/RubyXL/CT_FillStyleList.html +487 -47
- data/rdoc/RubyXL/CT_FlatText.html +487 -47
- data/rdoc/RubyXL/CT_FontCollection.html +487 -47
- data/rdoc/RubyXL/CT_FontReference.html +487 -47
- data/rdoc/RubyXL/CT_GeomGuideList.html +487 -47
- data/rdoc/RubyXL/CT_GlowEffect.html +487 -47
- data/rdoc/RubyXL/CT_GradientFillProperties.html +487 -47
- data/rdoc/RubyXL/CT_GradientStop.html +487 -47
- data/rdoc/RubyXL/CT_GradientStopList.html +487 -47
- data/rdoc/RubyXL/CT_HSLEffect.html +487 -47
- data/rdoc/RubyXL/CT_HslColor.html +487 -47
- data/rdoc/RubyXL/CT_Hyperlink.html +487 -47
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +487 -47
- data/rdoc/RubyXL/CT_LightRig.html +487 -47
- data/rdoc/RubyXL/CT_LineEndProperties.html +487 -47
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +487 -47
- data/rdoc/RubyXL/CT_LineProperties.html +487 -47
- data/rdoc/RubyXL/CT_LineStyleList.html +487 -47
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +487 -47
- data/rdoc/RubyXL/CT_LuminanceEffect.html +487 -47
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +487 -47
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +487 -47
- data/rdoc/RubyXL/CT_Path2D.html +487 -47
- data/rdoc/RubyXL/CT_Path2DArcTo.html +487 -47
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +487 -47
- data/rdoc/RubyXL/CT_Path2DList.html +487 -47
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +487 -47
- data/rdoc/RubyXL/CT_Path2DTo.html +487 -47
- data/rdoc/RubyXL/CT_PathShadeProperties.html +487 -47
- data/rdoc/RubyXL/CT_PatternFillProperties.html +487 -47
- data/rdoc/RubyXL/CT_Point3D.html +487 -47
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +487 -47
- data/rdoc/RubyXL/CT_PresetColor.html +487 -47
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +487 -47
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +487 -47
- data/rdoc/RubyXL/CT_PresetTextShape.html +487 -47
- data/rdoc/RubyXL/CT_ReflectionEffect.html +487 -47
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +487 -47
- data/rdoc/RubyXL/CT_RelativeRect.html +487 -47
- data/rdoc/RubyXL/CT_SRgbColor.html +487 -47
- data/rdoc/RubyXL/CT_ScRgbColor.html +487 -47
- data/rdoc/RubyXL/CT_Scene3D.html +487 -47
- data/rdoc/RubyXL/CT_SchemeColor.html +487 -47
- data/rdoc/RubyXL/CT_Shape3D.html +487 -47
- data/rdoc/RubyXL/CT_ShapeStyle.html +487 -47
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +487 -47
- data/rdoc/RubyXL/CT_SphereCoords.html +487 -47
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +487 -47
- data/rdoc/RubyXL/CT_StyleMatrix.html +487 -47
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +487 -47
- data/rdoc/RubyXL/CT_SupplementalFont.html +487 -47
- data/rdoc/RubyXL/CT_SystemColor.html +487 -47
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +487 -47
- data/rdoc/RubyXL/CT_TextBlipBullet.html +487 -47
- data/rdoc/RubyXL/CT_TextCharBullet.html +487 -47
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +487 -47
- data/rdoc/RubyXL/CT_TextFont.html +487 -47
- data/rdoc/RubyXL/CT_TextListStyle.html +487 -47
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +487 -47
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +487 -47
- data/rdoc/RubyXL/CT_TextSpacing.html +487 -47
- data/rdoc/RubyXL/CT_TextTabStop.html +487 -47
- data/rdoc/RubyXL/CT_TextTabStopList.html +487 -47
- data/rdoc/RubyXL/CT_TileInfoProperties.html +487 -47
- data/rdoc/RubyXL/CT_TintEffect.html +487 -47
- data/rdoc/RubyXL/CT_Transform2D.html +487 -47
- data/rdoc/RubyXL/CT_TransformEffect.html +487 -47
- data/rdoc/RubyXL/CT_Vector3D.html +487 -47
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +487 -47
- data/rdoc/RubyXL/CalculationChain.html +557 -71
- data/rdoc/RubyXL/CalculationChainCell.html +487 -47
- data/rdoc/RubyXL/CalculationProperties.html +487 -47
- data/rdoc/RubyXL/Cell.html +1033 -200
- data/rdoc/RubyXL/CellConvenienceMethods.html +1667 -382
- data/rdoc/RubyXL/CellExt.html +487 -47
- data/rdoc/RubyXL/CellSmartTag.html +487 -47
- data/rdoc/RubyXL/CellSmartTagProperty.html +487 -47
- data/rdoc/RubyXL/CellSmartTags.html +487 -47
- data/rdoc/RubyXL/CellStyle.html +487 -47
- data/rdoc/RubyXL/CellStyleXFs.html +540 -68
- data/rdoc/RubyXL/CellStyles.html +540 -68
- data/rdoc/RubyXL/CellValue.html +540 -68
- data/rdoc/RubyXL/CellWatch.html +487 -47
- data/rdoc/RubyXL/CellWatches.html +487 -47
- data/rdoc/RubyXL/CellXFs.html +542 -71
- data/rdoc/RubyXL/ChartColorsFile.html +510 -50
- data/rdoc/RubyXL/ChartFile.html +581 -75
- data/rdoc/RubyXL/ChartStyleFile.html +510 -50
- data/rdoc/RubyXL/ChartUserShapesFile.html +510 -50
- data/rdoc/RubyXL/Chartsheet.html +624 -92
- data/rdoc/RubyXL/ChartsheetPageSetup.html +487 -47
- data/rdoc/RubyXL/ChartsheetProperties.html +487 -47
- data/rdoc/RubyXL/ChartsheetProtection.html +487 -47
- data/rdoc/RubyXL/ChartsheetView.html +487 -47
- data/rdoc/RubyXL/ChartsheetViews.html +487 -47
- data/rdoc/RubyXL/Color.html +550 -70
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +626 -94
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +671 -105
- data/rdoc/RubyXL/ColorConvenienceClasses.html +482 -45
- data/rdoc/RubyXL/ColorConvenienceMethods.html +534 -65
- data/rdoc/RubyXL/ColorFilter.html +487 -47
- data/rdoc/RubyXL/ColorScale.html +487 -47
- data/rdoc/RubyXL/ColorSet.html +487 -47
- data/rdoc/RubyXL/Colors.html +487 -47
- data/rdoc/RubyXL/ColumnRange.html +685 -92
- data/rdoc/RubyXL/ColumnRanges.html +646 -102
- data/rdoc/RubyXL/Comment.html +487 -47
- data/rdoc/RubyXL/CommentList.html +487 -47
- data/rdoc/RubyXL/CommentsFile.html +570 -76
- data/rdoc/RubyXL/ConditionalFormatValue.html +487 -47
- data/rdoc/RubyXL/ConditionalFormatting.html +487 -47
- data/rdoc/RubyXL/ConditionalFormattingRule.html +487 -47
- data/rdoc/RubyXL/Connection.html +487 -47
- data/rdoc/RubyXL/ConnectionTable.html +487 -47
- data/rdoc/RubyXL/ConnectionTables.html +487 -47
- data/rdoc/RubyXL/ConnectionTextField.html +487 -47
- data/rdoc/RubyXL/ConnectionTextFields.html +487 -47
- data/rdoc/RubyXL/Connections.html +557 -71
- data/rdoc/RubyXL/ContentTypeDefault.html +493 -47
- data/rdoc/RubyXL/ContentTypeOverride.html +493 -47
- data/rdoc/RubyXL/ContentTypes.html +595 -81
- data/rdoc/RubyXL/ControlPropertiesFile.html +510 -50
- data/rdoc/RubyXL/CorePropertiesFile.html +825 -149
- data/rdoc/RubyXL/CustomColor.html +487 -47
- data/rdoc/RubyXL/CustomColorList.html +487 -47
- data/rdoc/RubyXL/CustomFilter.html +487 -47
- data/rdoc/RubyXL/CustomFilters.html +487 -47
- data/rdoc/RubyXL/CustomGeometry.html +487 -47
- data/rdoc/RubyXL/CustomProperties.html +487 -47
- data/rdoc/RubyXL/CustomPropertiesFile.html +510 -50
- data/rdoc/RubyXL/CustomProperty.html +487 -47
- data/rdoc/RubyXL/CustomPropertyFile.html +510 -50
- data/rdoc/RubyXL/CustomSheetView.html +487 -47
- data/rdoc/RubyXL/CustomSheetViews.html +487 -47
- data/rdoc/RubyXL/CustomWorkbookView.html +487 -47
- data/rdoc/RubyXL/CustomWorkbookViews.html +487 -47
- data/rdoc/RubyXL/CustomXMLFile.html +503 -49
- data/rdoc/RubyXL/DXF.html +487 -47
- data/rdoc/RubyXL/DXFs.html +487 -47
- data/rdoc/RubyXL/DataBar.html +487 -47
- data/rdoc/RubyXL/DataConsolidate.html +487 -47
- data/rdoc/RubyXL/DataConsolidationReference.html +487 -47
- data/rdoc/RubyXL/DataConsolidationReferences.html +487 -47
- data/rdoc/RubyXL/DataType.html +528 -53
- data/rdoc/RubyXL/DataValidation.html +487 -47
- data/rdoc/RubyXL/DataValidations.html +487 -47
- data/rdoc/RubyXL/DateGroupItem.html +487 -47
- data/rdoc/RubyXL/DefinedName.html +487 -47
- data/rdoc/RubyXL/DefinedNameExt.html +487 -47
- data/rdoc/RubyXL/DefinedNames.html +564 -47
- data/rdoc/RubyXL/DefinedNamesExt.html +487 -47
- data/rdoc/RubyXL/DocumentPropertiesFile.html +603 -86
- data/rdoc/RubyXL/DrawingFile.html +581 -75
- data/rdoc/RubyXL/DynamicFilter.html +487 -47
- data/rdoc/RubyXL/EmbeddedControl.html +487 -47
- data/rdoc/RubyXL/EmbeddedControls.html +487 -47
- data/rdoc/RubyXL/Extension.html +487 -47
- data/rdoc/RubyXL/ExtensionStorageArea.html +487 -47
- data/rdoc/RubyXL/Extents.html +487 -47
- data/rdoc/RubyXL/ExternalBook.html +487 -47
- data/rdoc/RubyXL/ExternalLinksFile.html +581 -75
- data/rdoc/RubyXL/ExternalReference.html +487 -47
- data/rdoc/RubyXL/ExternalReferences.html +487 -47
- data/rdoc/RubyXL/ExtraColorSchemeList.html +487 -47
- data/rdoc/RubyXL/FieldItem.html +487 -47
- data/rdoc/RubyXL/FileRecoveryProperties.html +487 -47
- data/rdoc/RubyXL/FileSharing.html +487 -47
- data/rdoc/RubyXL/FileVersion.html +487 -47
- data/rdoc/RubyXL/Fill.html +540 -68
- data/rdoc/RubyXL/Fills.html +540 -68
- data/rdoc/RubyXL/FilterContainer.html +487 -47
- data/rdoc/RubyXL/FloatNode.html +493 -47
- data/rdoc/RubyXL/FloatValue.html +493 -47
- data/rdoc/RubyXL/Font.html +551 -71
- data/rdoc/RubyXL/FontConvenienceMethods.html +938 -183
- data/rdoc/RubyXL/FontScheme.html +487 -47
- data/rdoc/RubyXL/Fonts.html +540 -68
- data/rdoc/RubyXL/Formula.html +487 -47
- data/rdoc/RubyXL/FunctionGroup.html +487 -47
- data/rdoc/RubyXL/FunctionGroups.html +487 -47
- data/rdoc/RubyXL/GenericStorageObject.html +671 -103
- data/rdoc/RubyXL/GradientFill.html +487 -47
- data/rdoc/RubyXL/HeaderFooterSettings.html +487 -47
- data/rdoc/RubyXL/Hyperlink.html +487 -47
- data/rdoc/RubyXL/HyperlinkRelFile.html +503 -49
- data/rdoc/RubyXL/Hyperlinks.html +487 -47
- data/rdoc/RubyXL/IconFilter.html +487 -47
- data/rdoc/RubyXL/IconSet.html +487 -47
- data/rdoc/RubyXL/IgnoredError.html +487 -47
- data/rdoc/RubyXL/IgnoredErrors.html +487 -47
- data/rdoc/RubyXL/IndexedColors.html +487 -47
- data/rdoc/RubyXL/InputCells.html +487 -47
- data/rdoc/RubyXL/IntegerNode.html +493 -47
- data/rdoc/RubyXL/IntegerValue.html +493 -47
- data/rdoc/RubyXL/LegacyCell.html +534 -65
- data/rdoc/RubyXL/LegacyWorksheet.html +727 -114
- data/rdoc/RubyXL/MRUColors.html +487 -47
- data/rdoc/RubyXL/MacrosFile.html +510 -50
- data/rdoc/RubyXL/MergedCell.html +487 -47
- data/rdoc/RubyXL/MergedCells.html +487 -47
- data/rdoc/RubyXL/NumFmt.html +487 -47
- data/rdoc/RubyXL/NumberFormat.html +540 -68
- data/rdoc/RubyXL/NumberFormats.html +551 -71
- data/rdoc/RubyXL/OLEObject.html +487 -47
- data/rdoc/RubyXL/OLEObjectFile.html +510 -50
- data/rdoc/RubyXL/OLEObjects.html +487 -47
- data/rdoc/RubyXL/OLESize.html +487 -47
- data/rdoc/RubyXL/OOXMLContainerObject.html +756 -137
- data/rdoc/RubyXL/OOXMLIgnored.html +598 -80
- data/rdoc/RubyXL/OOXMLObject.html +506 -52
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +741 -151
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +834 -169
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +894 -170
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +735 -131
- data/rdoc/RubyXL/OdbcOleDbProperties.html +487 -47
- data/rdoc/RubyXL/Offset.html +487 -47
- data/rdoc/RubyXL/OlapProperties.html +487 -47
- data/rdoc/RubyXL/OleItem.html +487 -47
- data/rdoc/RubyXL/OleItems.html +487 -47
- data/rdoc/RubyXL/OleLink.html +487 -47
- data/rdoc/RubyXL/OutlineProperties.html +487 -47
- data/rdoc/RubyXL/PageMargins.html +487 -47
- data/rdoc/RubyXL/PageSetup.html +487 -47
- data/rdoc/RubyXL/PageSetupProperties.html +487 -47
- data/rdoc/RubyXL/Pane.html +487 -47
- data/rdoc/RubyXL/Parser.html +578 -78
- data/rdoc/RubyXL/PatternFill.html +487 -47
- data/rdoc/RubyXL/PersonMetadata.html +568 -0
- data/rdoc/RubyXL/PhoneticProperties.html +487 -47
- data/rdoc/RubyXL/PhoneticRun.html +487 -47
- data/rdoc/RubyXL/PivotArea.html +487 -47
- data/rdoc/RubyXL/PivotCache.html +487 -47
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +529 -55
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +510 -50
- data/rdoc/RubyXL/PivotCaches.html +487 -47
- data/rdoc/RubyXL/PivotReference.html +487 -47
- data/rdoc/RubyXL/PivotReferences.html +487 -47
- data/rdoc/RubyXL/PivotTableFile.html +529 -55
- data/rdoc/RubyXL/PivotTableSelection.html +487 -47
- data/rdoc/RubyXL/PresetGeometry.html +487 -47
- data/rdoc/RubyXL/PrintOptions.html +487 -47
- data/rdoc/RubyXL/PrinterSettingsFile.html +510 -50
- data/rdoc/RubyXL/ProtectedRange.html +487 -47
- data/rdoc/RubyXL/ProtectedRanges.html +487 -47
- data/rdoc/RubyXL/Protection.html +487 -47
- data/rdoc/RubyXL/QueryParameter.html +487 -47
- data/rdoc/RubyXL/QueryParameters.html +487 -47
- data/rdoc/RubyXL/QueryTable.html +575 -75
- data/rdoc/RubyXL/QueryTableDeletedField.html +487 -47
- data/rdoc/RubyXL/QueryTableDeletedFields.html +487 -47
- data/rdoc/RubyXL/QueryTableField.html +487 -47
- data/rdoc/RubyXL/QueryTableFields.html +487 -47
- data/rdoc/RubyXL/QueryTableRefresh.html +487 -47
- data/rdoc/RubyXL/RID.html +493 -47
- data/rdoc/RubyXL/RawOOXML.html +605 -85
- data/rdoc/RubyXL/Reference.html +1109 -207
- data/rdoc/RubyXL/Relationship.html +493 -47
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +540 -65
- data/rdoc/RubyXL/RelationshipSupport.html +745 -126
- data/rdoc/RubyXL/RevisionPointer.html +487 -47
- data/rdoc/RubyXL/RichText.html +542 -70
- data/rdoc/RubyXL/RichTextRun.html +540 -68
- data/rdoc/RubyXL/Row.html +812 -148
- data/rdoc/RubyXL/RowExt.html +487 -47
- data/rdoc/RubyXL/RunProperties.html +487 -47
- data/rdoc/RubyXL/Scenario.html +487 -47
- data/rdoc/RubyXL/Scenarios.html +487 -47
- data/rdoc/RubyXL/Selection.html +540 -68
- data/rdoc/RubyXL/ShapeGuide.html +487 -47
- data/rdoc/RubyXL/ShapeTextRectangle.html +487 -47
- data/rdoc/RubyXL/SharedStringsTable.html +775 -137
- data/rdoc/RubyXL/Sheet.html +487 -47
- data/rdoc/RubyXL/SheetCalculationProperties.html +487 -47
- data/rdoc/RubyXL/SheetData.html +572 -78
- data/rdoc/RubyXL/SheetDataExt.html +487 -47
- data/rdoc/RubyXL/SheetDataSet.html +487 -47
- data/rdoc/RubyXL/SheetMetadata.html +510 -50
- data/rdoc/RubyXL/SheetName.html +487 -47
- data/rdoc/RubyXL/SheetNames.html +487 -47
- data/rdoc/RubyXL/Sheets.html +487 -47
- data/rdoc/RubyXL/SlicerCacheFile.html +510 -50
- data/rdoc/RubyXL/SlicerFile.html +510 -50
- data/rdoc/RubyXL/SmartTagProperties.html +487 -47
- data/rdoc/RubyXL/SmartTagType.html +487 -47
- data/rdoc/RubyXL/SmartTagTypes.html +487 -47
- data/rdoc/RubyXL/SmartTags.html +487 -47
- data/rdoc/RubyXL/SortCondition.html +487 -47
- data/rdoc/RubyXL/SortState.html +487 -47
- data/rdoc/RubyXL/Sqref.html +599 -81
- data/rdoc/RubyXL/Stop.html +487 -47
- data/rdoc/RubyXL/StringNode.html +493 -47
- data/rdoc/RubyXL/StringNodeW3C.html +598 -80
- data/rdoc/RubyXL/StringValue.html +493 -47
- data/rdoc/RubyXL/Stylesheet.html +707 -114
- data/rdoc/RubyXL/TableFile.html +510 -50
- data/rdoc/RubyXL/TableParts.html +493 -47
- data/rdoc/RubyXL/TableStyle.html +487 -47
- data/rdoc/RubyXL/TableStyles.html +487 -47
- data/rdoc/RubyXL/Text.html +591 -83
- data/rdoc/RubyXL/TextImportSettings.html +487 -47
- data/rdoc/RubyXL/Theme.html +651 -103
- data/rdoc/RubyXL/ThemeElements.html +487 -47
- data/rdoc/RubyXL/ThumbnailFile.html +510 -50
- data/rdoc/RubyXL/Top10.html +487 -47
- data/rdoc/RubyXL/VMLDrawingFile.html +530 -56
- data/rdoc/RubyXL/Variant.html +487 -47
- data/rdoc/RubyXL/Vector.html +540 -68
- data/rdoc/RubyXL/VectorValue.html +493 -47
- data/rdoc/RubyXL/VisualProperties.html +487 -47
- data/rdoc/RubyXL/WebPublishObject.html +487 -47
- data/rdoc/RubyXL/WebPublishObjects.html +487 -47
- data/rdoc/RubyXL/WebPublishingItem.html +487 -47
- data/rdoc/RubyXL/WebPublishingItems.html +487 -47
- data/rdoc/RubyXL/WebPublishingProperties.html +487 -47
- data/rdoc/RubyXL/WebQueryProperties.html +487 -47
- data/rdoc/RubyXL/Workbook.html +1560 -367
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +1069 -226
- data/rdoc/RubyXL/WorkbookProperties.html +487 -47
- data/rdoc/RubyXL/WorkbookProtection.html +487 -47
- data/rdoc/RubyXL/WorkbookRoot.html +741 -123
- data/rdoc/RubyXL/WorkbookView.html +487 -47
- data/rdoc/RubyXL/WorkbookViews.html +487 -47
- data/rdoc/RubyXL/Worksheet.html +840 -154
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +2725 -699
- data/rdoc/RubyXL/WorksheetDimensions.html +487 -47
- data/rdoc/RubyXL/WorksheetFormatProperties.html +493 -47
- data/rdoc/RubyXL/WorksheetProperties.html +487 -47
- data/rdoc/RubyXL/WorksheetProtection.html +487 -47
- data/rdoc/RubyXL/WorksheetView.html +487 -47
- data/rdoc/RubyXL/WorksheetViews.html +487 -47
- data/rdoc/RubyXL/XF.html +487 -47
- data/rdoc/RubyXL.html +1200 -163
- data/rdoc/created.rid +38 -38
- data/rdoc/css/rdoc.css +1670 -354
- data/rdoc/index.html +418 -433
- data/rdoc/js/aliki.js +511 -0
- data/rdoc/js/bash_highlighter.js +167 -0
- data/rdoc/js/c_highlighter.js +299 -0
- data/rdoc/js/{search.js → search_controller.js} +31 -12
- data/rdoc/js/search_data.js +1 -0
- data/rdoc/js/{navigation.js → search_navigation.js} +10 -10
- data/rdoc/js/search_ranker.js +239 -0
- data/rdoc/js/theme-toggle.js +112 -0
- data/rubyXL.gemspec +27 -70
- data/spec/lib/cell_spec.rb +56 -4
- data/spec/lib/color_spec.rb +7 -0
- data/spec/lib/parser_spec.rb +8 -5
- data/spec/lib/reference_spec.rb +69 -6
- data/spec/lib/rgb_color_spec.rb +2 -0
- data/spec/lib/stylesheet_spec.rb +2 -0
- data/spec/lib/text_spec.rb +3 -1
- data/spec/lib/workbook_spec.rb +6 -4
- data/spec/lib/worksheet_spec.rb +29 -17
- metadata +31 -47
- data/Gemfile.lock +0 -124
- data/rdoc/css/fonts.css +0 -167
- data/rdoc/fonts/Lato-Light.ttf +0 -0
- data/rdoc/fonts/Lato-LightItalic.ttf +0 -0
- data/rdoc/fonts/Lato-Regular.ttf +0 -0
- data/rdoc/fonts/Lato-RegularItalic.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/images/add.png +0 -0
- data/rdoc/images/arrow_up.png +0 -0
- data/rdoc/images/brick.png +0 -0
- data/rdoc/images/brick_link.png +0 -0
- data/rdoc/images/bug.png +0 -0
- data/rdoc/images/bullet_black.png +0 -0
- data/rdoc/images/bullet_toggle_minus.png +0 -0
- data/rdoc/images/bullet_toggle_plus.png +0 -0
- data/rdoc/images/date.png +0 -0
- data/rdoc/images/delete.png +0 -0
- data/rdoc/images/find.png +0 -0
- data/rdoc/images/loadingAnimation.gif +0 -0
- data/rdoc/images/macFFBgHack.png +0 -0
- data/rdoc/images/package.png +0 -0
- data/rdoc/images/page_green.png +0 -0
- data/rdoc/images/page_white_text.png +0 -0
- data/rdoc/images/page_white_width.png +0 -0
- data/rdoc/images/plugin.png +0 -0
- data/rdoc/images/ruby.png +0 -0
- data/rdoc/images/tag_blue.png +0 -0
- data/rdoc/images/tag_green.png +0 -0
- data/rdoc/images/transparent.png +0 -0
- data/rdoc/images/wrench.png +0 -0
- data/rdoc/images/wrench_orange.png +0 -0
- data/rdoc/images/zoom.png +0 -0
- data/rdoc/js/darkfish.js +0 -84
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search_index.js +0 -1
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +0 -229
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +0 -3010
data/rdoc/README_rdoc.html
CHANGED
|
@@ -1,144 +1,455 @@
|
|
|
1
1
|
<!DOCTYPE html>
|
|
2
2
|
|
|
3
|
-
<html>
|
|
3
|
+
<html lang="en">
|
|
4
4
|
<head>
|
|
5
5
|
<meta charset="UTF-8">
|
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
7
|
|
|
7
|
-
<title>README - rubyXL 3.4.
|
|
8
|
+
<title>README - rubyXL 3.4.38</title>
|
|
8
9
|
|
|
9
|
-
<script type="text/javascript">
|
|
10
|
-
var rdoc_rel_prefix = "./";
|
|
11
|
-
var index_rel_prefix = "./";
|
|
12
|
-
</script>
|
|
13
10
|
|
|
14
|
-
<
|
|
15
|
-
<
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
11
|
+
<meta name="keywords" content="ruby,documentation,README">
|
|
12
|
+
<meta
|
|
13
|
+
name="description"
|
|
14
|
+
content="README: badge. fury."
|
|
15
|
+
>
|
|
19
16
|
|
|
20
|
-
<link href="./css/fonts.css" rel="stylesheet">
|
|
21
|
-
<link href="./css/rdoc.css" rel="stylesheet">
|
|
22
17
|
|
|
23
18
|
|
|
24
|
-
<body id="top" role="document" class="file">
|
|
25
|
-
<nav role="navigation">
|
|
26
|
-
<div id="project-navigation">
|
|
27
|
-
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
-
<h2>
|
|
29
|
-
<a href="./index.html" rel="home">Home</a>
|
|
30
|
-
</h2>
|
|
31
19
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
20
|
+
<!-- Open Graph / Facebook -->
|
|
21
|
+
<meta property="og:type" content="website">
|
|
22
|
+
<meta property="og:title" content="README - rubyXL 3.4.38">
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
<meta property="og:description" content="badge. fury.">
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<!-- Twitter -->
|
|
33
|
+
<meta name="twitter:card" content="summary">
|
|
34
|
+
<meta name="twitter:title" content="README - rubyXL 3.4.38">
|
|
35
|
+
|
|
36
|
+
|
|
38
37
|
|
|
39
|
-
<
|
|
40
|
-
|
|
41
|
-
|
|
38
|
+
<meta name="twitter:description" content="badge. fury.">
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<script type="text/javascript">
|
|
43
|
+
var rdoc_rel_prefix = "./";
|
|
44
|
+
var index_rel_prefix = "./";
|
|
45
|
+
</script>
|
|
46
|
+
|
|
47
|
+
<script
|
|
48
|
+
src="./js/theme-toggle.js?v=7.2.0"
|
|
49
|
+
></script>
|
|
50
|
+
|
|
51
|
+
<script
|
|
52
|
+
src="./js/search_navigation.js?v=7.2.0"
|
|
53
|
+
defer
|
|
54
|
+
></script>
|
|
55
|
+
|
|
56
|
+
<script
|
|
57
|
+
src="./js/search_data.js?v=7.2.0"
|
|
58
|
+
defer
|
|
59
|
+
></script>
|
|
60
|
+
|
|
61
|
+
<script
|
|
62
|
+
src="./js/search_ranker.js?v=7.2.0"
|
|
63
|
+
defer
|
|
64
|
+
></script>
|
|
65
|
+
|
|
66
|
+
<script
|
|
67
|
+
src="./js/search_controller.js?v=7.2.0"
|
|
68
|
+
defer
|
|
69
|
+
></script>
|
|
70
|
+
|
|
71
|
+
<script
|
|
72
|
+
src="./js/c_highlighter.js?v=7.2.0"
|
|
73
|
+
defer
|
|
74
|
+
></script>
|
|
75
|
+
|
|
76
|
+
<script
|
|
77
|
+
src="./js/bash_highlighter.js?v=7.2.0"
|
|
78
|
+
defer
|
|
79
|
+
></script>
|
|
80
|
+
|
|
81
|
+
<script
|
|
82
|
+
src="./js/aliki.js?v=7.2.0"
|
|
83
|
+
defer
|
|
84
|
+
></script>
|
|
85
|
+
|
|
86
|
+
<link
|
|
87
|
+
href="./css/rdoc.css?v=7.2.0"
|
|
88
|
+
rel="stylesheet"
|
|
89
|
+
>
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<body role="document" class="file has-toc">
|
|
95
|
+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
96
|
+
<!-- Chevron (right arrow) - used for expand/collapse -->
|
|
97
|
+
<symbol
|
|
98
|
+
id="icon-chevron"
|
|
99
|
+
viewBox="0 0 24 24"
|
|
100
|
+
fill="none"
|
|
101
|
+
stroke="currentColor"
|
|
102
|
+
stroke-width="2"
|
|
103
|
+
stroke-linecap="round"
|
|
104
|
+
stroke-linejoin="round"
|
|
105
|
+
>
|
|
106
|
+
<polyline points="9 18 15 12 9 6"></polyline>
|
|
107
|
+
</symbol>
|
|
108
|
+
|
|
109
|
+
<!-- File/Document - Pages section -->
|
|
110
|
+
<symbol
|
|
111
|
+
id="icon-file"
|
|
112
|
+
viewBox="0 0 24 24"
|
|
113
|
+
fill="none"
|
|
114
|
+
stroke="currentColor"
|
|
115
|
+
stroke-width="2"
|
|
116
|
+
stroke-linecap="round"
|
|
117
|
+
stroke-linejoin="round"
|
|
118
|
+
>
|
|
119
|
+
<path
|
|
120
|
+
d="M14.5 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7.5L14.5 2z"
|
|
121
|
+
></path>
|
|
122
|
+
|
|
123
|
+
<polyline points="14 2 14 8 20 8"></polyline>
|
|
124
|
+
</symbol>
|
|
125
|
+
|
|
126
|
+
<!-- Layers/Stack - Classes and Modules section -->
|
|
127
|
+
<symbol
|
|
128
|
+
id="icon-layers"
|
|
129
|
+
viewBox="0 0 24 24"
|
|
130
|
+
fill="none"
|
|
131
|
+
stroke="currentColor"
|
|
132
|
+
stroke-width="2"
|
|
133
|
+
stroke-linecap="round"
|
|
134
|
+
stroke-linejoin="round"
|
|
135
|
+
>
|
|
136
|
+
<polygon points="12 2 2 7 12 12 22 7 12 2"></polygon>
|
|
137
|
+
<polyline points="2 17 12 22 22 17"></polyline>
|
|
138
|
+
<polyline points="2 12 12 17 22 12"></polyline>
|
|
139
|
+
</symbol>
|
|
140
|
+
|
|
141
|
+
<!-- Curly braces with C - Class Methods section -->
|
|
142
|
+
<symbol
|
|
143
|
+
id="icon-class-methods"
|
|
144
|
+
viewBox="0 0 24 24"
|
|
145
|
+
fill="none"
|
|
146
|
+
stroke="currentColor"
|
|
147
|
+
stroke-width="2"
|
|
148
|
+
stroke-linecap="round"
|
|
149
|
+
stroke-linejoin="round"
|
|
150
|
+
>
|
|
151
|
+
<path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
|
|
152
|
+
<path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
|
|
153
|
+
|
|
154
|
+
<text
|
|
155
|
+
x="12"
|
|
156
|
+
y="17"
|
|
157
|
+
text-anchor="middle"
|
|
158
|
+
font-size="13"
|
|
159
|
+
font-weight="bold"
|
|
160
|
+
fill="currentColor"
|
|
161
|
+
stroke="none"
|
|
162
|
+
>
|
|
163
|
+
C
|
|
164
|
+
</text>
|
|
165
|
+
</symbol>
|
|
166
|
+
|
|
167
|
+
<!-- Curly braces with I - Instance Methods section -->
|
|
168
|
+
<symbol
|
|
169
|
+
id="icon-instance-methods"
|
|
170
|
+
viewBox="0 0 24 24"
|
|
171
|
+
fill="none"
|
|
172
|
+
stroke="currentColor"
|
|
173
|
+
stroke-width="2"
|
|
174
|
+
stroke-linecap="round"
|
|
175
|
+
stroke-linejoin="round"
|
|
176
|
+
>
|
|
177
|
+
<path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
|
|
178
|
+
<path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
|
|
179
|
+
|
|
180
|
+
<text
|
|
181
|
+
x="12"
|
|
182
|
+
y="17"
|
|
183
|
+
text-anchor="middle"
|
|
184
|
+
font-size="13"
|
|
185
|
+
font-weight="bold"
|
|
186
|
+
fill="currentColor"
|
|
187
|
+
stroke="none"
|
|
188
|
+
>
|
|
189
|
+
I
|
|
190
|
+
</text>
|
|
191
|
+
</symbol>
|
|
192
|
+
|
|
193
|
+
<!-- Double chevrons up - Ancestors section -->
|
|
194
|
+
<symbol
|
|
195
|
+
id="icon-ancestors"
|
|
196
|
+
viewBox="0 0 24 24"
|
|
197
|
+
fill="none"
|
|
198
|
+
stroke="currentColor"
|
|
199
|
+
stroke-width="2"
|
|
200
|
+
stroke-linecap="round"
|
|
201
|
+
stroke-linejoin="round"
|
|
202
|
+
>
|
|
203
|
+
<polyline points="17 11 12 6 7 11"></polyline>
|
|
204
|
+
<polyline points="17 18 12 13 7 18"></polyline>
|
|
205
|
+
</symbol>
|
|
206
|
+
|
|
207
|
+
<!-- User with plus - Included Modules section -->
|
|
208
|
+
<symbol
|
|
209
|
+
id="icon-includes"
|
|
210
|
+
viewBox="0 0 24 24"
|
|
211
|
+
fill="none"
|
|
212
|
+
stroke="currentColor"
|
|
213
|
+
stroke-width="2"
|
|
214
|
+
stroke-linecap="round"
|
|
215
|
+
stroke-linejoin="round"
|
|
216
|
+
>
|
|
217
|
+
<path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
|
|
218
|
+
<circle cx="8.5" cy="7" r="4"></circle>
|
|
219
|
+
|
|
220
|
+
<line
|
|
221
|
+
x1="20"
|
|
222
|
+
y1="8"
|
|
223
|
+
x2="20"
|
|
224
|
+
y2="14"
|
|
225
|
+
></line>
|
|
226
|
+
|
|
227
|
+
<line
|
|
228
|
+
x1="23"
|
|
229
|
+
y1="11"
|
|
230
|
+
x2="17"
|
|
231
|
+
y2="11"
|
|
232
|
+
></line>
|
|
233
|
+
</symbol>
|
|
234
|
+
|
|
235
|
+
<!-- User with check - Extended Modules section -->
|
|
236
|
+
<symbol
|
|
237
|
+
id="icon-extends"
|
|
238
|
+
viewBox="0 0 24 24"
|
|
239
|
+
fill="none"
|
|
240
|
+
stroke="currentColor"
|
|
241
|
+
stroke-width="2"
|
|
242
|
+
stroke-linecap="round"
|
|
243
|
+
stroke-linejoin="round"
|
|
244
|
+
>
|
|
245
|
+
<path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
|
|
246
|
+
<circle cx="8.5" cy="7" r="4"></circle>
|
|
247
|
+
<polyline points="17 11 19 13 23 9"></polyline>
|
|
248
|
+
</symbol>
|
|
249
|
+
|
|
250
|
+
<!-- List - Sections section -->
|
|
251
|
+
<symbol
|
|
252
|
+
id="icon-list"
|
|
253
|
+
viewBox="0 0 24 24"
|
|
254
|
+
fill="none"
|
|
255
|
+
stroke="currentColor"
|
|
256
|
+
stroke-width="2"
|
|
257
|
+
stroke-linecap="round"
|
|
258
|
+
stroke-linejoin="round"
|
|
259
|
+
>
|
|
260
|
+
<line
|
|
261
|
+
x1="8"
|
|
262
|
+
y1="6"
|
|
263
|
+
x2="21"
|
|
264
|
+
y2="6"
|
|
265
|
+
></line>
|
|
266
|
+
|
|
267
|
+
<line
|
|
268
|
+
x1="8"
|
|
269
|
+
y1="12"
|
|
270
|
+
x2="21"
|
|
271
|
+
y2="12"
|
|
272
|
+
></line>
|
|
273
|
+
|
|
274
|
+
<line
|
|
275
|
+
x1="8"
|
|
276
|
+
y1="18"
|
|
277
|
+
x2="21"
|
|
278
|
+
y2="18"
|
|
279
|
+
></line>
|
|
280
|
+
|
|
281
|
+
<line
|
|
282
|
+
x1="3"
|
|
283
|
+
y1="6"
|
|
284
|
+
x2="3.01"
|
|
285
|
+
y2="6"
|
|
286
|
+
></line>
|
|
287
|
+
|
|
288
|
+
<line
|
|
289
|
+
x1="3"
|
|
290
|
+
y1="12"
|
|
291
|
+
x2="3.01"
|
|
292
|
+
y2="12"
|
|
293
|
+
></line>
|
|
294
|
+
|
|
295
|
+
<line
|
|
296
|
+
x1="3"
|
|
297
|
+
y1="18"
|
|
298
|
+
x2="3.01"
|
|
299
|
+
y2="18"
|
|
300
|
+
></line>
|
|
301
|
+
</symbol>
|
|
302
|
+
</svg>
|
|
303
|
+
|
|
304
|
+
<header class="top-navbar">
|
|
305
|
+
<a href="./index.html" class="navbar-brand">
|
|
306
|
+
rubyXL 3.4.38
|
|
307
|
+
</a>
|
|
308
|
+
|
|
309
|
+
<!-- Desktop search bar -->
|
|
310
|
+
<div class="navbar-search navbar-search-desktop" role="search">
|
|
311
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
42
312
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
-
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
-
type="text" name="search" placeholder="Search
|
|
313
|
+
aria-autocomplete="list" aria-controls="search-results-desktop"
|
|
314
|
+
type="text" name="search" placeholder="Search (/) for a class, method..."
|
|
315
|
+
spellcheck="false" autocomplete="off"
|
|
45
316
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
317
|
+
<ul id="search-results-desktop" aria-label="Search Results"
|
|
318
|
+
aria-busy="false" aria-expanded="false"
|
|
319
|
+
aria-atomic="false" class="initially-hidden search-results"></ul>
|
|
320
|
+
</form>
|
|
321
|
+
</div>
|
|
322
|
+
|
|
323
|
+
<!-- Mobile search icon button -->
|
|
324
|
+
<button id="search-toggle" class="navbar-search-mobile" aria-label="Open search" type="button">
|
|
325
|
+
<span aria-hidden="true">🔍</span>
|
|
326
|
+
</button>
|
|
327
|
+
|
|
328
|
+
<!-- Theme toggle button -->
|
|
329
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Switch to dark mode" type="button">
|
|
330
|
+
<span class="theme-toggle-icon" aria-hidden="true">🌙</span>
|
|
331
|
+
</button>
|
|
332
|
+
</header>
|
|
333
|
+
|
|
334
|
+
<!-- Search Modal (Mobile) -->
|
|
335
|
+
<div id="search-modal" class="search-modal" hidden aria-modal="true" role="dialog" aria-label="Search">
|
|
336
|
+
<div class="search-modal-backdrop"></div>
|
|
337
|
+
<div class="search-modal-content">
|
|
338
|
+
<div class="search-modal-header">
|
|
339
|
+
<form class="search-modal-form" action="#" method="get" accept-charset="utf-8">
|
|
340
|
+
<span class="search-modal-icon" aria-hidden="true">🔍</span>
|
|
341
|
+
<input id="search-field-mobile" role="combobox" aria-label="Search"
|
|
342
|
+
aria-autocomplete="list" aria-controls="search-results-mobile"
|
|
343
|
+
type="text" name="search" placeholder="Search documentation"
|
|
344
|
+
spellcheck="false" autocomplete="off">
|
|
345
|
+
<button type="button" class="search-modal-close" aria-label="Close search" id="search-modal-close">
|
|
346
|
+
<span aria-hidden="true">esc</span>
|
|
347
|
+
</button>
|
|
348
|
+
</form>
|
|
46
349
|
</div>
|
|
350
|
+
<div class="search-modal-body">
|
|
351
|
+
<ul id="search-results-mobile" aria-label="Search Results"
|
|
352
|
+
aria-busy="false" aria-expanded="false"
|
|
353
|
+
aria-atomic="false" class="search-results search-modal-results initially-hidden"></ul>
|
|
354
|
+
<div class="search-modal-empty">
|
|
355
|
+
<p>No recent searches</p>
|
|
356
|
+
</div>
|
|
357
|
+
</div>
|
|
358
|
+
</div>
|
|
359
|
+
</div>
|
|
47
360
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
-
</form>
|
|
361
|
+
<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
|
|
362
|
+
<span aria-hidden="true">☰</span>
|
|
52
363
|
</div>
|
|
53
364
|
|
|
54
|
-
</div>
|
|
55
365
|
|
|
366
|
+
<nav id="navigation" role="navigation" hidden>
|
|
56
367
|
|
|
57
|
-
<div class="nav-section">
|
|
58
|
-
<h3>Table of Contents</h3>
|
|
59
|
-
|
|
60
|
-
<ul class="link-list" role="directory">
|
|
61
|
-
<li><a href="#label-rubyXL">rubyXL</a>
|
|
62
|
-
<li><a href="#label-To+Install-3A">To Install:</a>
|
|
63
|
-
<li><a href="#label-To+Use-3A">To Use:</a>
|
|
64
|
-
<li><a href="#label-Convenience+methods">Convenience methods</a>
|
|
65
|
-
<li><a href="#label-Parsing+an+existing+workbook">Parsing an existing workbook</a>
|
|
66
|
-
<li><a href="#label-Creating+a+new+Workbook">Creating a new Workbook</a>
|
|
67
|
-
<li><a href="#label-Accessing">Accessing</a>
|
|
68
|
-
<li><a href="#label-Accessing+a+Worksheet">Accessing a Worksheet</a>
|
|
69
|
-
<li><a href="#label-Accessing+a+Row+-28Array+of+Cells-29">Accessing a Row (Array of Cells)</a>
|
|
70
|
-
<li><a href="#label-Accessing+a+Cell+object">Accessing a Cell object</a>
|
|
71
|
-
<li><a href="#label-Wrappers+for+accessing+Cell+properties">Wrappers for accessing Cell properties</a>
|
|
72
|
-
<li><a href="#label-Wrappers+for+accessing+Row+properties+">Wrappers for accessing Row properties </a>
|
|
73
|
-
<li><a href="#label-Accessing+column+properties">Accessing column properties</a>
|
|
74
|
-
<li><a href="#label-Modifying">Modifying</a>
|
|
75
|
-
<li><a href="#label-Adding+Worksheets">Adding Worksheets</a>
|
|
76
|
-
<li><a href="#label-Renaming+Worksheets">Renaming Worksheets</a>
|
|
77
|
-
<li><a href="#label-Adding+Cells">Adding Cells</a>
|
|
78
|
-
<li><a href="#label-Changing+Cells">Changing Cells</a>
|
|
79
|
-
<li><a href="#label-Changing+Fonts">Changing Fonts</a>
|
|
80
|
-
<li><a href="#label-Changing+Fills+++++">Changing Fills </a>
|
|
81
|
-
<li><a href="#label-Changing+Borders">Changing Borders</a>
|
|
82
|
-
<li><a href="#label-Changing+Alignment">Changing Alignment</a>
|
|
83
|
-
<li><a href="#label-Horizontal">Horizontal</a>
|
|
84
|
-
<li><a href="#label-Vertical">Vertical</a>
|
|
85
|
-
<li><a href="#label-Rotation">Rotation</a>
|
|
86
|
-
<li><a href="#label-Changing+Row+Height">Changing Row Height</a>
|
|
87
|
-
<li><a href="#label-Changing+Column+Width">Changing Column Width</a>
|
|
88
|
-
<li><a href="#label-Merging+Cells">Merging Cells</a>
|
|
89
|
-
<li><a href="#label-Insert+Row">Insert Row</a>
|
|
90
|
-
<li><a href="#label-Insert+Column">Insert Column</a>
|
|
91
|
-
<li><a href="#label-Delete+Row">Delete Row</a>
|
|
92
|
-
<li><a href="#label-Delete+Column">Delete Column</a>
|
|
93
|
-
<li><a href="#label-Insert+Cell">Insert Cell</a>
|
|
94
|
-
<li><a href="#label-Delete+Cell">Delete Cell</a>
|
|
95
|
-
<li><a href="#label-Modifying+Cell+Format">Modifying Cell Format</a>
|
|
96
|
-
<li><a href="#label-Add+hyperlink+to+a+Cell">Add hyperlink to a Cell</a>
|
|
97
|
-
<li><a href="#label-I-2FO">I/O</a>
|
|
98
|
-
<li><a href="#label-Miscellaneous">Miscellaneous</a>
|
|
99
|
-
<li><a href="#label-Suppress+warnings+about+malformed+input+files">Suppress warnings about malformed input files</a>
|
|
100
|
-
<li><a href="#label-Data+validation+-28colloquially+referred+to+as+-22dropdown+list-22-29">Data validation (colloquially referred to as “dropdown list”)</a>
|
|
101
|
-
<li><a href="#label-For+more+information">For more information</a>
|
|
102
|
-
<li><a href="#label-Contributing+to+rubyXL">Contributing to rubyXL</a>
|
|
103
|
-
<li><a href="#label-Copyright">Copyright</a>
|
|
104
|
-
</ul>
|
|
105
|
-
</div>
|
|
106
368
|
|
|
107
369
|
|
|
108
|
-
<div id="project-metadata">
|
|
109
|
-
|
|
110
|
-
<div id="fileindex-section" class="nav-section">
|
|
111
|
-
<h3>Pages</h3>
|
|
112
370
|
|
|
113
|
-
<ul class="link-list">
|
|
114
|
-
<li><a href="./README_rdoc.html">README</a>
|
|
115
|
-
</ul>
|
|
116
|
-
</div>
|
|
117
371
|
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
<div id="fileindex-section" class="nav-section">
|
|
375
|
+
<details class="nav-section-collapsible" open>
|
|
376
|
+
<summary class="nav-section-header">
|
|
377
|
+
<span class="nav-section-icon">
|
|
378
|
+
<svg>
|
|
379
|
+
<use href="#icon-file"></use>
|
|
380
|
+
</svg>
|
|
381
|
+
</span>
|
|
382
|
+
|
|
383
|
+
<span class="nav-section-title">Pages</span>
|
|
384
|
+
|
|
385
|
+
<span class="nav-section-chevron">
|
|
386
|
+
<svg>
|
|
387
|
+
<use href="#icon-chevron"></use>
|
|
388
|
+
</svg>
|
|
389
|
+
</span>
|
|
390
|
+
</summary>
|
|
391
|
+
|
|
392
|
+
<ul class="nav-list">
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li>
|
|
400
|
+
<a href="./README_rdoc.html">
|
|
401
|
+
README
|
|
402
|
+
</a>
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
</ul>
|
|
406
|
+
</details>
|
|
118
407
|
</div>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<div id="classindex-section" class="nav-section">
|
|
411
|
+
<details class="nav-section-collapsible" open>
|
|
412
|
+
<summary class="nav-section-header">
|
|
413
|
+
<span class="nav-section-icon">
|
|
414
|
+
<svg><use href="#icon-layers"></use></svg>
|
|
415
|
+
</span>
|
|
416
|
+
<span class="nav-section-title">Classes and Modules</span>
|
|
417
|
+
<span class="nav-section-chevron">
|
|
418
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
419
|
+
</span>
|
|
420
|
+
</summary>
|
|
421
|
+
|
|
422
|
+
<ul class="link-list nav-list"><li><details open><summary><code><a href="./RubyXL.html">RubyXL</a></code></summary><ul class="link-list nav-list"><li><code><a href="./RubyXL/AExtension.html">AExtension</a></code></li><li><code><a href="./RubyXL/AExtensionStorageArea.html">AExtensionStorageArea</a></code></li><li><code><a href="./RubyXL/ActiveX.html">ActiveX</a></code></li><li><code><a href="./RubyXL/ActiveXBinary.html">ActiveXBinary</a></code></li><li><code><a href="./RubyXL/AdjustHandleList.html">AdjustHandleList</a></code></li><li><code><a href="./RubyXL/Alignment.html">Alignment</a></code></li><li><code><a href="./RubyXL/AlternateContent.html">AlternateContent</a></code></li><li><code><a href="./RubyXL/AlternateUrls.html">AlternateUrls</a></code></li><li><code><a href="./RubyXL/Authors.html">Authors</a></code></li><li><code><a href="./RubyXL/AutoFilter.html">AutoFilter</a></code></li><li><code><a href="./RubyXL/AutoFilterColumn.html">AutoFilterColumn</a></code></li><li><code><a href="./RubyXL/BinaryImageFile.html">BinaryImageFile</a></code></li><li><code><a href="./RubyXL/BodyProperties.html">BodyProperties</a></code></li><li><code><a href="./RubyXL/BooleanNode.html">BooleanNode</a></code></li><li><code><a href="./RubyXL/BooleanValue.html">BooleanValue</a></code></li><li><code><a href="./RubyXL/Border.html">Border</a></code></li><li><code><a href="./RubyXL/BorderEdge.html">BorderEdge</a></code></li><li><code><a href="./RubyXL/Borders.html">Borders</a></code></li><li><code><a href="./RubyXL/Break.html">Break</a></code></li><li><code><a href="./RubyXL/BreakList.html">BreakList</a></code></li><li><code><a href="./RubyXL/CT_AdjPoint2D.html">CT_AdjPoint2D</a></code></li><li><code><a href="./RubyXL/CT_AlphaBiLevelEffect.html">CT_AlphaBiLevelEffect</a></code></li><li><code><a href="./RubyXL/CT_AlphaModulateEffect.html">CT_AlphaModulateEffect</a></code></li><li><code><a href="./RubyXL/CT_AlphaModulateFixedEffect.html">CT_AlphaModulateFixedEffect</a></code></li><li><code><a href="./RubyXL/CT_AlphaOutsetEffect.html">CT_AlphaOutsetEffect</a></code></li><li><code><a href="./RubyXL/CT_AlphaReplaceEffect.html">CT_AlphaReplaceEffect</a></code></li><li><code><a href="./RubyXL/CT_Backdrop.html">CT_Backdrop</a></code></li><li><code><a href="./RubyXL/CT_Bevel.html">CT_Bevel</a></code></li><li><code><a href="./RubyXL/CT_BiLevelEffect.html">CT_BiLevelEffect</a></code></li><li><code><a href="./RubyXL/CT_BlendEffect.html">CT_BlendEffect</a></code></li><li><code><a href="./RubyXL/CT_Blip.html">CT_Blip</a></code></li><li><code><a href="./RubyXL/CT_BlipFillProperties.html">CT_BlipFillProperties</a></code></li><li><code><a href="./RubyXL/CT_BlurEffect.html">CT_BlurEffect</a></code></li><li><code><a href="./RubyXL/CT_Camera.html">CT_Camera</a></code></li><li><code><a href="./RubyXL/CT_Color.html">CT_Color</a></code></li><li><code><a href="./RubyXL/CT_ColorChangeEffect.html">CT_ColorChangeEffect</a></code></li><li><code><a href="./RubyXL/CT_ColorMapping.html">CT_ColorMapping</a></code></li><li><code><a href="./RubyXL/CT_ColorScheme.html">CT_ColorScheme</a></code></li><li><code><a href="./RubyXL/CT_ColorSchemeAndMapping.html">CT_ColorSchemeAndMapping</a></code></li><li><code><a href="./RubyXL/CT_ConnectionSite.html">CT_ConnectionSite</a></code></li><li><code><a href="./RubyXL/CT_ConnectionSiteList.html">CT_ConnectionSiteList</a></code></li><li><code><a href="./RubyXL/CT_DashStop.html">CT_DashStop</a></code></li><li><code><a href="./RubyXL/CT_DashStopList.html">CT_DashStopList</a></code></li><li><code><a href="./RubyXL/CT_DefaultShapeDefinition.html">CT_DefaultShapeDefinition</a></code></li><li><code><a href="./RubyXL/CT_DuotoneEffect.html">CT_DuotoneEffect</a></code></li><li><code><a href="./RubyXL/CT_EffectContainer.html">CT_EffectContainer</a></code></li><li><code><a href="./RubyXL/CT_EffectList.html">CT_EffectList</a></code></li><li><code><a href="./RubyXL/CT_EffectReference.html">CT_EffectReference</a></code></li><li><code><a href="./RubyXL/CT_EffectStyleItem.html">CT_EffectStyleItem</a></code></li><li><code><a href="./RubyXL/CT_EffectStyleList.html">CT_EffectStyleList</a></code></li><li><code><a href="./RubyXL/CT_EmbeddedWAVAudioFile.html">CT_EmbeddedWAVAudioFile</a></code></li><li><code><a href="./RubyXL/CT_FillEffect.html">CT_FillEffect</a></code></li><li><code><a href="./RubyXL/CT_FillOverlayEffect.html">CT_FillOverlayEffect</a></code></li><li><code><a href="./RubyXL/CT_FillStyleList.html">CT_FillStyleList</a></code></li><li><code><a href="./RubyXL/CT_FlatText.html">CT_FlatText</a></code></li><li><code><a href="./RubyXL/CT_FontCollection.html">CT_FontCollection</a></code></li><li><code><a href="./RubyXL/CT_FontReference.html">CT_FontReference</a></code></li><li><code><a href="./RubyXL/CT_GeomGuideList.html">CT_GeomGuideList</a></code></li><li><code><a href="./RubyXL/CT_GlowEffect.html">CT_GlowEffect</a></code></li><li><code><a href="./RubyXL/CT_GradientFillProperties.html">CT_GradientFillProperties</a></code></li><li><code><a href="./RubyXL/CT_GradientStop.html">CT_GradientStop</a></code></li><li><code><a href="./RubyXL/CT_GradientStopList.html">CT_GradientStopList</a></code></li><li><code><a href="./RubyXL/CT_HSLEffect.html">CT_HSLEffect</a></code></li><li><code><a href="./RubyXL/CT_HslColor.html">CT_HslColor</a></code></li><li><code><a href="./RubyXL/CT_Hyperlink.html">CT_Hyperlink</a></code></li><li><code><a href="./RubyXL/CT_InnerShadowEffect.html">CT_InnerShadowEffect</a></code></li><li><code><a href="./RubyXL/CT_LightRig.html">CT_LightRig</a></code></li><li><code><a href="./RubyXL/CT_LineEndProperties.html">CT_LineEndProperties</a></code></li><li><code><a href="./RubyXL/CT_LineJoinMiterProperties.html">CT_LineJoinMiterProperties</a></code></li><li><code><a href="./RubyXL/CT_LineProperties.html">CT_LineProperties</a></code></li><li><code><a href="./RubyXL/CT_LineStyleList.html">CT_LineStyleList</a></code></li><li><code><a href="./RubyXL/CT_LinearShadeProperties.html">CT_LinearShadeProperties</a></code></li><li><code><a href="./RubyXL/CT_LuminanceEffect.html">CT_LuminanceEffect</a></code></li><li><code><a href="./RubyXL/CT_ObjectStyleDefaults.html">CT_ObjectStyleDefaults</a></code></li><li><code><a href="./RubyXL/CT_OuterShadowEffect.html">CT_OuterShadowEffect</a></code></li><li><code><a href="./RubyXL/CT_Path2D.html">CT_Path2D</a></code></li><li><code><a href="./RubyXL/CT_Path2DArcTo.html">CT_Path2DArcTo</a></code></li><li><code><a href="./RubyXL/CT_Path2DCubicBezierTo.html">CT_Path2DCubicBezierTo</a></code></li><li><code><a href="./RubyXL/CT_Path2DList.html">CT_Path2DList</a></code></li><li><code><a href="./RubyXL/CT_Path2DQuadBezierTo.html">CT_Path2DQuadBezierTo</a></code></li><li><code><a href="./RubyXL/CT_Path2DTo.html">CT_Path2DTo</a></code></li><li><code><a href="./RubyXL/CT_PathShadeProperties.html">CT_PathShadeProperties</a></code></li><li><code><a href="./RubyXL/CT_PatternFillProperties.html">CT_PatternFillProperties</a></code></li><li><code><a href="./RubyXL/CT_Point3D.html">CT_Point3D</a></code></li><li><code><a href="./RubyXL/CT_PolarAdjustHandle.html">CT_PolarAdjustHandle</a></code></li><li><code><a href="./RubyXL/CT_PresetColor.html">CT_PresetColor</a></code></li><li><code><a href="./RubyXL/CT_PresetLineDashProperties.html">CT_PresetLineDashProperties</a></code></li><li><code><a href="./RubyXL/CT_PresetShadowEffect.html">CT_PresetShadowEffect</a></code></li><li><code><a href="./RubyXL/CT_PresetTextShape.html">CT_PresetTextShape</a></code></li><li><code><a href="./RubyXL/CT_ReflectionEffect.html">CT_ReflectionEffect</a></code></li><li><code><a href="./RubyXL/CT_RelativeOffsetEffect.html">CT_RelativeOffsetEffect</a></code></li><li><code><a href="./RubyXL/CT_RelativeRect.html">CT_RelativeRect</a></code></li><li><code><a href="./RubyXL/CT_SRgbColor.html">CT_SRgbColor</a></code></li><li><code><a href="./RubyXL/CT_ScRgbColor.html">CT_ScRgbColor</a></code></li><li><code><a href="./RubyXL/CT_Scene3D.html">CT_Scene3D</a></code></li><li><code><a href="./RubyXL/CT_SchemeColor.html">CT_SchemeColor</a></code></li><li><code><a href="./RubyXL/CT_Shape3D.html">CT_Shape3D</a></code></li><li><code><a href="./RubyXL/CT_ShapeStyle.html">CT_ShapeStyle</a></code></li><li><code><a href="./RubyXL/CT_SoftEdgesEffect.html">CT_SoftEdgesEffect</a></code></li><li><code><a href="./RubyXL/CT_SphereCoords.html">CT_SphereCoords</a></code></li><li><code><a href="./RubyXL/CT_StretchInfoProperties.html">CT_StretchInfoProperties</a></code></li><li><code><a href="./RubyXL/CT_StyleMatrix.html">CT_StyleMatrix</a></code></li><li><code><a href="./RubyXL/CT_StyleMatrixReference.html">CT_StyleMatrixReference</a></code></li><li><code><a href="./RubyXL/CT_SupplementalFont.html">CT_SupplementalFont</a></code></li><li><code><a href="./RubyXL/CT_SystemColor.html">CT_SystemColor</a></code></li><li><code><a href="./RubyXL/CT_TextAutonumberBullet.html">CT_TextAutonumberBullet</a></code></li><li><code><a href="./RubyXL/CT_TextBlipBullet.html">CT_TextBlipBullet</a></code></li><li><code><a href="./RubyXL/CT_TextCharBullet.html">CT_TextCharBullet</a></code></li><li><code><a href="./RubyXL/CT_TextCharacterProperties.html">CT_TextCharacterProperties</a></code></li><li><code><a href="./RubyXL/CT_TextFont.html">CT_TextFont</a></code></li><li><code><a href="./RubyXL/CT_TextListStyle.html">CT_TextListStyle</a></code></li><li><code><a href="./RubyXL/CT_TextNormalAutofit.html">CT_TextNormalAutofit</a></code></li><li><code><a href="./RubyXL/CT_TextParagraphProperties.html">CT_TextParagraphProperties</a></code></li><li><code><a href="./RubyXL/CT_TextSpacing.html">CT_TextSpacing</a></code></li><li><code><a href="./RubyXL/CT_TextTabStop.html">CT_TextTabStop</a></code></li><li><code><a href="./RubyXL/CT_TextTabStopList.html">CT_TextTabStopList</a></code></li><li><code><a href="./RubyXL/CT_TileInfoProperties.html">CT_TileInfoProperties</a></code></li><li><code><a href="./RubyXL/CT_TintEffect.html">CT_TintEffect</a></code></li><li><code><a href="./RubyXL/CT_Transform2D.html">CT_Transform2D</a></code></li><li><code><a href="./RubyXL/CT_TransformEffect.html">CT_TransformEffect</a></code></li><li><code><a href="./RubyXL/CT_Vector3D.html">CT_Vector3D</a></code></li><li><code><a href="./RubyXL/CT_XYAdjustHandle.html">CT_XYAdjustHandle</a></code></li><li><code><a href="./RubyXL/CalculationChain.html">CalculationChain</a></code></li><li><code><a href="./RubyXL/CalculationChainCell.html">CalculationChainCell</a></code></li><li><code><a href="./RubyXL/CalculationProperties.html">CalculationProperties</a></code></li><li><code><a href="./RubyXL/Cell.html">Cell</a></code></li><li><code><a href="./RubyXL/CellConvenienceMethods.html">CellConvenienceMethods</a></code></li><li><code><a href="./RubyXL/CellExt.html">CellExt</a></code></li><li><code><a href="./RubyXL/CellSmartTag.html">CellSmartTag</a></code></li><li><code><a href="./RubyXL/CellSmartTagProperty.html">CellSmartTagProperty</a></code></li><li><code><a href="./RubyXL/CellSmartTags.html">CellSmartTags</a></code></li><li><code><a href="./RubyXL/CellStyle.html">CellStyle</a></code></li><li><code><a href="./RubyXL/CellStyleXFs.html">CellStyleXFs</a></code></li><li><code><a href="./RubyXL/CellStyles.html">CellStyles</a></code></li><li><code><a href="./RubyXL/CellValue.html">CellValue</a></code></li><li><code><a href="./RubyXL/CellWatch.html">CellWatch</a></code></li><li><code><a href="./RubyXL/CellWatches.html">CellWatches</a></code></li><li><code><a href="./RubyXL/CellXFs.html">CellXFs</a></code></li><li><code><a href="./RubyXL/ChartColorsFile.html">ChartColorsFile</a></code></li><li><code><a href="./RubyXL/ChartFile.html">ChartFile</a></code></li><li><code><a href="./RubyXL/ChartStyleFile.html">ChartStyleFile</a></code></li><li><code><a href="./RubyXL/ChartUserShapesFile.html">ChartUserShapesFile</a></code></li><li><code><a href="./RubyXL/Chartsheet.html">Chartsheet</a></code></li><li><code><a href="./RubyXL/ChartsheetPageSetup.html">ChartsheetPageSetup</a></code></li><li><code><a href="./RubyXL/ChartsheetProperties.html">ChartsheetProperties</a></code></li><li><code><a href="./RubyXL/ChartsheetProtection.html">ChartsheetProtection</a></code></li><li><code><a href="./RubyXL/ChartsheetView.html">ChartsheetView</a></code></li><li><code><a href="./RubyXL/ChartsheetViews.html">ChartsheetViews</a></code></li><li><code><a href="./RubyXL/Color.html">Color</a></code></li><li><details><summary><code><a href="./RubyXL/ColorConvenienceClasses.html">ColorConvenienceClasses</a></code></summary><ul class="link-list nav-list"><li><code><a href="./RubyXL/ColorConvenienceClasses/HlsColor.html">HlsColor</a></code></li><li><code><a href="./RubyXL/ColorConvenienceClasses/RgbColor.html">RgbColor</a></code></li></ul></details></li><li><code><a href="./RubyXL/ColorConvenienceMethods.html">ColorConvenienceMethods</a></code></li><li><code><a href="./RubyXL/ColorFilter.html">ColorFilter</a></code></li><li><code><a href="./RubyXL/ColorScale.html">ColorScale</a></code></li><li><code><a href="./RubyXL/ColorSet.html">ColorSet</a></code></li><li><code><a href="./RubyXL/Colors.html">Colors</a></code></li><li><code><a href="./RubyXL/ColumnRange.html">ColumnRange</a></code></li><li><code><a href="./RubyXL/ColumnRanges.html">ColumnRanges</a></code></li><li><code><a href="./RubyXL/Comment.html">Comment</a></code></li><li><code><a href="./RubyXL/CommentList.html">CommentList</a></code></li><li><code><a href="./RubyXL/CommentsFile.html">CommentsFile</a></code></li><li><code><a href="./RubyXL/ConditionalFormatValue.html">ConditionalFormatValue</a></code></li><li><code><a href="./RubyXL/ConditionalFormatting.html">ConditionalFormatting</a></code></li><li><code><a href="./RubyXL/ConditionalFormattingRule.html">ConditionalFormattingRule</a></code></li><li><code><a href="./RubyXL/Connection.html">Connection</a></code></li><li><code><a href="./RubyXL/ConnectionTable.html">ConnectionTable</a></code></li><li><code><a href="./RubyXL/ConnectionTables.html">ConnectionTables</a></code></li><li><code><a href="./RubyXL/ConnectionTextField.html">ConnectionTextField</a></code></li><li><code><a href="./RubyXL/ConnectionTextFields.html">ConnectionTextFields</a></code></li><li><code><a href="./RubyXL/Connections.html">Connections</a></code></li><li><code><a href="./RubyXL/ContentTypeDefault.html">ContentTypeDefault</a></code></li><li><code><a href="./RubyXL/ContentTypeOverride.html">ContentTypeOverride</a></code></li><li><code><a href="./RubyXL/ContentTypes.html">ContentTypes</a></code></li><li><code><a href="./RubyXL/ControlPropertiesFile.html">ControlPropertiesFile</a></code></li><li><code><a href="./RubyXL/CorePropertiesFile.html">CorePropertiesFile</a></code></li><li><code><a href="./RubyXL/CustomColor.html">CustomColor</a></code></li><li><code><a href="./RubyXL/CustomColorList.html">CustomColorList</a></code></li><li><code><a href="./RubyXL/CustomFilter.html">CustomFilter</a></code></li><li><code><a href="./RubyXL/CustomFilters.html">CustomFilters</a></code></li><li><code><a href="./RubyXL/CustomGeometry.html">CustomGeometry</a></code></li><li><code><a href="./RubyXL/CustomProperties.html">CustomProperties</a></code></li><li><code><a href="./RubyXL/CustomPropertiesFile.html">CustomPropertiesFile</a></code></li><li><code><a href="./RubyXL/CustomProperty.html">CustomProperty</a></code></li><li><code><a href="./RubyXL/CustomPropertyFile.html">CustomPropertyFile</a></code></li><li><code><a href="./RubyXL/CustomSheetView.html">CustomSheetView</a></code></li><li><code><a href="./RubyXL/CustomSheetViews.html">CustomSheetViews</a></code></li><li><code><a href="./RubyXL/CustomWorkbookView.html">CustomWorkbookView</a></code></li><li><code><a href="./RubyXL/CustomWorkbookViews.html">CustomWorkbookViews</a></code></li><li><code><a href="./RubyXL/CustomXMLFile.html">CustomXMLFile</a></code></li><li><code><a href="./RubyXL/DXF.html">DXF</a></code></li><li><code><a href="./RubyXL/DXFs.html">DXFs</a></code></li><li><code><a href="./RubyXL/DataBar.html">DataBar</a></code></li><li><code><a href="./RubyXL/DataConsolidate.html">DataConsolidate</a></code></li><li><code><a href="./RubyXL/DataConsolidationReference.html">DataConsolidationReference</a></code></li><li><code><a href="./RubyXL/DataConsolidationReferences.html">DataConsolidationReferences</a></code></li><li><code><a href="./RubyXL/DataType.html">DataType</a></code></li><li><code><a href="./RubyXL/DataValidation.html">DataValidation</a></code></li><li><code><a href="./RubyXL/DataValidations.html">DataValidations</a></code></li><li><code><a href="./RubyXL/DateGroupItem.html">DateGroupItem</a></code></li><li><code><a href="./RubyXL/DefinedName.html">DefinedName</a></code></li><li><code><a href="./RubyXL/DefinedNameExt.html">DefinedNameExt</a></code></li><li><code><a href="./RubyXL/DefinedNames.html">DefinedNames</a></code></li><li><code><a href="./RubyXL/DefinedNamesExt.html">DefinedNamesExt</a></code></li><li><code><a href="./RubyXL/DocumentPropertiesFile.html">DocumentPropertiesFile</a></code></li><li><code><a href="./RubyXL/DrawingFile.html">DrawingFile</a></code></li><li><code><a href="./RubyXL/DynamicFilter.html">DynamicFilter</a></code></li><li><code><a href="./RubyXL/EmbeddedControl.html">EmbeddedControl</a></code></li><li><code><a href="./RubyXL/EmbeddedControls.html">EmbeddedControls</a></code></li><li><code><a href="./RubyXL/Extension.html">Extension</a></code></li><li><code><a href="./RubyXL/ExtensionStorageArea.html">ExtensionStorageArea</a></code></li><li><code><a href="./RubyXL/Extents.html">Extents</a></code></li><li><code><a href="./RubyXL/ExternalBook.html">ExternalBook</a></code></li><li><code><a href="./RubyXL/ExternalLinksFile.html">ExternalLinksFile</a></code></li><li><code><a href="./RubyXL/ExternalReference.html">ExternalReference</a></code></li><li><code><a href="./RubyXL/ExternalReferences.html">ExternalReferences</a></code></li><li><code><a href="./RubyXL/ExtraColorSchemeList.html">ExtraColorSchemeList</a></code></li><li><code><a href="./RubyXL/FieldItem.html">FieldItem</a></code></li><li><code><a href="./RubyXL/FileRecoveryProperties.html">FileRecoveryProperties</a></code></li><li><code><a href="./RubyXL/FileSharing.html">FileSharing</a></code></li><li><code><a href="./RubyXL/FileVersion.html">FileVersion</a></code></li><li><code><a href="./RubyXL/Fill.html">Fill</a></code></li><li><code><a href="./RubyXL/Fills.html">Fills</a></code></li><li><code><a href="./RubyXL/FilterContainer.html">FilterContainer</a></code></li><li><code><a href="./RubyXL/FloatNode.html">FloatNode</a></code></li><li><code><a href="./RubyXL/FloatValue.html">FloatValue</a></code></li><li><code><a href="./RubyXL/Font.html">Font</a></code></li><li><code><a href="./RubyXL/FontConvenienceMethods.html">FontConvenienceMethods</a></code></li><li><code><a href="./RubyXL/FontScheme.html">FontScheme</a></code></li><li><code><a href="./RubyXL/Fonts.html">Fonts</a></code></li><li><code><a href="./RubyXL/Formula.html">Formula</a></code></li><li><code><a href="./RubyXL/FunctionGroup.html">FunctionGroup</a></code></li><li><code><a href="./RubyXL/FunctionGroups.html">FunctionGroups</a></code></li><li><code><a href="./RubyXL/GenericStorageObject.html">GenericStorageObject</a></code></li><li><code><a href="./RubyXL/GradientFill.html">GradientFill</a></code></li><li><code><a href="./RubyXL/HeaderFooterSettings.html">HeaderFooterSettings</a></code></li><li><code><a href="./RubyXL/Hyperlink.html">Hyperlink</a></code></li><li><code><a href="./RubyXL/HyperlinkRelFile.html">HyperlinkRelFile</a></code></li><li><code><a href="./RubyXL/Hyperlinks.html">Hyperlinks</a></code></li><li><code><a href="./RubyXL/IconFilter.html">IconFilter</a></code></li><li><code><a href="./RubyXL/IconSet.html">IconSet</a></code></li><li><code><a href="./RubyXL/IgnoredError.html">IgnoredError</a></code></li><li><code><a href="./RubyXL/IgnoredErrors.html">IgnoredErrors</a></code></li><li><code><a href="./RubyXL/IndexedColors.html">IndexedColors</a></code></li><li><code><a href="./RubyXL/InputCells.html">InputCells</a></code></li><li><code><a href="./RubyXL/IntegerNode.html">IntegerNode</a></code></li><li><code><a href="./RubyXL/IntegerValue.html">IntegerValue</a></code></li><li><code><a href="./RubyXL/LegacyCell.html">LegacyCell</a></code></li><li><code><a href="./RubyXL/LegacyWorksheet.html">LegacyWorksheet</a></code></li><li><code><a href="./RubyXL/MRUColors.html">MRUColors</a></code></li><li><code><a href="./RubyXL/MacrosFile.html">MacrosFile</a></code></li><li><code><a href="./RubyXL/MergedCell.html">MergedCell</a></code></li><li><code><a href="./RubyXL/MergedCells.html">MergedCells</a></code></li><li><code><a href="./RubyXL/NumFmt.html">NumFmt</a></code></li><li><code><a href="./RubyXL/NumberFormat.html">NumberFormat</a></code></li><li><code><a href="./RubyXL/NumberFormats.html">NumberFormats</a></code></li><li><code><a href="./RubyXL/OLEObject.html">OLEObject</a></code></li><li><code><a href="./RubyXL/OLEObjectFile.html">OLEObjectFile</a></code></li><li><code><a href="./RubyXL/OLEObjects.html">OLEObjects</a></code></li><li><code><a href="./RubyXL/OLESize.html">OLESize</a></code></li><li><code><a href="./RubyXL/OOXMLContainerObject.html">OOXMLContainerObject</a></code></li><li><code><a href="./RubyXL/OOXMLIgnored.html">OOXMLIgnored</a></code></li><li><code><a href="./RubyXL/OOXMLObject.html">OOXMLObject</a></code></li><li><code><a href="./RubyXL/OOXMLObjectClassMethods.html">OOXMLObjectClassMethods</a></code></li><li><code><a href="./RubyXL/OOXMLObjectInstanceMethods.html">OOXMLObjectInstanceMethods</a></code></li><li><code><a href="./RubyXL/OOXMLRelationshipsFile.html">OOXMLRelationshipsFile</a></code></li><li><code><a href="./RubyXL/OOXMLTopLevelObject.html">OOXMLTopLevelObject</a></code></li><li><code><a href="./RubyXL/OdbcOleDbProperties.html">OdbcOleDbProperties</a></code></li><li><code><a href="./RubyXL/Offset.html">Offset</a></code></li><li><code><a href="./RubyXL/OlapProperties.html">OlapProperties</a></code></li><li><code><a href="./RubyXL/OleItem.html">OleItem</a></code></li><li><code><a href="./RubyXL/OleItems.html">OleItems</a></code></li><li><code><a href="./RubyXL/OleLink.html">OleLink</a></code></li><li><code><a href="./RubyXL/OutlineProperties.html">OutlineProperties</a></code></li><li><code><a href="./RubyXL/PageMargins.html">PageMargins</a></code></li><li><code><a href="./RubyXL/PageSetup.html">PageSetup</a></code></li><li><code><a href="./RubyXL/PageSetupProperties.html">PageSetupProperties</a></code></li><li><code><a href="./RubyXL/Pane.html">Pane</a></code></li><li><code><a href="./RubyXL/Parser.html">Parser</a></code></li><li><code><a href="./RubyXL/PatternFill.html">PatternFill</a></code></li><li><code><a href="./RubyXL/PersonMetadata.html">PersonMetadata</a></code></li><li><code><a href="./RubyXL/PhoneticProperties.html">PhoneticProperties</a></code></li><li><code><a href="./RubyXL/PhoneticRun.html">PhoneticRun</a></code></li><li><code><a href="./RubyXL/PivotArea.html">PivotArea</a></code></li><li><code><a href="./RubyXL/PivotCache.html">PivotCache</a></code></li><li><code><a href="./RubyXL/PivotCacheDefinitionFile.html">PivotCacheDefinitionFile</a></code></li><li><code><a href="./RubyXL/PivotCacheRecordsFile.html">PivotCacheRecordsFile</a></code></li><li><code><a href="./RubyXL/PivotCaches.html">PivotCaches</a></code></li><li><code><a href="./RubyXL/PivotReference.html">PivotReference</a></code></li><li><code><a href="./RubyXL/PivotReferences.html">PivotReferences</a></code></li><li><code><a href="./RubyXL/PivotTableFile.html">PivotTableFile</a></code></li><li><code><a href="./RubyXL/PivotTableSelection.html">PivotTableSelection</a></code></li><li><code><a href="./RubyXL/PresetGeometry.html">PresetGeometry</a></code></li><li><code><a href="./RubyXL/PrintOptions.html">PrintOptions</a></code></li><li><code><a href="./RubyXL/PrinterSettingsFile.html">PrinterSettingsFile</a></code></li><li><code><a href="./RubyXL/ProtectedRange.html">ProtectedRange</a></code></li><li><code><a href="./RubyXL/ProtectedRanges.html">ProtectedRanges</a></code></li><li><code><a href="./RubyXL/Protection.html">Protection</a></code></li><li><code><a href="./RubyXL/QueryParameter.html">QueryParameter</a></code></li><li><code><a href="./RubyXL/QueryParameters.html">QueryParameters</a></code></li><li><code><a href="./RubyXL/QueryTable.html">QueryTable</a></code></li><li><code><a href="./RubyXL/QueryTableDeletedField.html">QueryTableDeletedField</a></code></li><li><code><a href="./RubyXL/QueryTableDeletedFields.html">QueryTableDeletedFields</a></code></li><li><code><a href="./RubyXL/QueryTableField.html">QueryTableField</a></code></li><li><code><a href="./RubyXL/QueryTableFields.html">QueryTableFields</a></code></li><li><code><a href="./RubyXL/QueryTableRefresh.html">QueryTableRefresh</a></code></li><li><code><a href="./RubyXL/RID.html">RID</a></code></li><li><code><a href="./RubyXL/RawOOXML.html">RawOOXML</a></code></li><li><code><a href="./RubyXL/Reference.html">Reference</a></code></li><li><code><a href="./RubyXL/Relationship.html">Relationship</a></code></li><li><details><summary><code><a href="./RubyXL/RelationshipSupport.html">RelationshipSupport</a></code></summary><ul class="link-list nav-list"><li><code><a href="./RubyXL/RelationshipSupport/ClassMehods.html">ClassMehods</a></code></li></ul></details></li><li><code><a href="./RubyXL/RevisionPointer.html">RevisionPointer</a></code></li><li><code><a href="./RubyXL/RichText.html">RichText</a></code></li><li><code><a href="./RubyXL/RichTextRun.html">RichTextRun</a></code></li><li><code><a href="./RubyXL/Row.html">Row</a></code></li><li><code><a href="./RubyXL/RowExt.html">RowExt</a></code></li><li><code><a href="./RubyXL/RunProperties.html">RunProperties</a></code></li><li><code><a href="./RubyXL/Scenario.html">Scenario</a></code></li><li><code><a href="./RubyXL/Scenarios.html">Scenarios</a></code></li><li><code><a href="./RubyXL/Selection.html">Selection</a></code></li><li><code><a href="./RubyXL/ShapeGuide.html">ShapeGuide</a></code></li><li><code><a href="./RubyXL/ShapeTextRectangle.html">ShapeTextRectangle</a></code></li><li><code><a href="./RubyXL/SharedStringsTable.html">SharedStringsTable</a></code></li><li><code><a href="./RubyXL/Sheet.html">Sheet</a></code></li><li><code><a href="./RubyXL/SheetCalculationProperties.html">SheetCalculationProperties</a></code></li><li><code><a href="./RubyXL/SheetData.html">SheetData</a></code></li><li><code><a href="./RubyXL/SheetDataExt.html">SheetDataExt</a></code></li><li><code><a href="./RubyXL/SheetDataSet.html">SheetDataSet</a></code></li><li><code><a href="./RubyXL/SheetMetadata.html">SheetMetadata</a></code></li><li><code><a href="./RubyXL/SheetName.html">SheetName</a></code></li><li><code><a href="./RubyXL/SheetNames.html">SheetNames</a></code></li><li><code><a href="./RubyXL/Sheets.html">Sheets</a></code></li><li><code><a href="./RubyXL/SlicerCacheFile.html">SlicerCacheFile</a></code></li><li><code><a href="./RubyXL/SlicerFile.html">SlicerFile</a></code></li><li><code><a href="./RubyXL/SmartTagProperties.html">SmartTagProperties</a></code></li><li><code><a href="./RubyXL/SmartTagType.html">SmartTagType</a></code></li><li><code><a href="./RubyXL/SmartTagTypes.html">SmartTagTypes</a></code></li><li><code><a href="./RubyXL/SmartTags.html">SmartTags</a></code></li><li><code><a href="./RubyXL/SortCondition.html">SortCondition</a></code></li><li><code><a href="./RubyXL/SortState.html">SortState</a></code></li><li><code><a href="./RubyXL/Sqref.html">Sqref</a></code></li><li><code><a href="./RubyXL/Stop.html">Stop</a></code></li><li><code><a href="./RubyXL/StringNode.html">StringNode</a></code></li><li><code><a href="./RubyXL/StringNodeW3C.html">StringNodeW3C</a></code></li><li><code><a href="./RubyXL/StringValue.html">StringValue</a></code></li><li><code><a href="./RubyXL/Stylesheet.html">Stylesheet</a></code></li><li><code><a href="./RubyXL/TableFile.html">TableFile</a></code></li><li><code><a href="./RubyXL/TableParts.html">TableParts</a></code></li><li><code><a href="./RubyXL/TableStyle.html">TableStyle</a></code></li><li><code><a href="./RubyXL/TableStyles.html">TableStyles</a></code></li><li><code><a href="./RubyXL/Text.html">Text</a></code></li><li><code><a href="./RubyXL/TextImportSettings.html">TextImportSettings</a></code></li><li><code><a href="./RubyXL/Theme.html">Theme</a></code></li><li><code><a href="./RubyXL/ThemeElements.html">ThemeElements</a></code></li><li><code><a href="./RubyXL/ThumbnailFile.html">ThumbnailFile</a></code></li><li><code><a href="./RubyXL/Top10.html">Top10</a></code></li><li><code><a href="./RubyXL/VMLDrawingFile.html">VMLDrawingFile</a></code></li><li><code><a href="./RubyXL/Variant.html">Variant</a></code></li><li><code><a href="./RubyXL/Vector.html">Vector</a></code></li><li><code><a href="./RubyXL/VectorValue.html">VectorValue</a></code></li><li><code><a href="./RubyXL/VisualProperties.html">VisualProperties</a></code></li><li><code><a href="./RubyXL/WebPublishObject.html">WebPublishObject</a></code></li><li><code><a href="./RubyXL/WebPublishObjects.html">WebPublishObjects</a></code></li><li><code><a href="./RubyXL/WebPublishingItem.html">WebPublishingItem</a></code></li><li><code><a href="./RubyXL/WebPublishingItems.html">WebPublishingItems</a></code></li><li><code><a href="./RubyXL/WebPublishingProperties.html">WebPublishingProperties</a></code></li><li><code><a href="./RubyXL/WebQueryProperties.html">WebQueryProperties</a></code></li><li><code><a href="./RubyXL/Workbook.html">Workbook</a></code></li><li><code><a href="./RubyXL/WorkbookConvenienceMethods.html">WorkbookConvenienceMethods</a></code></li><li><code><a href="./RubyXL/WorkbookProperties.html">WorkbookProperties</a></code></li><li><code><a href="./RubyXL/WorkbookProtection.html">WorkbookProtection</a></code></li><li><code><a href="./RubyXL/WorkbookRoot.html">WorkbookRoot</a></code></li><li><code><a href="./RubyXL/WorkbookView.html">WorkbookView</a></code></li><li><code><a href="./RubyXL/WorkbookViews.html">WorkbookViews</a></code></li><li><code><a href="./RubyXL/Worksheet.html">Worksheet</a></code></li><li><code><a href="./RubyXL/WorksheetConvenienceMethods.html">WorksheetConvenienceMethods</a></code></li><li><code><a href="./RubyXL/WorksheetDimensions.html">WorksheetDimensions</a></code></li><li><code><a href="./RubyXL/WorksheetFormatProperties.html">WorksheetFormatProperties</a></code></li><li><code><a href="./RubyXL/WorksheetProperties.html">WorksheetProperties</a></code></li><li><code><a href="./RubyXL/WorksheetProtection.html">WorksheetProtection</a></code></li><li><code><a href="./RubyXL/WorksheetView.html">WorksheetView</a></code></li><li><code><a href="./RubyXL/WorksheetViews.html">WorksheetViews</a></code></li><li><code><a href="./RubyXL/XF.html">XF</a></code></li></ul></details></li></ul>
|
|
423
|
+
</details>
|
|
424
|
+
</div>
|
|
425
|
+
|
|
119
426
|
</nav>
|
|
120
427
|
|
|
121
428
|
<main role="main" aria-label="Page README.rdoc">
|
|
122
429
|
|
|
123
|
-
<
|
|
430
|
+
<span id="label-rubyXL" class="legacy-anchor"></span>
|
|
431
|
+
<h1 id="rubyxl"><a href="#rubyxl">rubyXL</a></h1>
|
|
124
432
|
|
|
125
|
-
<p><a href="http://badge.fury.io/rb/rubyXL"><img src="https://badge.fury.io/rb/rubyXL.svg"
|
|
433
|
+
<p><a href="http://badge.fury.io/rb/rubyXL"><img src="https://badge.fury.io/rb/rubyXL.svg"></a> <a href="https://circleci.com/gh/weshatheleopard/rubyXL"><img src="https://circleci.com/gh/weshatheleopard/rubyXL.svg?style=svg"></a></p>
|
|
126
434
|
|
|
127
435
|
<p>This gem supports operating on <code>xlsx</code> files (Open XML format). While it is capable of properly parsing the entire OOXML structure, its current main emphasis is on reading files produced by MS Excel, making minor modifications to them and saving them to be opened again, while preserving as much of the structure as possible.</p>
|
|
128
436
|
|
|
129
437
|
<p>Please note that proprietary binary <code>xls</code> format is <strong>not</strong> supported by this gem. If you need to parse those files, try <a href="https://github.com/zdavatz/spreadsheet">spreadsheet</a> gem.</p>
|
|
130
438
|
|
|
131
|
-
<
|
|
439
|
+
<span id="label-To+Install-3A" class="legacy-anchor"></span>
|
|
440
|
+
<h2 id="to-install"><a href="#to-install">To Install:</a></h2>
|
|
132
441
|
|
|
133
442
|
<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">rubyXL</span>
|
|
134
443
|
</pre>
|
|
135
444
|
|
|
136
|
-
<
|
|
445
|
+
<span id="label-To+Use-3A" class="legacy-anchor"></span>
|
|
446
|
+
<h2 id="to-use"><a href="#to-use">To Use:</a></h2>
|
|
137
447
|
|
|
138
448
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rubyXL'</span> <span class="ruby-comment"># Assuming rubygems is already required</span>
|
|
139
449
|
</pre>
|
|
140
450
|
|
|
141
|
-
<
|
|
451
|
+
<span id="label-Convenience+methods" class="legacy-anchor"></span>
|
|
452
|
+
<h3 id="convenience-methods"><a href="#convenience-methods">Convenience methods</a></h3>
|
|
142
453
|
|
|
143
454
|
<p>Starting with version 3.4.0, the main data structure has been separated from the convenience methods that provide access to individual features of the <code>xlsx</code> format, in order to decrease the memory footprint. If you intend to use these features, you will need to additionally include the respective files:</p>
|
|
144
455
|
|
|
@@ -154,26 +465,31 @@
|
|
|
154
465
|
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rubyXL/convenience_methods'</span>
|
|
155
466
|
</pre>
|
|
156
467
|
|
|
157
|
-
<
|
|
468
|
+
<span id="label-Parsing+an+existing+workbook" class="legacy-anchor"></span>
|
|
469
|
+
<h3 id="parsing-an-existing-workbook"><a href="#parsing-an-existing-workbook">Parsing an existing workbook</a></h3>
|
|
158
470
|
|
|
159
471
|
<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Parser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">"path/to/Excel/file.xlsx"</span>)
|
|
160
472
|
</pre>
|
|
161
473
|
|
|
162
|
-
<
|
|
474
|
+
<span id="label-Creating+a+new+Workbook" class="legacy-anchor"></span>
|
|
475
|
+
<h3 id="creating-a-new-workbook"><a href="#creating-a-new-workbook">Creating a new Workbook</a></h3>
|
|
163
476
|
|
|
164
477
|
<pre class="ruby"><span class="ruby-identifier">workbook</span> = <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>
|
|
165
478
|
</pre>
|
|
166
479
|
|
|
167
|
-
<
|
|
480
|
+
<span id="label-Accessing" class="legacy-anchor"></span>
|
|
481
|
+
<h3 id="accessing"><a href="#accessing">Accessing</a></h3>
|
|
168
482
|
|
|
169
|
-
<
|
|
483
|
+
<span id="label-Accessing+a+Worksheet" class="legacy-anchor"></span>
|
|
484
|
+
<h4 id="accessing-a-worksheet"><a href="#accessing-a-worksheet">Accessing a Worksheet</a></h4>
|
|
170
485
|
|
|
171
486
|
<pre class="ruby"><span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">worksheets</span>[<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns first worksheet</span>
|
|
172
487
|
<span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns first worksheet</span>
|
|
173
488
|
<span class="ruby-identifier">workbook</span>[<span class="ruby-string">'Sheet1'</span>] <span class="ruby-comment"># Finds and returns worksheet titled "Sheet1". Note that sheet names in Excel are limited to 31 character.</span>
|
|
174
489
|
</pre>
|
|
175
490
|
|
|
176
|
-
<
|
|
491
|
+
<span id="label-Accessing+a+Row+-28Array+of+Cells-29" class="legacy-anchor"></span>
|
|
492
|
+
<h4 id="accessing-a-row-array-of-cells"><a href="#accessing-a-row-array-of-cells">Accessing a Row (Array of Cells)</a></h4>
|
|
177
493
|
|
|
178
494
|
<p>Please note that worksheet is a <em>sparse</em> array of rows. Your code <strong>must</strong> expect that any row it plucks from the array may be <code>nil</code>.</p>
|
|
179
495
|
|
|
@@ -182,7 +498,8 @@
|
|
|
182
498
|
<span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>] <span class="ruby-comment"># Returns first row of the worksheet</span>
|
|
183
499
|
</pre>
|
|
184
500
|
|
|
185
|
-
<
|
|
501
|
+
<span id="label-Accessing+a+Cell+object" class="legacy-anchor"></span>
|
|
502
|
+
<h4 id="accessing-a-cell-object"><a href="#accessing-a-cell-object">Accessing a Cell object</a></h4>
|
|
186
503
|
|
|
187
504
|
<p>Please note that row is a <em>sparse</em> array of cells. Your code <strong>must</strong> expect that any cell it plucks from the array may be <code>nil</code>.</p>
|
|
188
505
|
|
|
@@ -200,7 +517,8 @@
|
|
|
200
517
|
<pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">cell_at</span>(<span class="ruby-string">'B11'</span>)
|
|
201
518
|
</pre>
|
|
202
519
|
|
|
203
|
-
<
|
|
520
|
+
<span id="label-Wrappers+for+accessing+Cell+properties" class="legacy-anchor"></span>
|
|
521
|
+
<h4 id="wrappers-for-accessing-cell-properties"><a href="#wrappers-for-accessing-cell-properties">Wrappers for accessing Cell properties</a></h4>
|
|
204
522
|
|
|
205
523
|
<pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">workbook</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
|
|
206
524
|
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">is_struckthrough</span> <span class="ruby-comment"># Returns +true+ if the cell is struckthrough, other boolean properties have same syntax</span>
|
|
@@ -215,7 +533,8 @@
|
|
|
215
533
|
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">text_rotation</span>
|
|
216
534
|
</pre>
|
|
217
535
|
|
|
218
|
-
<
|
|
536
|
+
<span id="label-Wrappers+for+accessing+Row+properties+" class="legacy-anchor"></span>
|
|
537
|
+
<h4 id="wrappers-for-accessing-row-properties-"><a href="#wrappers-for-accessing-row-properties-">Wrappers for accessing Row properties </a></h4>
|
|
219
538
|
|
|
220
539
|
<p>Please note: these methods are being phased out in favor of the OOXML object model.</p>
|
|
221
540
|
|
|
@@ -232,7 +551,8 @@
|
|
|
232
551
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_row_border_color</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:right</span>)
|
|
233
552
|
</pre>
|
|
234
553
|
|
|
235
|
-
<
|
|
554
|
+
<span id="label-Accessing+column+properties" class="legacy-anchor"></span>
|
|
555
|
+
<h4 id="accessing-column-properties"><a href="#accessing-column-properties">Accessing column properties</a></h4>
|
|
236
556
|
|
|
237
557
|
<p>Please note: these methods are being phased out in favor of the OOXML object model.</p>
|
|
238
558
|
|
|
@@ -249,59 +569,91 @@
|
|
|
249
569
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">get_column_border_color</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:right</span>)
|
|
250
570
|
</pre>
|
|
251
571
|
|
|
252
|
-
<
|
|
572
|
+
<span id="label-Modifying" class="legacy-anchor"></span>
|
|
573
|
+
<h3 id="modifying"><a href="#modifying">Modifying</a></h3>
|
|
253
574
|
|
|
254
|
-
<
|
|
575
|
+
<span id="label-Adding+Worksheets" class="legacy-anchor"></span>
|
|
576
|
+
<h4 id="adding-worksheets"><a href="#adding-worksheets">Adding Worksheets</a></h4>
|
|
255
577
|
|
|
256
578
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span> = <span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">add_worksheet</span>(<span class="ruby-string">'Sheet2'</span>)
|
|
257
579
|
</pre>
|
|
258
580
|
|
|
259
|
-
<
|
|
581
|
+
<span id="label-Renaming+Worksheets" class="legacy-anchor"></span>
|
|
582
|
+
<h4 id="renaming-worksheets"><a href="#renaming-worksheets">Renaming Worksheets</a></h4>
|
|
260
583
|
|
|
261
584
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_name</span> = <span class="ruby-string">'Cool New Name'</span> <span class="ruby-comment"># Note that sheet name is limited to 31 characters by Excel.</span>
|
|
262
585
|
</pre>
|
|
263
586
|
|
|
264
|
-
<
|
|
587
|
+
<span id="label-Adding+Cells" class="legacy-anchor"></span>
|
|
588
|
+
<h4 id="adding-cells"><a href="#adding-cells">Adding Cells</a></h4>
|
|
265
589
|
|
|
266
590
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">'A1'</span>) <span class="ruby-comment"># Sets cell A1 to string "A1"</span>
|
|
267
591
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-string">''</span>, <span class="ruby-string">'A1'</span>) <span class="ruby-comment"># Sets formula in the cell B1 to '=A1'</span>
|
|
268
592
|
</pre>
|
|
269
593
|
|
|
270
|
-
<
|
|
594
|
+
<span id="label-Changing+Cells" class="legacy-anchor"></span>
|
|
595
|
+
<h4 id="changing-cells"><a href="#changing-cells">Changing Cells</a></h4>
|
|
271
596
|
|
|
272
597
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_contents</span>(<span class="ruby-string">""</span>, <span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">formula</span>) <span class="ruby-comment"># Sets value of cell A1 to empty string, preserves formula</span>
|
|
598
|
+
|
|
599
|
+
<span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">add_shared_string</span>(<span class="ruby-string">'some text'</span>) <span class="ruby-comment"># Creates a new Shared String and adds it to the cell.</span>
|
|
600
|
+
<span class="ruby-comment"># Later, the same Shared String can be added to other cells.</span>
|
|
273
601
|
</pre>
|
|
274
602
|
|
|
275
|
-
<
|
|
603
|
+
<span id="label-Changing+Fonts" class="legacy-anchor"></span>
|
|
604
|
+
<h4 id="changing-fonts"><a href="#changing-fonts">Changing Fonts</a></h4>
|
|
276
605
|
|
|
277
606
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_font_bold</span>(<span class="ruby-keyword">true</span>) <span class="ruby-comment"># Makes A1 bold</span>
|
|
278
607
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_italics</span>(<span class="ruby-value">0</span>,<span class="ruby-keyword">true</span>) <span class="ruby-comment"># Makes first row italicized</span>
|
|
279
608
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_font_name</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'Courier'</span>) <span class="ruby-comment"># Makes first column have font Courier</span>
|
|
280
609
|
</pre>
|
|
281
610
|
|
|
282
|
-
<
|
|
611
|
+
<span id="label-Changing+Fills+++++" class="legacy-anchor"></span>
|
|
612
|
+
<h4 id="changing-fills-----"><a href="#changing-fills-----">Changing Fills </a></h4>
|
|
283
613
|
|
|
284
614
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_fill</span>(<span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets A1 to have fill #0ba53d</span>
|
|
285
615
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_fill</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets first row to have fill #0ba53d</span>
|
|
286
616
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_fill</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets first column to have fill #0ba53d</span>
|
|
287
617
|
</pre>
|
|
288
618
|
|
|
289
|
-
<
|
|
619
|
+
<span id="label-Changing+Borders" class="legacy-anchor"></span>
|
|
620
|
+
<h4 id="changing-borders"><a href="#changing-borders">Changing Borders</a></h4>
|
|
621
|
+
|
|
622
|
+
<span id="label-Border+Styles" class="legacy-anchor"></span>
|
|
623
|
+
<h5 id="border-styles"><a href="#border-styles">Border Styles</a></h5>
|
|
290
624
|
|
|
291
625
|
<pre class="ruby"><span class="ruby-comment"># Possible weights: hairline, thin, medium, thick</span>
|
|
292
626
|
<span class="ruby-comment"># Possible "directions": top, bottom, left, right, diagonal</span>
|
|
293
|
-
<span class="ruby-identifier">
|
|
294
|
-
<span class="ruby-identifier">
|
|
295
|
-
<span class="ruby-
|
|
627
|
+
<span class="ruby-identifier">cell</span> = <span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_cell</span>(<span class="ruby-value">1</span>, <span class="ruby-value">1</span>, <span class="ruby-string">'B2'</span>)
|
|
628
|
+
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_border</span>(<span class="ruby-value">:top</span>, <span class="ruby-string">'thin'</span>) <span class="ruby-comment"># Sets the cell to have a top, thin border</span>
|
|
629
|
+
<span class="ruby-comment"># Note that with diagonals, you have to specify which one of the diagonals (or both) you need.</span>
|
|
630
|
+
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_border</span>( <span class="ruby-value">:diagonal</span>, <span class="ruby-string">'thick'</span>, [ <span class="ruby-value">:diagonal_down</span> ]) <span class="ruby-comment"># Sets A1 to have a thin diagonal going from top left to bottom right</span>
|
|
631
|
+
<span class="ruby-comment"># You can turn on both diagonals, but then they both will share the same style and color:</span>
|
|
632
|
+
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_border</span>( <span class="ruby-value">:diagonal</span>, <span class="ruby-string">'thick'</span>, [ <span class="ruby-value">:diagonal_down</span>, <span class="ruby-value">:diagonal_up</span> ])
|
|
633
|
+
</pre>
|
|
634
|
+
|
|
635
|
+
<span id="label-Border+Colors" class="legacy-anchor"></span>
|
|
636
|
+
<h5 id="border-colors"><a href="#border-colors">Border Colors</a></h5>
|
|
637
|
+
|
|
638
|
+
<pre class="ruby"><span class="ruby-comment"># Make sure you set the border style first so there's something to color.</span>
|
|
639
|
+
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_border_color</span>(<span class="ruby-value">:top</span>, <span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets top border color to green</span>
|
|
640
|
+
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_border_color</span>(<span class="ruby-value">:diagonal</span>, <span class="ruby-string">'dd0000'</span>) <span class="ruby-comment"># Sets diaginal border color to red</span>
|
|
641
|
+
</pre>
|
|
296
642
|
|
|
297
|
-
<span class="
|
|
643
|
+
<span id="label-Changing+whole+row+or+column" class="legacy-anchor"></span>
|
|
644
|
+
<h5 id="changing-whole-row-or-column"><a href="#changing-whole-row-or-column">Changing whole row or column</a></h5>
|
|
645
|
+
|
|
646
|
+
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_border</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:left</span>, <span class="ruby-string">'hairline'</span>) <span class="ruby-comment"># Sets first row to have a left, hairline border</span>
|
|
647
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_border</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:diagonal</span>, <span class="ruby-string">'medium'</span>) <span class="ruby-comment"># Sets first column to have diagonal, medium border</span>
|
|
298
648
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_border_color</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:top</span>, <span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets first row to have a green top border</span>
|
|
299
649
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_border_color</span>(<span class="ruby-value">0</span>, <span class="ruby-value">:top</span>, <span class="ruby-string">'0ba53d'</span>) <span class="ruby-comment"># Sets first column to have a green top border</span>
|
|
300
650
|
</pre>
|
|
301
651
|
|
|
302
|
-
<
|
|
652
|
+
<span id="label-Changing+Alignment" class="legacy-anchor"></span>
|
|
653
|
+
<h4 id="changing-alignment"><a href="#changing-alignment">Changing Alignment</a></h4>
|
|
303
654
|
|
|
304
|
-
<
|
|
655
|
+
<span id="label-Horizontal" class="legacy-anchor"></span>
|
|
656
|
+
<h5 id="horizontal"><a href="#horizontal">Horizontal</a></h5>
|
|
305
657
|
|
|
306
658
|
<pre class="ruby"><span class="ruby-comment"># Possible alignments: center, distributed, justify, left, right</span>
|
|
307
659
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_horizontal_alignment</span>(<span class="ruby-string">'center'</span>) <span class="ruby-comment"># Sets A1 to be centered</span>
|
|
@@ -309,7 +661,8 @@
|
|
|
309
661
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_horizontal_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'right'</span>) <span class="ruby-comment"># Sets first column to be right-aligned</span>
|
|
310
662
|
</pre>
|
|
311
663
|
|
|
312
|
-
<
|
|
664
|
+
<span id="label-Vertical" class="legacy-anchor"></span>
|
|
665
|
+
<h5 id="vertical"><a href="#vertical">Vertical</a></h5>
|
|
313
666
|
|
|
314
667
|
<pre class="ruby"><span class="ruby-comment"># Possible alignments: bottom, center, distributed, top</span>
|
|
315
668
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_vertical_alignment</span>(<span class="ruby-string">'bottom'</span>) <span class="ruby-comment"># Sets A1 to be bottom aligned</span>
|
|
@@ -317,7 +670,8 @@
|
|
|
317
670
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_vertical_alignment</span>(<span class="ruby-value">0</span>, <span class="ruby-string">'top'</span>) <span class="ruby-comment"># Sets first column to be top aligned</span>
|
|
318
671
|
</pre>
|
|
319
672
|
|
|
320
|
-
<
|
|
673
|
+
<span id="label-Rotation" class="legacy-anchor"></span>
|
|
674
|
+
<h5 id="rotation"><a href="#rotation">Rotation</a></h5>
|
|
321
675
|
|
|
322
676
|
<pre class="ruby"><span class="ruby-comment"># Possible values:</span>
|
|
323
677
|
<span class="ruby-comment"># * 0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;</span>
|
|
@@ -327,22 +681,28 @@
|
|
|
327
681
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">sheet_data</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>].<span class="ruby-identifier">change_text_rotation</span>(<span class="ruby-value">90</span>) <span class="ruby-comment"># Sets A1 to be rotated by 90 degrees</span>
|
|
328
682
|
</pre>
|
|
329
683
|
|
|
330
|
-
<
|
|
684
|
+
<span id="label-Changing+Row+Height" class="legacy-anchor"></span>
|
|
685
|
+
<h4 id="changing-row-height"><a href="#changing-row-height">Changing Row Height</a></h4>
|
|
331
686
|
|
|
332
687
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_row_height</span>(<span class="ruby-value">0</span>, <span class="ruby-value">30</span>) <span class="ruby-comment"># Sets first row height to 30</span>
|
|
333
688
|
</pre>
|
|
334
689
|
|
|
335
|
-
<
|
|
690
|
+
<span id="label-Changing+Column+Width" class="legacy-anchor"></span>
|
|
691
|
+
<h4 id="changing-column-width"><a href="#changing-column-width">Changing Column Width</a></h4>
|
|
336
692
|
|
|
337
693
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">change_column_width</span>(<span class="ruby-value">0</span>, <span class="ruby-value">30</span>) <span class="ruby-comment"># Sets first column width to 30</span>
|
|
338
694
|
</pre>
|
|
339
695
|
|
|
340
|
-
<
|
|
696
|
+
<span id="label-Merging+Cells" class="legacy-anchor"></span>
|
|
697
|
+
<h4 id="merging-cells"><a href="#merging-cells">Merging Cells</a></h4>
|
|
341
698
|
|
|
342
|
-
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">merge_cells</span>(<span class="ruby-value">0</span>, <span class="ruby-value">
|
|
699
|
+
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">merge_cells</span>(<span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>) <span class="ruby-comment"># Merges B1:D3</span>
|
|
700
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">merge_cells</span>(<span class="ruby-string">'A2:C4'</span>) <span class="ruby-comment"># Merges A2:C4</span>
|
|
701
|
+
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">merge_cells</span>(<span class="ruby-value">row_from:</span> <span class="ruby-value">0</span>, <span class="ruby-value">row_to:</span> <span class="ruby-value">1</span>, <span class="ruby-value">col_from:</span> <span class="ruby-value">2</span>, <span class="ruby-value">col_to:</span> <span class="ruby-value">3</span>) <span class="ruby-comment"># Merges C1:D2</span>
|
|
343
702
|
</pre>
|
|
344
703
|
|
|
345
|
-
<
|
|
704
|
+
<span id="label-Insert+Row" class="legacy-anchor"></span>
|
|
705
|
+
<h4 id="insert-row"><a href="#insert-row">Insert Row</a></h4>
|
|
346
706
|
|
|
347
707
|
<p>This method will insert a row at specified index, pushing all rows below it down. It also copies styles from row above.</p>
|
|
348
708
|
|
|
@@ -351,7 +711,8 @@
|
|
|
351
711
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_row</span>(<span class="ruby-value">1</span>)
|
|
352
712
|
</pre>
|
|
353
713
|
|
|
354
|
-
<
|
|
714
|
+
<span id="label-Insert+Column" class="legacy-anchor"></span>
|
|
715
|
+
<h4 id="insert-column"><a href="#insert-column">Insert Column</a></h4>
|
|
355
716
|
|
|
356
717
|
<p>This method will insert a column at specified index, pushing all columns to the right of it one to the right. It also copies styles from column to the left</p>
|
|
357
718
|
|
|
@@ -360,7 +721,8 @@
|
|
|
360
721
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_column</span>(<span class="ruby-value">1</span>)
|
|
361
722
|
</pre>
|
|
362
723
|
|
|
363
|
-
<
|
|
724
|
+
<span id="label-Delete+Row" class="legacy-anchor"></span>
|
|
725
|
+
<h4 id="delete-row"><a href="#delete-row">Delete Row</a></h4>
|
|
364
726
|
|
|
365
727
|
<p>This method will delete a row at specified index, pushing all rows below it up.</p>
|
|
366
728
|
|
|
@@ -369,7 +731,8 @@
|
|
|
369
731
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_row</span>(<span class="ruby-value">1</span>)
|
|
370
732
|
</pre>
|
|
371
733
|
|
|
372
|
-
<
|
|
734
|
+
<span id="label-Delete+Column" class="legacy-anchor"></span>
|
|
735
|
+
<h4 id="delete-column"><a href="#delete-column">Delete Column</a></h4>
|
|
373
736
|
|
|
374
737
|
<p>This method will delete a column at specified index, pushing all columns to the right of it left.</p>
|
|
375
738
|
|
|
@@ -378,7 +741,8 @@
|
|
|
378
741
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_column</span>(<span class="ruby-value">1</span>)
|
|
379
742
|
</pre>
|
|
380
743
|
|
|
381
|
-
<
|
|
744
|
+
<span id="label-Insert+Cell" class="legacy-anchor"></span>
|
|
745
|
+
<h4 id="insert-cell"><a href="#insert-cell">Insert Cell</a></h4>
|
|
382
746
|
|
|
383
747
|
<p>This method will insert a cell at specified position. It takes a :right or :down option, to shift cells either left or down upon inserting (nil means replacing the cell)</p>
|
|
384
748
|
|
|
@@ -389,7 +753,8 @@
|
|
|
389
753
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">insert_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>, <span class="ruby-string">"blah"</span>) <span class="ruby-comment"># Inserts cell at A1, shifts nothing</span>
|
|
390
754
|
</pre>
|
|
391
755
|
|
|
392
|
-
<
|
|
756
|
+
<span id="label-Delete+Cell" class="legacy-anchor"></span>
|
|
757
|
+
<h4 id="delete-cell"><a href="#delete-cell">Delete Cell</a></h4>
|
|
393
758
|
|
|
394
759
|
<p>This method will delete a cell at specified position. It takes a :left or :up option, to shift cells either up or left upon deletion (nil means simply deleting the cell contents)</p>
|
|
395
760
|
|
|
@@ -400,7 +765,8 @@
|
|
|
400
765
|
<span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">delete_cell</span>(<span class="ruby-value">0</span>, <span class="ruby-value">0</span>) <span class="ruby-comment"># Deletes A1, does not shift cells</span>
|
|
401
766
|
</pre>
|
|
402
767
|
|
|
403
|
-
<
|
|
768
|
+
<span id="label-Modifying+Cell+Format" class="legacy-anchor"></span>
|
|
769
|
+
<h4 id="modifying-cell-format"><a href="#modifying-cell-format">Modifying Cell Format</a></h4>
|
|
404
770
|
|
|
405
771
|
<pre class="ruby"><span class="ruby-identifier">cell</span> = <span class="ruby-identifier">worksheet</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>]
|
|
406
772
|
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">set_number_format</span> <span class="ruby-string">'0.0000%'</span> <span class="ruby-comment"># For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68</span>
|
|
@@ -409,13 +775,15 @@
|
|
|
409
775
|
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">change_text_indent</span>(<span class="ruby-value">1</span>) <span class="ruby-comment"># Indents the text in the cell by 1 level</span>
|
|
410
776
|
</pre>
|
|
411
777
|
|
|
412
|
-
<
|
|
778
|
+
<span id="label-Add+hyperlink+to+a+Cell" class="legacy-anchor"></span>
|
|
779
|
+
<h4 id="add-hyperlink-to-a-cell"><a href="#add-hyperlink-to-a-cell">Add hyperlink to a Cell</a></h4>
|
|
413
780
|
|
|
414
781
|
<pre class="ruby"><span class="ruby-identifier">cell</span>.<span class="ruby-identifier">add_hyperlink</span>(<span class="ruby-string">'http://example.com'</span>)
|
|
415
782
|
<span class="ruby-identifier">cell</span>.<span class="ruby-identifier">add_hyperlink</span>(<span class="ruby-string">'http://example.com'</span>, <span class="ruby-string">'Some tooltip text'</span>)
|
|
416
783
|
</pre>
|
|
417
784
|
|
|
418
|
-
<
|
|
785
|
+
<span id="label-I-2FO" class="legacy-anchor"></span>
|
|
786
|
+
<h2 id="io"><a href="#io">I/O</a></h2>
|
|
419
787
|
|
|
420
788
|
<p>By default, the gem operates with files on the local filesystem:</p>
|
|
421
789
|
|
|
@@ -429,27 +797,32 @@
|
|
|
429
797
|
<span class="ruby-identifier">workbook</span>.<span class="ruby-identifier">stream</span>
|
|
430
798
|
</pre>
|
|
431
799
|
|
|
432
|
-
<
|
|
800
|
+
<span id="label-Miscellaneous" class="legacy-anchor"></span>
|
|
801
|
+
<h2 id="miscellaneous"><a href="#miscellaneous">Miscellaneous</a></h2>
|
|
433
802
|
|
|
434
803
|
<pre class="ruby"><span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Reference</span>.<span class="ruby-identifier">ind2ref</span>(<span class="ruby-value">0</span>,<span class="ruby-value">0</span>) <span class="ruby-operator">==</span> <span class="ruby-string">'A1'</span> <span class="ruby-comment"># Converts row and column index to Excel-style cell reference</span>
|
|
435
804
|
<span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">Reference</span>.<span class="ruby-identifier">ref2ind</span>(<span class="ruby-string">'A1'</span>) <span class="ruby-operator">==</span> [<span class="ruby-value">0</span>, <span class="ruby-value">0</span>] <span class="ruby-comment"># Converts Excel-style cell reference to row and column index</span>
|
|
436
805
|
</pre>
|
|
437
806
|
|
|
438
|
-
<
|
|
807
|
+
<span id="label-Suppress+warnings+about+malformed+input+files" class="legacy-anchor"></span>
|
|
808
|
+
<h3 id="suppress-warnings-about-malformed-input-files"><a href="#suppress-warnings-about-malformed-input-files">Suppress warnings about malformed input files</a></h3>
|
|
439
809
|
|
|
440
810
|
<pre class="ruby"><span class="ruby-constant">RubyXL</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@suppress_warnings</span>, <span class="ruby-keyword">true</span>)
|
|
441
811
|
</pre>
|
|
442
812
|
|
|
443
|
-
<
|
|
813
|
+
<span id="label-Data+validation+-28colloquially+referred+to+as+-22dropdown+list-22-29" class="legacy-anchor"></span>
|
|
814
|
+
<h2 id="data-validation-colloquially-referred-to-as-dropdown-list"><a href="#data-validation-colloquially-referred-to-as-dropdown-list">Data validation (colloquially referred to as “dropdown list”)</a></h2>
|
|
444
815
|
|
|
445
816
|
<pre class="ruby"><span class="ruby-identifier">worksheet</span>.<span class="ruby-identifier">add_validation_list</span>(<span class="ruby-string">"A1"</span>, [ <span class="ruby-string">"value1"</span>, <span class="ruby-string">"value2"</span> ])
|
|
446
817
|
</pre>
|
|
447
818
|
|
|
448
|
-
<
|
|
819
|
+
<span id="label-For+more+information" class="legacy-anchor"></span>
|
|
820
|
+
<h2 id="for-more-information"><a href="#for-more-information">For more information</a></h2>
|
|
449
821
|
|
|
450
822
|
<p>Take a look at the files in spec/lib/ for rspecs on most methods</p>
|
|
451
823
|
|
|
452
|
-
<
|
|
824
|
+
<span id="label-Contributing+to+rubyXL" class="legacy-anchor"></span>
|
|
825
|
+
<h2 id="contributing-to-rubyxl"><a href="#contributing-to-rubyxl">Contributing to rubyXL</a></h2>
|
|
453
826
|
<ul><li>
|
|
454
827
|
<p>Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet</p>
|
|
455
828
|
</li><li>
|
|
@@ -466,17 +839,33 @@
|
|
|
466
839
|
<p>Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.</p>
|
|
467
840
|
</li></ul>
|
|
468
841
|
|
|
469
|
-
<
|
|
842
|
+
<span id="label-Copyright" class="legacy-anchor"></span>
|
|
843
|
+
<h2 id="copyright"><a href="#copyright">Copyright</a></h2>
|
|
470
844
|
|
|
471
|
-
<p>Copyright © 2011 Vivek Bhagwat, 2013-
|
|
845
|
+
<p>Copyright © 2011 Vivek Bhagwat, 2013-2026 Wesha. See LICENSE.txt for further details.</p>
|
|
472
846
|
|
|
473
847
|
</main>
|
|
474
848
|
|
|
849
|
+
<aside class="table-of-contents" role="complementary" aria-label="Table of Contents">
|
|
850
|
+
<div class="toc-sticky">
|
|
851
|
+
<h3 class="toc-heading">On This Page</h3>
|
|
852
|
+
<nav class="toc-nav" id="toc-nav" aria-label="Page sections">
|
|
853
|
+
<!-- Generated by JavaScript based on page headings -->
|
|
854
|
+
</nav>
|
|
855
|
+
</div>
|
|
856
|
+
</aside>
|
|
475
857
|
|
|
476
858
|
|
|
477
|
-
<footer
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
<
|
|
859
|
+
<footer class="site-footer">
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<div class="footer-bottom">
|
|
863
|
+
<p>
|
|
864
|
+
Generated by <a href="https://ruby.github.io/rdoc/">RDoc 7.2.0</a>
|
|
865
|
+
using the Aliki theme by <a href="http://st0012.dev">Stan Lo</a>
|
|
866
|
+
</p>
|
|
867
|
+
</div>
|
|
481
868
|
</footer>
|
|
482
869
|
|
|
870
|
+
</body>
|
|
871
|
+
|